Train high-quality custom machine learning models with minimal machine learning expertise and effort.
Service: aiplatform.googleapis.com
The Service name aiplatform.googleapis.com is needed to create RPC client stubs.
google.cloud.aiplatform.v1.DatasetService
        | Methods | |
|---|---|
                   | 
                Creates a Dataset. | 
                   | 
                Create a version from a Dataset. | 
                   | 
                Deletes a Dataset. | 
                   | 
                Deletes a Dataset version. | 
                   | 
                Deletes a SavedQuery. | 
                   | 
                Exports data from a Dataset. | 
                   | 
                Gets an AnnotationSpec. | 
                   | 
                Gets a Dataset. | 
                   | 
                Gets a Dataset version. | 
                   | 
                Imports data into a Dataset. | 
                   | 
                Lists Annotations belongs to a dataitem. | 
                   | 
                Lists DataItems in a Dataset. | 
                   | 
                Lists DatasetVersions in a Dataset. | 
                   | 
                Lists Datasets in a Location. | 
                   | 
                Lists SavedQueries in a Dataset. | 
                   | 
                Restores a dataset version. | 
                   | 
                Searches DataItems in a Dataset. | 
                   | 
                Updates a Dataset. | 
                   | 
                Updates a DatasetVersion. | 
google.cloud.aiplatform.v1.DeploymentResourcePoolService
        | Methods | |
|---|---|
                   | 
                Create a DeploymentResourcePool. | 
                   | 
                Delete a DeploymentResourcePool. | 
                   | 
                Get a DeploymentResourcePool. | 
                   | 
                List DeploymentResourcePools in a location. | 
                   | 
                List DeployedModels that have been deployed on this DeploymentResourcePool. | 
                   | 
                Update a DeploymentResourcePool. | 
google.cloud.aiplatform.v1.EndpointService
        | Methods | |
|---|---|
                   | 
                Creates an Endpoint. | 
                   | 
                Deletes an Endpoint. | 
                   | 
                Deploys a Model into this Endpoint, creating a DeployedModel within it. | 
                   | 
                Gets an Endpoint. | 
                   | 
                Lists Endpoints in a Location. | 
                   | 
                Updates an existing deployed model. | 
                   | 
                Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. | 
                   | 
                Updates an Endpoint. | 
                   | 
                Updates an Endpoint with a long running operation. | 
google.cloud.aiplatform.v1.EvaluationService
        | Methods | |
|---|---|
                   | 
                Evaluates instances based on a given metric. | 
google.cloud.aiplatform.v1.FeatureOnlineStoreAdminService
        | Methods | |
|---|---|
                   | 
                Creates a new FeatureOnlineStore in a given project and location. | 
                   | 
                Creates a new FeatureView in a given FeatureOnlineStore. | 
                   | 
                Deletes a single FeatureOnlineStore. | 
                   | 
                Deletes a single FeatureView. | 
                   | 
                Gets details of a single FeatureOnlineStore. | 
                   | 
                Gets details of a single FeatureView. | 
                   | 
                Gets details of a single FeatureViewSync. | 
                   | 
                Lists FeatureOnlineStores in a given project and location. | 
                   | 
                Lists FeatureViewSyncs in a given FeatureView. | 
                   | 
                Lists FeatureViews in a given FeatureOnlineStore. | 
                   | 
                Triggers on-demand sync for the FeatureView. | 
                   | 
                Updates the parameters of a single FeatureOnlineStore. | 
                   | 
                Updates the parameters of a single FeatureView. | 
google.cloud.aiplatform.v1.FeatureOnlineStoreService
        | Methods | |
|---|---|
                   | 
                Bidirectional streaming RPC to directly write to feature values in a feature view. | 
                   | 
                Fetch feature values under a FeatureView. | 
                   | 
                Search the nearest entities under a FeatureView. | 
google.cloud.aiplatform.v1.FeatureRegistryService
        | Methods | |
|---|---|
                   | 
                Creates a batch of Features in a given FeatureGroup. | 
                   | 
                Creates a new Feature in a given FeatureGroup. | 
                   | 
                Creates a new FeatureGroup in a given project and location. | 
                   | 
                Deletes a single Feature. | 
                   | 
                Deletes a single FeatureGroup. | 
                   | 
                Gets details of a single Feature. | 
                   | 
                Gets details of a single FeatureGroup. | 
                   | 
                Lists FeatureGroups in a given project and location. | 
                   | 
                Lists Features in a given FeatureGroup. | 
                   | 
                Updates the parameters of a single Feature. | 
                   | 
                Updates the parameters of a single FeatureGroup. | 
google.cloud.aiplatform.v1.FeaturestoreOnlineServingService
        | Methods | |
|---|---|
                   | 
                Reads Feature values of a specific entity of an EntityType. | 
                   | 
                Reads Feature values for multiple entities. | 
                   | 
                Writes Feature values of one or more entities of an EntityType. | 
google.cloud.aiplatform.v1.FeaturestoreService
        | Methods | |
|---|---|
                   | 
                Creates a batch of Features in a given EntityType. | 
                   | 
                Batch reads Feature values from a Featurestore. | 
                   | 
                Creates a new EntityType in a given Featurestore. | 
                   | 
                Creates a new Feature in a given EntityType. | 
                   | 
                Creates a new Featurestore in a given project and location. | 
                   | 
                Deletes a single EntityType. | 
                   | 
                Deletes a single Feature. | 
                   | 
                Delete Feature values from Featurestore. | 
                   | 
                Deletes a single Featurestore. | 
                   | 
                Exports Feature values from all the entities of a target EntityType. | 
                   | 
                Gets details of a single EntityType. | 
                   | 
                Gets details of a single Feature. | 
                   | 
                Gets details of a single Featurestore. | 
                   | 
                Imports Feature values into the Featurestore from a source storage. | 
                   | 
                Lists EntityTypes in a given Featurestore. | 
                   | 
                Lists Features in a given EntityType. | 
                   | 
                Lists Featurestores in a given project and location. | 
                   | 
                Searches Features matching a query in a given project. | 
                   | 
                Updates the parameters of a single EntityType. | 
                   | 
                Updates the parameters of a single Feature. | 
                   | 
                Updates the parameters of a single Featurestore. | 
google.cloud.aiplatform.v1.GenAiCacheService
        | Methods | |
|---|---|
                   | 
                Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage. | 
                   | 
                Deletes cached content | 
                   | 
                Gets cached content configurations | 
                   | 
                Lists cached contents in a project | 
                   | 
                Updates cached content configurations | 
google.cloud.aiplatform.v1.GenAiTuningService
        | Methods | |
|---|---|
                   | 
                Cancels a TuningJob. | 
                   | 
                Creates a TuningJob. | 
                   | 
                Gets a TuningJob. | 
                   | 
                Lists TuningJobs in a Location. | 
                   | 
                Rebase a TunedModel. | 
google.cloud.aiplatform.v1.IndexEndpointService
        | Methods | |
|---|---|
                   | 
                Creates an IndexEndpoint. | 
                   | 
                Deletes an IndexEndpoint. | 
                   | 
                Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. | 
                   | 
                Gets an IndexEndpoint. | 
                   | 
                Lists IndexEndpoints in a Location. | 
                   | 
                Update an existing DeployedIndex under an IndexEndpoint. | 
                   | 
                Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. | 
                   | 
                Updates an IndexEndpoint. | 
google.cloud.aiplatform.v1.IndexService
        | Methods | |
|---|---|
                   | 
                Creates an Index. | 
                   | 
                Deletes an Index. | 
                   | 
                Gets an Index. | 
                   | 
                Lists Indexes in a Location. | 
                   | 
                Remove Datapoints from an Index. | 
                   | 
                Updates an Index. | 
                   | 
                Add/update Datapoints into an Index. | 
google.cloud.aiplatform.v1.JobService
        | Methods | |
|---|---|
                   | 
                Cancels a BatchPredictionJob. | 
                   | 
                Cancels a CustomJob. | 
                   | 
                Cancels a HyperparameterTuningJob. | 
                   | 
                Cancels a NasJob. | 
                   | 
                Creates a BatchPredictionJob. | 
                   | 
                Creates a CustomJob. | 
                   | 
                Creates a HyperparameterTuningJob | 
                   | 
                Creates a ModelDeploymentMonitoringJob. | 
                   | 
                Creates a NasJob | 
                   | 
                Deletes a BatchPredictionJob. | 
                   | 
                Deletes a CustomJob. | 
                   | 
                Deletes a HyperparameterTuningJob. | 
                   | 
                Deletes a ModelDeploymentMonitoringJob. | 
                   | 
                Deletes a NasJob. | 
                   | 
                Gets a BatchPredictionJob | 
                   | 
                Gets a CustomJob. | 
                   | 
                Gets a HyperparameterTuningJob | 
                   | 
                Gets a ModelDeploymentMonitoringJob. | 
                   | 
                Gets a NasJob | 
                   | 
                Gets a NasTrialDetail. | 
                   | 
                Lists BatchPredictionJobs in a Location. | 
                   | 
                Lists CustomJobs in a Location. | 
                   | 
                Lists HyperparameterTuningJobs in a Location. | 
                   | 
                Lists ModelDeploymentMonitoringJobs in a Location. | 
                   | 
                Lists NasJobs in a Location. | 
                   | 
                List top NasTrialDetails of a NasJob. | 
                   | 
                Pauses a ModelDeploymentMonitoringJob. | 
                   | 
                Resumes a paused ModelDeploymentMonitoringJob. | 
                   | 
                Searches Model Monitoring Statistics generated within a given time window. | 
                   | 
                Updates a ModelDeploymentMonitoringJob. | 
google.cloud.aiplatform.v1.MatchService
        | Methods | 
|---|
google.cloud.aiplatform.v1.MetadataService
        | Methods | |
|---|---|
                   | 
                Adds a set of Artifacts and Executions to a Context. | 
                   | 
                Adds a set of Contexts as children to a parent Context. | 
                   | 
                Adds Events to the specified Execution. | 
                   | 
                Creates an Artifact associated with a MetadataStore. | 
                   | 
                Creates a Context associated with a MetadataStore. | 
                   | 
                Creates an Execution associated with a MetadataStore. | 
                   | 
                Creates a MetadataSchema. | 
                   | 
                Initializes a MetadataStore, including allocation of resources. | 
                   | 
                Deletes an Artifact. | 
                   | 
                Deletes a stored Context. | 
                   | 
                Deletes an Execution. | 
                   | 
                Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). | 
                   | 
                Retrieves a specific Artifact. | 
                   | 
                Retrieves a specific Context. | 
                   | 
                Retrieves a specific Execution. | 
                   | 
                Retrieves a specific MetadataSchema. | 
                   | 
                Retrieves a specific MetadataStore. | 
                   | 
                Lists Artifacts in the MetadataStore. | 
                   | 
                Lists Contexts on the MetadataStore. | 
                   | 
                Lists Executions in the MetadataStore. | 
                   | 
                Lists MetadataSchemas. | 
                   | 
                Lists MetadataStores for a Location. | 
                   | 
                Purges Artifacts. | 
                   | 
                Purges Contexts. | 
                   | 
                Purges Executions. | 
                   | 
                Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. | 
                   | 
                Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. | 
                   | 
                Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. | 
                   | 
                Remove a set of children contexts from a parent Context. | 
                   | 
                Updates a stored Artifact. | 
                   | 
                Updates a stored Context. | 
                   | 
                Updates a stored Execution. | 
google.cloud.aiplatform.v1.MigrationService
        | Methods | |
|---|---|
                   | 
                Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI. | 
                   | 
                Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location. | 
google.cloud.aiplatform.v1.ModelGardenService
        | Methods | |
|---|---|
                   | 
                Deploys a model to a new endpoint. | 
                   | 
                Gets a Model Garden publisher model. | 
google.cloud.aiplatform.v1.ModelService
        | Methods | |
|---|---|
                   | 
                Imports a list of externally generated EvaluatedAnnotations. | 
                   | 
                Imports a list of externally generated ModelEvaluationSlice. | 
                   | 
                Copies an already existing Vertex AI Model into the specified Location. | 
                   | 
                Deletes a Model. | 
                   | 
                Deletes a Model version. | 
                   | 
                Exports a trained, exportable Model to a location specified by the user. | 
                   | 
                Gets a Model. | 
                   | 
                Gets a ModelEvaluation. | 
                   | 
                Gets a ModelEvaluationSlice. | 
                   | 
                Imports an externally generated ModelEvaluation. | 
                   | 
                Lists ModelEvaluationSlices in a ModelEvaluation. | 
                   | 
                Lists ModelEvaluations in a Model. | 
                   | 
                Lists checkpoints of the specified model version. | 
                   | 
                Lists versions of the specified model. | 
                   | 
                Lists Models in a Location. | 
                   | 
                Merges a set of aliases for a Model version. | 
                   | 
                Incrementally update the dataset used for an examples model. | 
                   | 
                Updates a Model. | 
                   | 
                Uploads a Model artifact into Vertex AI. | 
google.cloud.aiplatform.v1.NotebookService
        | Methods | |
|---|---|
                   | 
                Assigns a NotebookRuntime to a user for a particular Notebook file. | 
                   | 
                Creates a NotebookExecutionJob. | 
                   | 
                Creates a NotebookRuntimeTemplate. | 
                   | 
                Deletes a NotebookExecutionJob. | 
                   | 
                Deletes a NotebookRuntime. | 
                   | 
                Deletes a NotebookRuntimeTemplate. | 
                   | 
                Gets a NotebookExecutionJob. | 
                   | 
                Gets a NotebookRuntime. | 
                   | 
                Gets a NotebookRuntimeTemplate. | 
                   | 
                Lists NotebookExecutionJobs in a Location. | 
                   | 
                Lists NotebookRuntimeTemplates in a Location. | 
                   | 
                Lists NotebookRuntimes in a Location. | 
                   | 
                Starts a NotebookRuntime. | 
                   | 
                Stops a NotebookRuntime. | 
                   | 
                Updates a NotebookRuntimeTemplate. | 
                   | 
                Upgrades a NotebookRuntime. | 
google.cloud.aiplatform.v1.PersistentResourceService
        | Methods | |
|---|---|
                   | 
                Creates a PersistentResource. | 
                   | 
                Deletes a PersistentResource. | 
                   | 
                Gets a PersistentResource. | 
                   | 
                Lists PersistentResources in a Location. | 
                   | 
                Reboots a PersistentResource. | 
                   | 
                Updates a PersistentResource. | 
google.cloud.aiplatform.v1.PipelineService
        | Methods | |
|---|---|
                   | 
                Batch cancel PipelineJobs. | 
                   | 
                Batch deletes PipelineJobs The Operation is atomic. | 
                   | 
                Cancels a PipelineJob. | 
                   | 
                Cancels a TrainingPipeline. | 
                   | 
                Creates a PipelineJob. | 
                   | 
                Creates a TrainingPipeline. | 
                   | 
                Deletes a PipelineJob. | 
                   | 
                Deletes a TrainingPipeline. | 
                   | 
                Gets a PipelineJob. | 
                   | 
                Gets a TrainingPipeline. | 
                   | 
                Lists PipelineJobs in a Location. | 
                   | 
                Lists TrainingPipelines in a Location. | 
google.cloud.aiplatform.v1.PredictionService
        | Methods | |
|---|---|
                   | 
                Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks. | 
                   | 
                Perform an unary online prediction request to a gRPC model server for custom containers. | 
                   | 
                Perform an online explanation. | 
                   | 
                Perform an online prediction. | 
                   | 
                |
                   | 
                Perform an online prediction with an arbitrary HTTP payload. | 
                   | 
                Perform a server-side streaming online prediction request for Vertex LLM streaming. | 
                   | 
                Perform a streaming online prediction request to a gRPC model server for Vertex first-party products and frameworks. | 
                   | 
                Perform a streaming online prediction request to a gRPC model server for custom containers. | 
                   | 
                Perform a streaming online prediction with an arbitrary HTTP payload. | 
                   | 
                Perform a streaming online prediction request for Vertex first-party products and frameworks. | 
                   | 
                Perform a streaming online prediction request through gRPC. | 
google.cloud.aiplatform.v1.ReasoningEngineExecutionService
        | Methods | |
|---|---|
                   | 
                Queries using a reasoning engine. | 
                   | 
                Streams queries using a reasoning engine. | 
google.cloud.aiplatform.v1.ReasoningEngineService
        | Methods | |
|---|---|
                   | 
                Creates a reasoning engine. | 
                   | 
                Deletes a reasoning engine. | 
                   | 
                Gets a reasoning engine. | 
                   | 
                Lists reasoning engines in a location. | 
                   | 
                Updates a reasoning engine. | 
google.cloud.aiplatform.v1.ScheduleService
        | Methods | |
|---|---|
                   | 
                Creates a Schedule. | 
                   | 
                Deletes a Schedule. | 
                   | 
                Gets a Schedule. | 
                   | 
                Lists Schedules in a Location. | 
                   | 
                Pauses a Schedule. | 
                   | 
                Resumes a paused Schedule to start scheduling new runs. | 
                   | 
                Updates an active or paused Schedule. | 
google.cloud.aiplatform.v1.SpecialistPoolService
        | Methods | |
|---|---|
                   | 
                Creates a SpecialistPool. | 
                   | 
                Deletes a SpecialistPool as well as all Specialists in the pool. | 
                   | 
                Gets a SpecialistPool. | 
                   | 
                Lists SpecialistPools in a Location. | 
                   | 
                Updates a SpecialistPool. | 
google.cloud.aiplatform.v1.TensorboardService
        | Methods | |
|---|---|
                   | 
                Batch create TensorboardRuns. | 
                   | 
                Batch create TensorboardTimeSeries that belong to a TensorboardExperiment. | 
                   | 
                Reads multiple TensorboardTimeSeries' data. | 
                   | 
                Creates a Tensorboard. | 
                   | 
                Creates a TensorboardExperiment. | 
                   | 
                Creates a TensorboardRun. | 
                   | 
                Creates a TensorboardTimeSeries. | 
                   | 
                Deletes a Tensorboard. | 
                   | 
                Deletes a TensorboardExperiment. | 
                   | 
                Deletes a TensorboardRun. | 
                   | 
                Deletes a TensorboardTimeSeries. | 
                   | 
                Exports a TensorboardTimeSeries' data. | 
                   | 
                Gets a Tensorboard. | 
                   | 
                Gets a TensorboardExperiment. | 
                   | 
                Gets a TensorboardRun. | 
                   | 
                Gets a TensorboardTimeSeries. | 
                   | 
                Lists TensorboardExperiments in a Location. | 
                   | 
                Lists TensorboardRuns in a Location. | 
                   | 
                Lists TensorboardTimeSeries in a Location. | 
                   | 
                Lists Tensorboards in a Location. | 
                   | 
                Gets bytes of TensorboardBlobs. | 
                   | 
                Returns the storage size for a given TensorBoard instance. | 
                   | 
                Reads a TensorboardTimeSeries' data. | 
                   | 
                Returns a list of monthly active users for a given TensorBoard instance. | 
                   | 
                Updates a Tensorboard. | 
                   | 
                Updates a TensorboardExperiment. | 
                   | 
                Updates a TensorboardRun. | 
                   | 
                Updates a TensorboardTimeSeries. | 
                   | 
                Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. | 
                   | 
                Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. | 
google.cloud.aiplatform.v1.VertexRagDataService
        | Methods | |
|---|---|
                   | 
                Creates a RagCorpus. | 
                   | 
                Deletes a RagCorpus. | 
                   | 
                Deletes a RagFile. | 
                   | 
                Gets a RagCorpus. | 
                   | 
                Gets a RagEngineConfig. | 
                   | 
                Gets a RagFile. | 
                   | 
                Import files from Google Cloud Storage or Google Drive into a RagCorpus. | 
                   | 
                Lists RagCorpora in a Location. | 
                   | 
                Lists RagFiles in a RagCorpus. | 
                   | 
                Updates a RagCorpus. | 
                   | 
                Updates a RagEngineConfig. | 
google.cloud.aiplatform.v1.VertexRagService
        | Methods | |
|---|---|
                   | 
                Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses. | 
                   | 
                Given an input text, it returns a score that evaluates the factuality of the text. | 
                   | 
                Retrieves relevant contexts for a query. | 
google.cloud.aiplatform.v1.VizierService
        | Methods | |
|---|---|
                   | 
                Adds a measurement of the objective metrics to a Trial. | 
                   | 
                Checks whether a Trial should stop or not. | 
                   | 
                Marks a Trial as complete. | 
                   | 
                Creates a Study. | 
                   | 
                Adds a user provided Trial to a Study. | 
                   | 
                Deletes a Study. | 
                   | 
                Deletes a Trial. | 
                   | 
                Gets a Study by name. | 
                   | 
                Gets a Trial. | 
                   | 
                Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. | 
                   | 
                Lists all the studies in a region for an associated project. | 
                   | 
                Lists the Trials associated with a Study. | 
                   | 
                Looks a study up using the user-defined display_name field instead of the fully qualified resource name. | 
                   | 
                Stops a Trial. | 
                   | 
                Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. | 
google.cloud.aiplatform.v1beta1.DatasetService
        | Methods | |
|---|---|
                   | 
                Assembles each row of a multimodal dataset and writes the result into a BigQuery table. | 
                   | 
                Assesses the state or validity of the dataset with respect to a given use case. | 
                   | 
                Creates a Dataset. | 
                   | 
                Create a version from a Dataset. | 
                   | 
                Deletes a Dataset. | 
                   | 
                Deletes a Dataset version. | 
                   | 
                Deletes a SavedQuery. | 
                   | 
                Exports data from a Dataset. | 
                   | 
                Gets an AnnotationSpec. | 
                   | 
                Gets a Dataset. | 
                   | 
                Gets a Dataset version. | 
                   | 
                Imports data into a Dataset. | 
                   | 
                Lists Annotations belongs to a dataitem. | 
                   | 
                Lists DataItems in a Dataset. | 
                   | 
                Lists DatasetVersions in a Dataset. | 
                   | 
                Lists Datasets in a Location. | 
                   | 
                Lists SavedQueries in a Dataset. | 
                   | 
                Restores a dataset version. | 
                   | 
                Searches DataItems in a Dataset. | 
                   | 
                Updates a Dataset. | 
                   | 
                Updates a DatasetVersion. | 
google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService
        | Methods | |
|---|---|
                   | 
                Create a DeploymentResourcePool. | 
                   | 
                Delete a DeploymentResourcePool. | 
                   | 
                Get a DeploymentResourcePool. | 
                   | 
                List DeploymentResourcePools in a location. | 
                   | 
                List DeployedModels that have been deployed on this DeploymentResourcePool. | 
                   | 
                Update a DeploymentResourcePool. | 
google.cloud.aiplatform.v1beta1.EndpointService
        | Methods | |
|---|---|
                   | 
                Creates an Endpoint. | 
                   | 
                Deletes an Endpoint. | 
                   | 
                Deploys a Model into this Endpoint, creating a DeployedModel within it. | 
                   | 
                Fetches the configs of publisher models. | 
                   | 
                Gets an Endpoint. | 
                   | 
                Lists Endpoints in a Location. | 
                   | 
                Updates an existing deployed model. | 
                   | 
                Sets (creates or updates) configs of publisher models. | 
                   | 
                Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. | 
                   | 
                Updates an Endpoint. | 
                   | 
                Updates an Endpoint with a long running operation. | 
google.cloud.aiplatform.v1beta1.EvaluationService
        | Methods | |
|---|---|
                   | 
                Evaluates a dataset based on a set of given metrics. | 
                   | 
                Evaluates instances based on a given metric. | 
google.cloud.aiplatform.v1beta1.ExampleStoreService
        | Methods | |
|---|---|
                   | 
                Create an ExampleStore. | 
                   | 
                Delete an ExampleStore. | 
                   | 
                Get Examples from the Example Store. | 
                   | 
                Get an ExampleStore. | 
                   | 
                List ExampleStores in a Location. | 
                   | 
                Remove Examples from the Example Store. | 
                   | 
                Search for similar Examples for given selection criteria. | 
                   | 
                Update an ExampleStore. | 
                   | 
                Create or update Examples in the Example Store. | 
google.cloud.aiplatform.v1beta1.ExtensionExecutionService
        | Methods | |
|---|---|
                   | 
                Executes the request against a given extension. | 
                   | 
                Queries an extension with a default controller. | 
google.cloud.aiplatform.v1beta1.ExtensionRegistryService
        | Methods | |
|---|---|
                   | 
                Deletes an Extension. | 
                   | 
                Gets an Extension. | 
                   | 
                Imports an Extension. | 
                   | 
                Lists Extensions in a location. | 
                   | 
                Updates an Extension. | 
google.cloud.aiplatform.v1beta1.FeatureOnlineStoreAdminService
        | Methods | |
|---|---|
                   | 
                Creates a new FeatureOnlineStore in a given project and location. | 
                   | 
                Creates a new FeatureView in a given FeatureOnlineStore. | 
                   | 
                Deletes a single FeatureOnlineStore. | 
                   | 
                Deletes a single FeatureView. | 
                   | 
                Gets details of a single FeatureOnlineStore. | 
                   | 
                Gets details of a single FeatureView. | 
                   | 
                Gets details of a single FeatureViewSync. | 
                   | 
                Lists FeatureOnlineStores in a given project and location. | 
                   | 
                Lists FeatureViewSyncs in a given FeatureView. | 
                   | 
                Lists FeatureViews in a given FeatureOnlineStore. | 
                   | 
                Triggers on-demand sync for the FeatureView. | 
                   | 
                Updates the parameters of a single FeatureOnlineStore. | 
                   | 
                Updates the parameters of a single FeatureView. | 
google.cloud.aiplatform.v1beta1.FeatureOnlineStoreService
        | Methods | |
|---|---|
                   | 
                Bidirectional streaming RPC to directly write to feature values in a feature view. | 
                   | 
                Fetch feature values under a FeatureView. | 
                   | 
                Search the nearest entities under a FeatureView. | 
                   | 
                Bidirectional streaming RPC to fetch feature values under a FeatureView. | 
google.cloud.aiplatform.v1beta1.FeatureRegistryService
        | Methods | |
|---|---|
                   | 
                Creates a batch of Features in a given FeatureGroup. | 
                   | 
                Creates a new Feature in a given FeatureGroup. | 
                   | 
                Creates a new FeatureGroup in a given project and location. | 
                   | 
                Creates a new FeatureMonitor in a given project, location and FeatureGroup. | 
                   | 
                Creates a new feature monitor job. | 
                   | 
                Deletes a single Feature. | 
                   | 
                Deletes a single FeatureGroup. | 
                   | 
                Deletes a single FeatureMonitor. | 
                   | 
                Gets details of a single Feature. | 
                   | 
                Gets details of a single FeatureGroup. | 
                   | 
                Gets details of a single FeatureMonitor. | 
                   | 
                Get a feature monitor job. | 
                   | 
                Lists FeatureGroups in a given project and location. | 
                   | 
                List feature monitor jobs. | 
                   | 
                Lists FeatureGroups in a given project and location. | 
                   | 
                Lists Features in a given FeatureGroup. | 
                   | 
                Updates the parameters of a single Feature. | 
                   | 
                Updates the parameters of a single FeatureGroup. | 
                   | 
                Updates the parameters of a single FeatureMonitor. | 
google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService
        | Methods | |
|---|---|
                   | 
                Reads Feature values of a specific entity of an EntityType. | 
                   | 
                Reads Feature values for multiple entities. | 
                   | 
                Writes Feature values of one or more entities of an EntityType. | 
google.cloud.aiplatform.v1beta1.FeaturestoreService
        | Methods | |
|---|---|
                   | 
                Creates a batch of Features in a given EntityType. | 
                   | 
                Batch reads Feature values from a Featurestore. | 
                   | 
                Creates a new EntityType in a given Featurestore. | 
                   | 
                Creates a new Feature in a given EntityType. | 
                   | 
                Creates a new Featurestore in a given project and location. | 
                   | 
                Deletes a single EntityType. | 
                   | 
                Deletes a single Feature. | 
                   | 
                Delete Feature values from Featurestore. | 
                   | 
                Deletes a single Featurestore. | 
                   | 
                Exports Feature values from all the entities of a target EntityType. | 
                   | 
                Gets details of a single EntityType. | 
                   | 
                Gets details of a single Feature. | 
                   | 
                Gets details of a single Featurestore. | 
                   | 
                Imports Feature values into the Featurestore from a source storage. | 
                   | 
                Lists EntityTypes in a given Featurestore. | 
                   | 
                Lists Features in a given EntityType. | 
                   | 
                Lists Featurestores in a given project and location. | 
                   | 
                Searches Features matching a query in a given project. | 
                   | 
                Updates the parameters of a single EntityType. | 
                   | 
                Updates the parameters of a single Feature. | 
                   | 
                Updates the parameters of a single Featurestore. | 
google.cloud.aiplatform.v1beta1.GenAiCacheService
        | Methods | |
|---|---|
                   | 
                Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage. | 
                   | 
                Deletes cached content | 
                   | 
                Gets cached content configurations | 
                   | 
                Lists cached contents in a project | 
                   | 
                Updates cached content configurations | 
google.cloud.aiplatform.v1beta1.GenAiTuningService
        | Methods | |
|---|---|
                   | 
                Cancels a TuningJob. | 
                   | 
                Creates a TuningJob. | 
                   | 
                Gets a TuningJob. | 
                   | 
                Lists TuningJobs in a Location. | 
                   | 
                Rebase a TunedModel. | 
google.cloud.aiplatform.v1beta1.IndexEndpointService
        | Methods | |
|---|---|
                   | 
                Creates an IndexEndpoint. | 
                   | 
                Deletes an IndexEndpoint. | 
                   | 
                Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. | 
                   | 
                Gets an IndexEndpoint. | 
                   | 
                Lists IndexEndpoints in a Location. | 
                   | 
                Update an existing DeployedIndex under an IndexEndpoint. | 
                   | 
                Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. | 
                   | 
                Updates an IndexEndpoint. | 
google.cloud.aiplatform.v1beta1.IndexService
        | Methods | |
|---|---|
                   | 
                Creates an Index. | 
                   | 
                Deletes an Index. | 
                   | 
                Gets an Index. | 
                   | 
                Imports an Index from an external source (e.g., BigQuery). | 
                   | 
                Lists Indexes in a Location. | 
                   | 
                Remove Datapoints from an Index. | 
                   | 
                Updates an Index. | 
                   | 
                Add/update Datapoints into an Index. | 
google.cloud.aiplatform.v1beta1.JobService
        | Methods | |
|---|---|
                   | 
                Cancels a BatchPredictionJob. | 
                   | 
                Cancels a CustomJob. | 
                   | 
                Cancels a HyperparameterTuningJob. | 
                   | 
                Creates a BatchPredictionJob. | 
                   | 
                Creates a CustomJob. | 
                   | 
                Creates a HyperparameterTuningJob | 
                   | 
                Creates a ModelDeploymentMonitoringJob. | 
                   | 
                Deletes a BatchPredictionJob. | 
                   | 
                Deletes a CustomJob. | 
                   | 
                Deletes a HyperparameterTuningJob. | 
                   | 
                Deletes a ModelDeploymentMonitoringJob. | 
                   | 
                Gets a BatchPredictionJob | 
                   | 
                Gets a CustomJob. | 
                   | 
                Gets a HyperparameterTuningJob | 
                   | 
                Gets a ModelDeploymentMonitoringJob. | 
                   | 
                Lists BatchPredictionJobs in a Location. | 
                   | 
                Lists CustomJobs in a Location. | 
                   | 
                Lists HyperparameterTuningJobs in a Location. | 
                   | 
                Lists ModelDeploymentMonitoringJobs in a Location. | 
                   | 
                Pauses a ModelDeploymentMonitoringJob. | 
                   | 
                Resumes a paused ModelDeploymentMonitoringJob. | 
                   | 
                Searches Model Monitoring Statistics generated within a given time window. | 
                   | 
                Updates a ModelDeploymentMonitoringJob. | 
google.cloud.aiplatform.v1beta1.MatchService
        | Methods | 
|---|
google.cloud.aiplatform.v1beta1.MemoryBankService
        | Methods | |
|---|---|
                   | 
                Create a Memory. | 
                   | 
                Delete a Memory. | 
                   | 
                Generate memories. | 
                   | 
                Get a Memory. | 
                   | 
                List Memories. | 
                   | 
                Retrieve memories. | 
                   | 
                Update a Memory. | 
google.cloud.aiplatform.v1beta1.MetadataService
        | Methods | |
|---|---|
                   | 
                Adds a set of Artifacts and Executions to a Context. | 
                   | 
                Adds a set of Contexts as children to a parent Context. | 
                   | 
                Adds Events to the specified Execution. | 
                   | 
                Creates an Artifact associated with a MetadataStore. | 
                   | 
                Creates a Context associated with a MetadataStore. | 
                   | 
                Creates an Execution associated with a MetadataStore. | 
                   | 
                Creates a MetadataSchema. | 
                   | 
                Initializes a MetadataStore, including allocation of resources. | 
                   | 
                Deletes an Artifact. | 
                   | 
                Deletes a stored Context. | 
                   | 
                Deletes an Execution. | 
                   | 
                Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). | 
                   | 
                Retrieves a specific Artifact. | 
                   | 
                Retrieves a specific Context. | 
                   | 
                Retrieves a specific Execution. | 
                   | 
                Retrieves a specific MetadataSchema. | 
                   | 
                Retrieves a specific MetadataStore. | 
                   | 
                Lists Artifacts in the MetadataStore. | 
                   | 
                Lists Contexts on the MetadataStore. | 
                   | 
                Lists Executions in the MetadataStore. | 
                   | 
                Lists MetadataSchemas. | 
                   | 
                Lists MetadataStores for a Location. | 
                   | 
                Purges Artifacts. | 
                   | 
                Purges Contexts. | 
                   | 
                Purges Executions. | 
                   | 
                Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. | 
                   | 
                Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. | 
                   | 
                Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. | 
                   | 
                Remove a set of children contexts from a parent Context. | 
                   | 
                Updates a stored Artifact. | 
                   | 
                Updates a stored Context. | 
                   | 
                Updates a stored Execution. | 
google.cloud.aiplatform.v1beta1.MigrationService
        | Methods | |
|---|---|
                   | 
                Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI. | 
                   | 
                Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location. | 
google.cloud.aiplatform.v1beta1.ModelGardenService
        | Methods | |
|---|---|
                   | 
                Accepts the EULA acceptance status of a publisher model. | 
                   | 
                Checks the EULA acceptance status of a publisher model. | 
                   | 
                Deploys a model to a new endpoint. | 
                   | 
                Deploys publisher models. | 
                   | 
                Exports a publisher model to a user provided Google Cloud Storage bucket. | 
                   | 
                Gets a Model Garden publisher model. | 
                   | 
                Lists publisher models in Model Garden. | 
google.cloud.aiplatform.v1beta1.ModelMonitoringService
        | Methods | |
|---|---|
                   | 
                Creates a ModelMonitor. | 
                   | 
                Creates a ModelMonitoringJob. | 
                   | 
                Deletes a ModelMonitor. | 
                   | 
                Deletes a ModelMonitoringJob. | 
                   | 
                Gets a ModelMonitor. | 
                   | 
                Gets a ModelMonitoringJob. | 
                   | 
                Lists ModelMonitoringJobs. | 
                   | 
                Lists ModelMonitors in a Location. | 
                   | 
                Returns the Model Monitoring alerts. | 
                   | 
                Searches Model Monitoring Stats generated within a given time window. | 
                   | 
                Updates a ModelMonitor. | 
google.cloud.aiplatform.v1beta1.ModelService
        | Methods | |
|---|---|
                   | 
                Imports a list of externally generated EvaluatedAnnotations. | 
                   | 
                Imports a list of externally generated ModelEvaluationSlice. | 
                   | 
                Copies an already existing Vertex AI Model into the specified Location. | 
                   | 
                Deletes a Model. | 
                   | 
                Deletes a Model version. | 
                   | 
                Exports a trained, exportable Model to a location specified by the user. | 
                   | 
                Gets a Model. | 
                   | 
                Gets a ModelEvaluation. | 
                   | 
                Gets a ModelEvaluationSlice. | 
                   | 
                Imports an externally generated ModelEvaluation. | 
                   | 
                Lists ModelEvaluationSlices in a ModelEvaluation. | 
                   | 
                Lists ModelEvaluations in a Model. | 
                   | 
                Lists checkpoints of the specified model version. | 
                   | 
                Lists versions of the specified model. | 
                   | 
                Lists Models in a Location. | 
                   | 
                Merges a set of aliases for a Model version. | 
                   | 
                Gets a Model's spec recommendations. | 
                   | 
                Incrementally update the dataset used for an examples model. | 
                   | 
                Updates a Model. | 
                   | 
                Uploads a Model artifact into Vertex AI. | 
google.cloud.aiplatform.v1beta1.NotebookService
        | Methods | |
|---|---|
                   | 
                Assigns a NotebookRuntime to a user for a particular Notebook file. | 
                   | 
                Creates a NotebookExecutionJob. | 
                   | 
                Creates a NotebookRuntimeTemplate. | 
                   | 
                Deletes a NotebookExecutionJob. | 
                   | 
                Deletes a NotebookRuntime. | 
                   | 
                Deletes a NotebookRuntimeTemplate. | 
                   | 
                Gets a NotebookExecutionJob. | 
                   | 
                Gets a NotebookRuntime. | 
                   | 
                Gets a NotebookRuntimeTemplate. | 
                   | 
                Lists NotebookExecutionJobs in a Location. | 
                   | 
                Lists NotebookRuntimeTemplates in a Location. | 
                   | 
                Lists NotebookRuntimes in a Location. | 
                   | 
                Starts a NotebookRuntime. | 
                   | 
                Stops a NotebookRuntime. | 
                   | 
                Updates a NotebookRuntimeTemplate. | 
                   | 
                Upgrades a NotebookRuntime. | 
google.cloud.aiplatform.v1beta1.PersistentResourceService
        | Methods | |
|---|---|
                   | 
                Creates a PersistentResource. | 
                   | 
                Deletes a PersistentResource. | 
                   | 
                Gets a PersistentResource. | 
                   | 
                Lists PersistentResources in a Location. | 
                   | 
                Reboots a PersistentResource. | 
                   | 
                Updates a PersistentResource. | 
google.cloud.aiplatform.v1beta1.PipelineService
        | Methods | |
|---|---|
                   | 
                Batch cancel PipelineJobs. | 
                   | 
                Batch deletes PipelineJobs The Operation is atomic. | 
                   | 
                Cancels a PipelineJob. | 
                   | 
                Cancels a TrainingPipeline. | 
                   | 
                Creates a PipelineJob. | 
                   | 
                Creates a TrainingPipeline. | 
                   | 
                Deletes a PipelineJob. | 
                   | 
                Deletes a TrainingPipeline. | 
                   | 
                Gets a PipelineJob. | 
                   | 
                Gets a TrainingPipeline. | 
                   | 
                Lists PipelineJobs in a Location. | 
                   | 
                Lists TrainingPipelines in a Location. | 
google.cloud.aiplatform.v1beta1.PredictionService
        | Methods | |
|---|---|
                   | 
                Exposes an OpenAI-compatible endpoint for chat completions. | 
                   | 
                Perform a token counting. | 
                   | 
                Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks. | 
                   | 
                Perform an unary online prediction request to a gRPC model server for custom containers. | 
                   | 
                Perform an online explanation. | 
                   | 
                Perform an online prediction. | 
                   | 
                Perform an online prediction with an arbitrary HTTP payload. | 
                   | 
                Perform a server-side streaming online prediction request for Vertex LLM streaming. | 
                   | 
                Perform a streaming online prediction request to a gRPC model server for Vertex first-party products and frameworks. | 
                   | 
                Perform a streaming online prediction request to a gRPC model server for custom containers. | 
                   | 
                Perform a streaming online prediction with an arbitrary HTTP payload. | 
                   | 
                Perform a streaming online prediction request for Vertex first-party products and frameworks. | 
                   | 
                Perform a streaming online prediction request through gRPC. | 
google.cloud.aiplatform.v1beta1.ReasoningEngineExecutionService
        | Methods | |
|---|---|
                   | 
                Queries using a reasoning engine. | 
                   | 
                Streams queries using a reasoning engine. | 
google.cloud.aiplatform.v1beta1.ReasoningEngineService
        | Methods | |
|---|---|
                   | 
                Creates a reasoning engine. | 
                   | 
                Deletes a reasoning engine. | 
                   | 
                Gets a reasoning engine. | 
                   | 
                Lists reasoning engines in a location. | 
                   | 
                Updates a reasoning engine. | 
google.cloud.aiplatform.v1beta1.ScheduleService
        | Methods | |
|---|---|
                   | 
                Creates a Schedule. | 
                   | 
                Deletes a Schedule. | 
                   | 
                Gets a Schedule. | 
                   | 
                Lists Schedules in a Location. | 
                   | 
                Pauses a Schedule. | 
                   | 
                Resumes a paused Schedule to start scheduling new runs. | 
                   | 
                Updates an active or paused Schedule. | 
google.cloud.aiplatform.v1beta1.SessionService
        | Methods | |
|---|---|
                   | 
                Appends an event to a given session. | 
                   | 
                
                  Creates a new Session. | 
              
                   | 
                
                  Deletes details of the specific Session. | 
              
                   | 
                
                  Gets details of the specific Session. | 
              
                   | 
                
                  Lists Events in a given session. | 
              
                   | 
                
                  Lists Sessions in a given reasoning engine. | 
              
                   | 
                
                  Updates the specific Session. | 
              
google.cloud.aiplatform.v1beta1.SpecialistPoolService
        | Methods | |
|---|---|
                   | 
                Creates a SpecialistPool. | 
                   | 
                Deletes a SpecialistPool as well as all Specialists in the pool. | 
                   | 
                Gets a SpecialistPool. | 
                   | 
                Lists SpecialistPools in a Location. | 
                   | 
                Updates a SpecialistPool. | 
google.cloud.aiplatform.v1beta1.TensorboardService
        | Methods | |
|---|---|
                   | 
                Batch create TensorboardRuns. | 
                   | 
                Batch create TensorboardTimeSeries that belong to a TensorboardExperiment. | 
                   | 
                Reads multiple TensorboardTimeSeries' data. | 
                   | 
                Creates a Tensorboard. | 
                   | 
                Creates a TensorboardExperiment. | 
                   | 
                Creates a TensorboardRun. | 
                   | 
                Creates a TensorboardTimeSeries. | 
                   | 
                Deletes a Tensorboard. | 
                   | 
                Deletes a TensorboardExperiment. | 
                   | 
                Deletes a TensorboardRun. | 
                   | 
                Deletes a TensorboardTimeSeries. | 
                   | 
                Exports a TensorboardTimeSeries' data. | 
                   | 
                Gets a Tensorboard. | 
                   | 
                Gets a TensorboardExperiment. | 
                   | 
                Gets a TensorboardRun. | 
                   | 
                Gets a TensorboardTimeSeries. | 
                   | 
                Lists TensorboardExperiments in a Location. | 
                   | 
                Lists TensorboardRuns in a Location. | 
                   | 
                Lists TensorboardTimeSeries in a Location. | 
                   | 
                Lists Tensorboards in a Location. | 
                   | 
                Gets bytes of TensorboardBlobs. | 
                   | 
                Returns the storage size for a given TensorBoard instance. | 
                   | 
                Reads a TensorboardTimeSeries' data. | 
                   | 
                Returns a list of monthly active users for a given TensorBoard instance. | 
                   | 
                Updates a Tensorboard. | 
                   | 
                Updates a TensorboardExperiment. | 
                   | 
                Updates a TensorboardRun. | 
                   | 
                Updates a TensorboardTimeSeries. | 
                   | 
                Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. | 
                   | 
                Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. | 
google.cloud.aiplatform.v1beta1.VertexRagDataService
        | Methods | |
|---|---|
                   | 
                Creates a RagCorpus. | 
                   | 
                Deletes a RagCorpus. | 
                   | 
                Deletes a RagFile. | 
                   | 
                Gets a RagCorpus. | 
                   | 
                Gets a RagEngineConfig. | 
                   | 
                Gets a RagFile. | 
                   | 
                Import files from Google Cloud Storage or Google Drive into a RagCorpus. | 
                   | 
                Lists RagCorpora in a Location. | 
                   | 
                Lists RagFiles in a RagCorpus. | 
                   | 
                Updates a RagCorpus. | 
                   | 
                Updates a RagEngineConfig. | 
google.cloud.aiplatform.v1beta1.VertexRagService
        | Methods | |
|---|---|
                   | 
                Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses. | 
                   | 
                Given an input text, it returns a score that evaluates the factuality of the text. | 
                   | 
                Retrieves relevant contexts for a query. | 
google.cloud.aiplatform.v1beta1.VizierService
        | Methods | |
|---|---|
                   | 
                Adds a measurement of the objective metrics to a Trial. | 
                   | 
                Checks whether a Trial should stop or not. | 
                   | 
                Marks a Trial as complete. | 
                   | 
                Creates a Study. | 
                   | 
                Adds a user provided Trial to a Study. | 
                   | 
                Deletes a Study. | 
                   | 
                Deletes a Trial. | 
                   | 
                Gets a Study by name. | 
                   | 
                Gets a Trial. | 
                   | 
                Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. | 
                   | 
                Lists all the studies in a region for an associated project. | 
                   | 
                Lists the Trials associated with a Study. | 
                   | 
                Looks a study up using the user-defined display_name field instead of the fully qualified resource name. | 
                   | 
                Stops a Trial. | 
                   | 
                Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. | 
google.iam.v1.IAMPolicy
        | Methods | |
|---|---|
                   | 
                Gets the access control policy for a resource. | 
                   | 
                Sets the access control policy on the specified resource. | 
                   | 
                Returns permissions that a caller has on the specified resource. | 
google.longrunning.Operations
        | Methods | |
|---|---|
                   | 
                Starts asynchronous cancellation on a long-running operation. | 
                   | 
                Deletes a long-running operation. | 
                   | 
                Gets the latest state of a long-running operation. | 
                   | 
                Lists operations that match the specified filter in the request. | 
                   | 
                Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. |