- 1.63.0 (latest)
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
API documentation for aiplatform_v1beta1.types
package.
Classes
AcceleratorType
Represents a hardware accelerator type.
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.
AuthConfig
Auth configuration to run the extension.
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
AuthType
Type of Auth.
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.v1beta1.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.
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
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.
BleuInput
Input for bleu metric.
BleuInstance
Spec for bleu instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BleuMetricValue
Bleu metric value for an instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BleuResults
Results for bleu metric.
BleuSpec
Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1.
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:
BoolArray
A list of boolean values.
CachedContent
A resource used in LLM queries for users to explicitly specify what to cache and how to cache.
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
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
ChatCompletionsRequest
Request message for [PredictionService.ChatCompletions]
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.
CoherenceInput
Input for coherence metric.
CoherenceInstance
Spec for coherence instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CoherenceResult
Spec for coherence result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CoherenceSpec
Spec for coherence score metric.
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.
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
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.
CreateCachedContentRequest
Request message for GenAiCacheService.CreateCachedContent.
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.
CreateModelMonitorOperationMetadata
Runtime operation information for ModelMonitoringService.CreateModelMonitor.
CreateModelMonitorRequest
Request message for ModelMonitoringService.CreateModelMonitor.
CreateModelMonitoringJobRequest
Request message for ModelMonitoringService.CreateModelMonitoringJob.
CreateNasJobRequest
Request message for JobService.CreateNasJob.
CreateNotebookExecutionJobOperationMetadata
Metadata information for NotebookService.CreateNotebookExecutionJob.
CreateNotebookExecutionJobRequest
Request message for [NotebookService.CreateNotebookExecutionJob]
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.
CreateRagCorpusOperationMetadata
Runtime operation information for VertexRagDataService.CreateRagCorpus.
CreateRagCorpusRequest
Request message for VertexRagDataService.CreateRagCorpus.
CreateReasoningEngineOperationMetadata
Details of ReasoningEngineService.CreateReasoningEngine operation.
CreateReasoningEngineRequest
Request message for ReasoningEngineService.CreateReasoningEngine.
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.
DeleteCachedContentRequest
Request message for GenAiCacheService.DeleteCachedContent.
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.
DeleteExtensionRequest
Request message for ExtensionRegistryService.DeleteExtension.
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.
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
DeleteFeatureValuesResponse
Response message for FeaturestoreService.DeleteFeatureValues.
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
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.
DeleteModelMonitorRequest
Request message for ModelMonitoringService.DeleteModelMonitor.
DeleteModelMonitoringJobRequest
Request message for ModelMonitoringService.DeleteModelMonitoringJob.
DeleteModelRequest
Request message for ModelService.DeleteModel.
DeleteModelVersionRequest
Request message for ModelService.DeleteModelVersion.
DeleteNasJobRequest
Request message for JobService.DeleteNasJob.
DeleteNotebookExecutionJobRequest
Request message for [NotebookService.DeleteNotebookExecutionJob]
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.
DeleteRagCorpusRequest
Request message for VertexRagDataService.DeleteRagCorpus.
DeleteRagFileRequest
Request message for VertexRagDataService.DeleteRagFile.
DeleteReasoningEngineRequest
Request message for ReasoningEngineService.DeleteReasoningEngine.
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.
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
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.
DirectUploadSource
The input content is encapsulated and uploaded in the request.
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.
EvaluateInstancesRequest
Request message for EvaluationService.EvaluateInstances.
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
EvaluateInstancesResponse
Response message for EvaluationService.EvaluateInstances.
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
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.
ExactMatchInput
Input for exact match metric.
ExactMatchInstance
Spec for exact match instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ExactMatchMetricValue
Exact match metric value for an instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ExactMatchResults
Results for exact match metric.
ExactMatchSpec
Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0.
Examples
Example-based explainability that returns the nearest neighbors from the provided dataset.
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
ExamplesOverride
Overrides for example-based explanations.
ExamplesRestrictionsNamespace
Restrictions namespace for example-based explanations overrides.
ExecuteExtensionRequest
Request message for ExtensionExecutionService.ExecuteExtension.
ExecuteExtensionResponse
Response message for ExtensionExecutionService.ExecuteExtension.
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.v1beta1.PredictionService.Explain] time.
ExplanationParameters
Parameters to configure explaining for Model's predictions.
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
ExplanationSpec
Specification of Model explanation.
ExplanationSpecOverride
The ExplanationSpec entries that can be overridden at [online explanation][google.cloud.aiplatform.v1beta1.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.
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
ExportFeatureValuesResponse
Response message for FeaturestoreService.ExportFeatureValues.
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.
Extension
Extensions are tools for large language models to access external data, run computations, etc.
ExtensionManifest
Manifest spec of an Extension needed for runtime execution.
ExtensionOperation
Operation of an extension.
ExtensionPrivateServiceConnectConfig
PrivateExtensionConfig configuration for the extension.
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.
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
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.
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
FeatureValueDestination
A destination location for Feature values and format.
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
FeatureValueList
Container for list of values.
FeatureView
FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.
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
FeatureViewDataFormat
Format of the data in the Feature View.
FeatureViewDataKey
Lookup key for a feature view.
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
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FetchFeatureValuesResponse
Response message for FeatureOnlineStoreService.FetchFeatureValues
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
FileData
URI based data.
FilterSplit
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.
FindNeighborsRequest
The request message for MatchService.FindNeighbors.
FindNeighborsResponse
The response message for MatchService.FindNeighbors.
FluencyInput
Input for fluency metric.
FluencyInstance
Spec for fluency instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FluencyResult
Spec for fluency result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FluencySpec
Spec for fluency score metric.
FractionSplit
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.
FulfillmentInput
Input for fulfillment metric.
FulfillmentInstance
Spec for fulfillment instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FulfillmentResult
Spec for fulfillment result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FulfillmentSpec
Spec for fulfillment metric.
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.
FunctionCallingConfig
Function calling config.
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.
GetCachedContentRequest
Request message for GenAiCacheService.GetCachedContent.
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.
GetExtensionRequest
Request message for ExtensionRegistryService.GetExtension.
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.
GetModelMonitorRequest
Request message for ModelMonitoringService.GetModelMonitor.
GetModelMonitoringJobRequest
Request message for ModelMonitoringService.GetModelMonitoringJob.
GetModelRequest
Request message for ModelService.GetModel.
GetNasJobRequest
Request message for JobService.GetNasJob.
GetNasTrialDetailRequest
Request message for JobService.GetNasTrialDetail.
GetNotebookExecutionJobRequest
Request message for [NotebookService.GetNotebookExecutionJob]
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
GetRagCorpusRequest
Request message for VertexRagDataService.GetRagCorpus
GetRagFileRequest
Request message for VertexRagDataService.GetRagFile
GetReasoningEngineRequest
Request message for ReasoningEngineService.GetReasoningEngine.
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.
GoogleDriveSource
The Google Drive location for the input content.
GoogleSearchRetrieval
Tool to retrieve public web data for grounding, powered by Google.
GroundednessInput
Input for groundedness metric.
GroundednessInstance
Spec for groundedness instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GroundednessResult
Spec for groundedness result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GroundednessSpec
Spec for groundedness metric.
GroundingAttribution
Grounding attribution.
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
GroundingChunk
Grounding chunk.
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
GroundingMetadata
Metadata returned to client when grounding is enabled.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GroundingSupport
Grounding support.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
HarmCategory
Harm categories that will block the content.
HttpElementLocation
Enum of location an HTTP element can be.
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.
ImportExtensionOperationMetadata
Details of ExtensionRegistryService.ImportExtension operation.
ImportExtensionRequest
Request message for ExtensionRegistryService.ImportExtension.
ImportFeatureValuesOperationMetadata
Details of operations that perform import Feature values.
ImportFeatureValuesRequest
Request message for FeaturestoreService.ImportFeatureValues.
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
ImportFeatureValuesResponse
Response message for FeaturestoreService.ImportFeatureValues.
ImportModelEvaluationRequest
Request message for ModelService.ImportModelEvaluation
ImportRagFilesConfig
Config for importing RagFiles.
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
ImportRagFilesOperationMetadata
Runtime operation information for VertexRagDataService.ImportRagFiles.
ImportRagFilesRequest
Request message for VertexRagDataService.ImportRagFiles.
ImportRagFilesResponse
Response message for VertexRagDataService.ImportRagFiles.
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.
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
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.
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
ListCachedContentsRequest
Request to list CachedContents.
ListCachedContentsResponse
Response with a list of CachedContents.
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.
ListExtensionsRequest
Request message for ExtensionRegistryService.ListExtensions.
ListExtensionsResponse
Response message for ExtensionRegistryService.ListExtensions
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.
ListModelMonitoringJobsRequest
Request message for ModelMonitoringService.ListModelMonitoringJobs.
ListModelMonitoringJobsResponse
Response message for ModelMonitoringService.ListModelMonitoringJobs.
ListModelMonitorsRequest
Request message for ModelMonitoringService.ListModelMonitors.
ListModelMonitorsResponse
Response message for ModelMonitoringService.ListModelMonitors
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
ListNotebookExecutionJobsRequest
Request message for [NotebookService.ListNotebookExecutionJobs]
ListNotebookExecutionJobsResponse
Response message for [NotebookService.CreateNotebookExecutionJob]
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
ListPublisherModelsRequest
Request message for ModelGardenService.ListPublisherModels.
ListPublisherModelsResponse
Response message for ModelGardenService.ListPublisherModels.
ListRagCorporaRequest
Request message for VertexRagDataService.ListRagCorpora.
ListRagCorporaResponse
Response message for VertexRagDataService.ListRagCorpora.
ListRagFilesRequest
Request message for VertexRagDataService.ListRagFiles.
ListRagFilesResponse
Response message for VertexRagDataService.ListRagFiles.
ListReasoningEnginesRequest
Request message for ReasoningEngineService.ListReasoningEngines.
ListReasoningEnginesResponse
Response message for ReasoningEngineService.ListReasoningEngines
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.
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
MigrateResourceRequest
Config of migrating one resource from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.
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
MigrateResourceResponse
Describes a successfully migrated resource.
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
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.
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.
ModelMonitor
Vertex AI Model Monitoring Service serves as a central hub for the analysis and visualization of data quality and performance related to models. ModelMonitor stands as a top level resource for overseeing your model monitoring tasks.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ModelMonitoringAlert
Represents a single monitoring alert. This is currently used in the SearchModelMonitoringAlerts api, thus the alert wrapped in this message belongs to the resource asked in the request.
ModelMonitoringAlertCondition
Monitoring alert triggered condition.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ModelMonitoringAlertConfig
The alert config for model monitoring.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ModelMonitoringAnomaly
Represents a single model monitoring anomaly.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ModelMonitoringConfig
The model monitoring configuration used for Batch Prediction Job.
ModelMonitoringInput
Model monitoring data input spec.
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
ModelMonitoringJob
Represents a model monitoring job that analyze dataset using different monitoring algorithm.
ModelMonitoringJobExecutionDetail
Represent the execution details of the job.
ModelMonitoringNotificationSpec
Notification spec(email, notification channel) for model monitoring statistics/alerts.
ModelMonitoringObjectiveConfig
The objective configuration for model monitoring, including the information needed to detect anomalies for one particular model.
ModelMonitoringObjectiveSpec
Monitoring objectives spec.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ModelMonitoringOutputSpec
Specification for the export destination of monitoring results, including metrics, logs, etc.
ModelMonitoringSchema
The Model Monitoring Schema definition.
ModelMonitoringSpec
Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports.
ModelMonitoringStats
Represents the collection of statistics for a metric.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ModelMonitoringStatsAnomalies
Statistics and anomalies generated by Model Monitoring.
ModelMonitoringStatsDataPoint
Represents a single statistics data point.
ModelMonitoringTabularStats
A collection of data points that describes the time-varying values of a tabular metric.
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.
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
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.
NotebookExecutionJob
NotebookExecutionJob represents an instance of a notebook execution.
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
NotebookExecutionJobView
Views for Get/List NotebookExecutionJob
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.
PairwiseChoice
Pairwise prediction autorater preference.
PairwiseQuestionAnsweringQualityInput
Input for pairwise question answering quality metric.
PairwiseQuestionAnsweringQualityInstance
Spec for pairwise question answering quality instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PairwiseQuestionAnsweringQualityResult
Spec for pairwise question answering quality result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PairwiseQuestionAnsweringQualitySpec
Spec for pairwise question answering quality score metric.
PairwiseSummarizationQualityInput
Input for pairwise summarization quality metric.
PairwiseSummarizationQualityInstance
Spec for pairwise summarization quality instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PairwiseSummarizationQualityResult
Spec for pairwise summarization quality result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PairwiseSummarizationQualitySpec
Spec for pairwise summarization quality score metric.
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.
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
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.
PipelineJob
An instance of a machine learning PipelineJob.
PipelineJobDetail
The runtime detail of PipelineJob.
PipelineState
Describes the state of a pipeline.
PipelineTaskDetail
The runtime detail of a task execution.
PipelineTaskExecutorDetail
The runtime detail of a pipeline executor.
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
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.
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.
QueryExtensionRequest
Request message for ExtensionExecutionService.QueryExtension.
QueryExtensionResponse
Response message for ExtensionExecutionService.QueryExtension.
QueryReasoningEngineRequest
Request message for [ReasoningEngineExecutionService.Query][].
QueryReasoningEngineResponse
Response message for [ReasoningEngineExecutionService.Query][]
QuestionAnsweringCorrectnessInput
Input for question answering correctness metric.
QuestionAnsweringCorrectnessInstance
Spec for question answering correctness instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
QuestionAnsweringCorrectnessResult
Spec for question answering correctness result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
QuestionAnsweringCorrectnessSpec
Spec for question answering correctness metric.
QuestionAnsweringHelpfulnessInput
Input for question answering helpfulness metric.
QuestionAnsweringHelpfulnessInstance
Spec for question answering helpfulness instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
QuestionAnsweringHelpfulnessResult
Spec for question answering helpfulness result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
QuestionAnsweringHelpfulnessSpec
Spec for question answering helpfulness metric.
QuestionAnsweringQualityInput
Input for question answering quality metric.
QuestionAnsweringQualityInstance
Spec for question answering quality instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
QuestionAnsweringQualityResult
Spec for question answering quality result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
QuestionAnsweringQualitySpec
Spec for question answering quality score metric.
QuestionAnsweringRelevanceInput
Input for question answering relevance metric.
QuestionAnsweringRelevanceInstance
Spec for question answering relevance instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
QuestionAnsweringRelevanceResult
Spec for question answering relevance result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
QuestionAnsweringRelevanceSpec
Spec for question answering relevance metric.
RagContexts
Relevant contexts for one query.
RagCorpus
A RagCorpus is a RagFile container and a project can have multiple RagCorpora.
RagEmbeddingModelConfig
Config for the embedding model to use for RAG.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RagFile
A RagFile contains user data for chunking, embedding and indexing.
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
RagFileChunkingConfig
Specifies the size and overlap of chunks for RagFiles.
RagQuery
A query to retrieve relevant contexts.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RawPredictRequest
Request message for PredictionService.RawPredict.
RayMetricSpec
Configuration for the Ray metrics.
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.
ReasoningEngine
ReasoningEngine provides a customizable runtime for models to determine which actions to take and in which order.
ReasoningEngineSpec
ReasoningEngine configurations
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.
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
RetrieveContextsRequest
Request message for VertexRagService.RetrieveContexts.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RetrieveContextsResponse
Response message for VertexRagService.RetrieveContexts.
RougeInput
Input for rouge metric.
RougeInstance
Spec for rouge instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RougeMetricValue
Rouge metric value for an instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RougeResults
Results for rouge metric.
RougeSpec
Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1.
RuntimeConfig
Runtime configuration to run the extension.
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
SafetyInput
Input for safety metric.
SafetyInstance
Spec for safety instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SafetyRating
Safety rating corresponding to the generated content.
SafetyResult
Spec for safety result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SafetySetting
Safety settings.
SafetySpec
Spec for safety metric.
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.
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
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.
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
SearchDataItemsResponse
Response message for DatasetService.SearchDataItems.
SearchEntryPoint
Google search entry point.
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.
SearchModelMonitoringAlertsRequest
Request message for ModelMonitoringService.SearchModelMonitoringAlerts.
SearchModelMonitoringAlertsResponse
Response message for ModelMonitoringService.SearchModelMonitoringAlerts.
SearchModelMonitoringStatsFilter
Filter for searching ModelMonitoringStats.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SearchModelMonitoringStatsRequest
Request message for ModelMonitoringService.SearchModelMonitoringStats.
SearchModelMonitoringStatsResponse
Response message for ModelMonitoringService.SearchModelMonitoringStats.
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
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
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.
StreamingFetchFeatureValuesRequest
Request message for FeatureOnlineStoreService.StreamingFetchFeatureValues. For the entities requested, all features under the requested feature view will be returned.
StreamingFetchFeatureValuesResponse
Response message for FeatureOnlineStoreService.StreamingFetchFeatureValues.
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.
StructFieldValue
One field of a Struct (or object) type feature value.
StructValue
Struct (or object) type feature value.
Study
A message representing a Study.
StudySpec
Represents specification of a Study.
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
StudyTimeConstraint
Time-based Constraint for Study
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
SuggestTrialsMetadata
Details of operations that perform Trials suggestion.
SuggestTrialsRequest
Request message for VizierService.SuggestTrials.
SuggestTrialsResponse
Response message for VizierService.SuggestTrials.
SummarizationHelpfulnessInput
Input for summarization helpfulness metric.
SummarizationHelpfulnessInstance
Spec for summarization helpfulness instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SummarizationHelpfulnessResult
Spec for summarization helpfulness result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SummarizationHelpfulnessSpec
Spec for summarization helpfulness score metric.
SummarizationQualityInput
Input for summarization quality metric.
SummarizationQualityInstance
Spec for summarization quality instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SummarizationQualityResult
Spec for summarization quality result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SummarizationQualitySpec
Spec for summarization quality score metric.
SummarizationVerbosityInput
Input for summarization verbosity metric.
SummarizationVerbosityInstance
Spec for summarization verbosity instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SummarizationVerbosityResult
Spec for summarization verbosity result.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SummarizationVerbositySpec
Spec for summarization verbosity score metric.
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.
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
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).
ToolCallValidInput
Input for tool call valid metric.
ToolCallValidInstance
Spec for tool call valid instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ToolCallValidMetricValue
Tool call valid metric value for an instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ToolCallValidResults
Results for tool call valid metric.
ToolCallValidSpec
Spec for tool call valid metric.
ToolConfig
Tool config. This config is shared for all tools provided in the request.
ToolNameMatchInput
Input for tool name match metric.
ToolNameMatchInstance
Spec for tool name match instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ToolNameMatchMetricValue
Tool name match metric value for an instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ToolNameMatchResults
Results for tool name match metric.
ToolNameMatchSpec
Spec for tool name match metric.
ToolParameterKVMatchInput
Input for tool parameter key value match metric.
ToolParameterKVMatchInstance
Spec for tool parameter key value match instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ToolParameterKVMatchMetricValue
Tool parameter key value match metric value for an instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ToolParameterKVMatchResults
Results for tool parameter key value match metric.
ToolParameterKVMatchSpec
Spec for tool parameter key value match metric.
ToolParameterKeyMatchInput
Input for tool parameter key match metric.
ToolParameterKeyMatchInstance
Spec for tool parameter key match instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ToolParameterKeyMatchMetricValue
Tool parameter key match metric value for an instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ToolParameterKeyMatchResults
Results for tool parameter key match metric.
ToolParameterKeyMatchSpec
Spec for tool parameter key match metric.
ToolUseExample
A single example of the tool usage.
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
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/
UndeployIndexOperationMetadata
Runtime operation information for IndexEndpointService.UndeployIndex.
UndeployIndexRequest
Request message for IndexEndpointService.UndeployIndex.
UndeployIndexResponse
Response message for IndexEndpointService.UndeployIndex.
UndeployModelOperationMetadata
Runtime operation information for EndpointService.UndeployModel.
UndeployModelRequest
Request message for EndpointService.UndeployModel.
UndeployModelResponse
Response message for EndpointService.UndeployModel.
UnmanagedContainerModel
Contains model information necessary to perform batch prediction without requiring a full model import.
UpdateArtifactRequest
Request message for MetadataService.UpdateArtifact.
UpdateCachedContentRequest
Request message for GenAiCacheService.UpdateCachedContent. Only expire_time or ttl can be updated.
UpdateContextRequest
Request message for MetadataService.UpdateContext.
UpdateDatasetRequest
Request message for DatasetService.UpdateDataset.
UpdateDatasetVersionRequest
Request message for DatasetService.UpdateDatasetVersion.
UpdateDeploymentResourcePoolOperationMetadata
Runtime operation information for UpdateDeploymentResourcePool method.
UpdateDeploymentResourcePoolRequest
Request message for UpdateDeploymentResourcePool method.
UpdateEndpointRequest
Request message for EndpointService.UpdateEndpoint.
UpdateEntityTypeRequest
Request message for FeaturestoreService.UpdateEntityType.
UpdateExecutionRequest
Request message for MetadataService.UpdateExecution.
UpdateExplanationDatasetOperationMetadata
Runtime operation information for ModelService.UpdateExplanationDataset.
UpdateExplanationDatasetRequest
Request message for ModelService.UpdateExplanationDataset.
UpdateExplanationDatasetResponse
Response message of ModelService.UpdateExplanationDataset operation.
UpdateExtensionRequest
Request message for ExtensionRegistryService.UpdateExtension.
UpdateFeatureGroupOperationMetadata
Details of operations that perform update FeatureGroup.
UpdateFeatureGroupRequest
Request message for FeatureRegistryService.UpdateFeatureGroup.
UpdateFeatureOnlineStoreOperationMetadata
Details of operations that perform update FeatureOnlineStore.
UpdateFeatureOnlineStoreRequest
Request message for FeatureOnlineStoreAdminService.UpdateFeatureOnlineStore.
UpdateFeatureOperationMetadata
Details of operations that perform update Feature.
UpdateFeatureRequest
Request message for FeaturestoreService.UpdateFeature. Request message for FeatureRegistryService.UpdateFeature.
UpdateFeatureViewOperationMetadata
Details of operations that perform update FeatureView.
UpdateFeatureViewRequest
Request message for FeatureOnlineStoreAdminService.UpdateFeatureView.
UpdateFeaturestoreOperationMetadata
Details of operations that perform update Featurestore.
UpdateFeaturestoreRequest
Request message for FeaturestoreService.UpdateFeaturestore.
UpdateIndexEndpointRequest
Request message for IndexEndpointService.UpdateIndexEndpoint.
UpdateIndexOperationMetadata
Runtime operation information for IndexService.UpdateIndex.
UpdateIndexRequest
Request message for IndexService.UpdateIndex.
UpdateModelDeploymentMonitoringJobOperationMetadata
Runtime operation information for JobService.UpdateModelDeploymentMonitoringJob.
UpdateModelDeploymentMonitoringJobRequest
Request message for JobService.UpdateModelDeploymentMonitoringJob.
UpdateModelMonitorOperationMetadata
Runtime operation information for ModelMonitoringService.UpdateModelMonitor.
UpdateModelMonitorRequest
Request message for ModelMonitoringService.UpdateModelMonitor.
UpdateModelRequest
Request message for ModelService.UpdateModel.
UpdateNotebookRuntimeTemplateRequest
Request message for NotebookService.UpdateNotebookRuntimeTemplate.
UpdatePersistentResourceOperationMetadata
Details of operations that perform update PersistentResource.
UpdatePersistentResourceRequest
Request message for UpdatePersistentResource method.
UpdateReasoningEngineOperationMetadata
Details of ReasoningEngineService.UpdateReasoningEngine operation.
UpdateReasoningEngineRequest
Request message for ReasoningEngineService.UpdateReasoningEngine.
UpdateScheduleRequest
Request message for ScheduleService.UpdateSchedule.
UpdateSpecialistPoolOperationMetadata
Runtime operation metadata for SpecialistPoolService.UpdateSpecialistPool.
UpdateSpecialistPoolRequest
Request message for SpecialistPoolService.UpdateSpecialistPool.
UpdateTensorboardExperimentRequest
Request message for TensorboardService.UpdateTensorboardExperiment.
UpdateTensorboardOperationMetadata
Details of operations that perform update Tensorboard.
UpdateTensorboardRequest
Request message for TensorboardService.UpdateTensorboard.
UpdateTensorboardRunRequest
Request message for TensorboardService.UpdateTensorboardRun.
UpdateTensorboardTimeSeriesRequest
Request message for TensorboardService.UpdateTensorboardTimeSeries.
UpgradeNotebookRuntimeOperationMetadata
Metadata information for NotebookService.UpgradeNotebookRuntime.
UpgradeNotebookRuntimeRequest
Request message for NotebookService.UpgradeNotebookRuntime.
UpgradeNotebookRuntimeResponse
Response message for NotebookService.UpgradeNotebookRuntime.
UploadModelOperationMetadata
Details of ModelService.UploadModel operation.
UploadModelRequest
Request message for ModelService.UploadModel.
UploadModelResponse
Response message of ModelService.UploadModel operation.
UploadRagFileConfig
Config for uploading RagFile.
UploadRagFileRequest
Request message for VertexRagDataService.UploadRagFile.
UploadRagFileResponse
Response message for VertexRagDataService.UploadRagFile.
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
UpsertDatapointsRequest
Request message for IndexService.UpsertDatapoints
UpsertDatapointsResponse
Response message for IndexService.UpsertDatapoints
UserActionReference
References an API call. It contains more information about long running operation and Jobs that are triggered by the API call.
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
Value
Value is the value of the field.
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
VertexAISearch
Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation
VertexRagStore
Retrieve from Vertex RAG Store for grounding.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
VideoMetadata
Metadata describes the input video content.
WorkerPoolSpec
Represents the spec of a worker pool in a job.
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
WriteFeatureValuesPayload
Contains Feature values to be written for a specific entity.
WriteFeatureValuesRequest
Request message for FeaturestoreOnlineServingService.WriteFeatureValues.
WriteFeatureValuesResponse
Response message for FeaturestoreOnlineServingService.WriteFeatureValues.
WriteTensorboardExperimentDataRequest
Request message for TensorboardService.WriteTensorboardExperimentData.
WriteTensorboardExperimentDataResponse
Response message for TensorboardService.WriteTensorboardExperimentData.
WriteTensorboardRunDataRequest
Request message for TensorboardService.WriteTensorboardRunData.
WriteTensorboardRunDataResponse
Response message for TensorboardService.WriteTensorboardRunData.
XraiAttribution
An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details:
https://arxiv.org/abs/1906.02825
Supported only by image Models.