Train high-quality custom machine learning models with minimal machine learning expertise and effort.
Service: aiplatform.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoints and all URIs below are relative to these service endpoints:
- https://aiplatform.googleapis.com
- https://africa-south1-aiplatform.googleapis.com
- https://asia-east1-aiplatform.googleapis.com
- https://asia-east2-aiplatform.googleapis.com
- https://asia-northeast1-aiplatform.googleapis.com
- https://asia-northeast2-aiplatform.googleapis.com
- https://asia-northeast3-aiplatform.googleapis.com
- https://asia-south1-aiplatform.googleapis.com
- https://asia-southeast1-aiplatform.googleapis.com
- https://asia-southeast2-aiplatform.googleapis.com
- https://australia-southeast1-aiplatform.googleapis.com
- https://australia-southeast2-aiplatform.googleapis.com
- https://europe-central2-aiplatform.googleapis.com
- https://europe-north1-aiplatform.googleapis.com
- https://europe-southwest1-aiplatform.googleapis.com
- https://europe-west1-aiplatform.googleapis.com
- https://europe-west2-aiplatform.googleapis.com
- https://europe-west3-aiplatform.googleapis.com
- https://europe-west4-aiplatform.googleapis.com
- https://europe-west6-aiplatform.googleapis.com
- https://europe-west8-aiplatform.googleapis.com
- https://europe-west9-aiplatform.googleapis.com
- https://europe-west12-aiplatform.googleapis.com
- https://me-central1-aiplatform.googleapis.com
- https://me-central2-aiplatform.googleapis.com
- https://me-west1-aiplatform.googleapis.com
- https://northamerica-northeast1-aiplatform.googleapis.com
- https://northamerica-northeast2-aiplatform.googleapis.com
- https://southamerica-east1-aiplatform.googleapis.com
- https://southamerica-west1-aiplatform.googleapis.com
- https://us-central1-aiplatform.googleapis.com
- https://us-east1-aiplatform.googleapis.com
- https://us-east4-aiplatform.googleapis.com
- https://us-south1-aiplatform.googleapis.com
- https://us-west1-aiplatform.googleapis.com
- https://us-west2-aiplatform.googleapis.com
- https://us-west3-aiplatform.googleapis.com
- https://us-west4-aiplatform.googleapis.com
- https://us-east5-aiplatform.googleapis.com
See Feature availability for the supported features for each region.
REST Resource: v1.media
| Methods | |
|---|---|
| upload | POST /v1/{parent}/ragFiles:uploadPOST /upload/v1/{parent}/ragFiles:uploadUpload a file into a RagCorpus. | 
REST Resource: v1.projects.locations
| Methods | |
|---|---|
| augmentPrompt | POST /v1/{parent}:augmentPromptGiven an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses. | 
| corroborateContent | POST /v1/{parent}:corroborateContentGiven an input text, it returns a score that evaluates the factuality of the text. | 
| deploy | POST /v1/{destination}:deployDeploys a model to a new endpoint. | 
| evaluateInstances | POST /v1/{location}:evaluateInstancesEvaluates instances based on a given metric. | 
| getRagEngineConfig | GET /v1/{name}Gets a RagEngineConfig. | 
| retrieveContexts | POST /v1/{parent}:retrieveContextsRetrieves relevant contexts for a query. | 
| updateRagEngineConfig | PATCH /v1/{ragEngineConfig.name}Updates a RagEngineConfig. | 
REST Resource: v1.projects.locations.batchPredictionJobs
| Methods | |
|---|---|
| cancel | POST /v1/{name}:cancelCancels a BatchPredictionJob. | 
| create | POST /v1/{parent}/batchPredictionJobsCreates a BatchPredictionJob. | 
| delete | DELETE /v1/{name}Deletes a BatchPredictionJob. | 
| get | GET /v1/{name}Gets a BatchPredictionJob | 
| list | GET /v1/{parent}/batchPredictionJobsLists BatchPredictionJobs in a Location. | 
REST Resource: v1.projects.locations.cachedContents
| Methods | |
|---|---|
| create | POST /v1/{parent}/cachedContentsCreates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage. | 
| delete | DELETE /v1/{name}Deletes cached content | 
| get | GET /v1/{name}Gets cached content configurations | 
| list | GET /v1/{parent}/cachedContentsLists cached contents in a project | 
| patch | PATCH /v1/{cachedContent.name}Updates cached content configurations | 
REST Resource: v1.projects.locations.customJobs
| Methods | |
|---|---|
| cancel | POST /v1/{name}:cancelCancels a CustomJob. | 
| create | POST /v1/{parent}/customJobsCreates a CustomJob. | 
| delete | DELETE /v1/{name}Deletes a CustomJob. | 
| get | GET /v1/{name}Gets a CustomJob. | 
| list | GET /v1/{parent}/customJobsLists CustomJobs in a Location. | 
REST Resource: v1.projects.locations.datasets
| Methods | |
|---|---|
| create | POST /v1/{parent}/datasetsCreates a Dataset. | 
| delete | DELETE /v1/{name}Deletes a Dataset. | 
| export | POST /v1/{name}:exportExports data from a Dataset. | 
| get | GET /v1/{name}Gets a Dataset. | 
| import | POST /v1/{name}:importImports data into a Dataset. | 
| list | GET /v1/{parent}/datasetsLists Datasets in a Location. | 
| patch | PATCH /v1/{dataset.name}Updates a Dataset. | 
| searchDataItems | GET /v1/{dataset}:searchDataItemsSearches DataItems in a Dataset. | 
REST Resource: v1.projects.locations.datasets.annotationSpecs
| Methods | |
|---|---|
| get | GET /v1/{name}Gets an AnnotationSpec. | 
REST Resource: v1.projects.locations.datasets.dataItems
| Methods | |
|---|---|
| list | GET /v1/{parent}/dataItemsLists DataItems in a Dataset. | 
REST Resource: v1.projects.locations.datasets.dataItems.annotations
| Methods | |
|---|---|
| list | GET /v1/{parent}/annotationsLists Annotations belongs to a dataitem. | 
REST Resource: v1.projects.locations.datasets.datasetVersions
| Methods | |
|---|---|
| create | POST /v1/{parent}/datasetVersionsCreate a version from a Dataset. | 
| delete | DELETE /v1/{name}Deletes a Dataset version. | 
| get | GET /v1/{name}Gets a Dataset version. | 
| list | GET /v1/{parent}/datasetVersionsLists DatasetVersions in a Dataset. | 
| patch | PATCH /v1/{datasetVersion.name}Updates a DatasetVersion. | 
| restore | GET /v1/{name}:restoreRestores a dataset version. | 
REST Resource: v1.projects.locations.datasets.savedQueries
| Methods | |
|---|---|
| delete | DELETE /v1/{name}Deletes a SavedQuery. | 
| list | GET /v1/{parent}/savedQueriesLists SavedQueries in a Dataset. | 
REST Resource: v1.projects.locations.deploymentResourcePools
| Methods | |
|---|---|
| create | POST /v1/{parent}/deploymentResourcePoolsCreate a DeploymentResourcePool. | 
| delete | DELETE /v1/{name}Delete a DeploymentResourcePool. | 
| get | GET /v1/{name}Get a DeploymentResourcePool. | 
| list | GET /v1/{parent}/deploymentResourcePoolsList DeploymentResourcePools in a location. | 
| patch | PATCH /v1/{deploymentResourcePool.name}Update a DeploymentResourcePool. | 
| queryDeployedModels | GET /v1/{deploymentResourcePool}:queryDeployedModelsList DeployedModels that have been deployed on this DeploymentResourcePool. | 
REST Resource: v1.projects.locations.endpoints
| Methods | |
|---|---|
| create | POST /v1/{parent}/endpointsCreates an Endpoint. | 
| delete | DELETE /v1/{name}Deletes an Endpoint. | 
| deployModel | POST /v1/{endpoint}:deployModelDeploys a Model into this Endpoint, creating a DeployedModel within it. | 
| directPredict | POST /v1/{endpoint}:directPredictPerform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks. | 
| directRawPredict | POST /v1/{endpoint}:directRawPredictPerform an unary online prediction request to a gRPC model server for custom containers. | 
| explain | POST /v1/{endpoint}:explainPerform an online explanation. | 
| get | GET /v1/{name}Gets an Endpoint. | 
| list | GET /v1/{parent}/endpointsLists Endpoints in a Location. | 
| mutateDeployedModel | POST /v1/{endpoint}:mutateDeployedModelUpdates an existing deployed model. | 
| patch | PATCH /v1/{endpoint.name}Updates an Endpoint. | 
| predict | POST /v1/{endpoint}:predictPerform an online prediction. | 
| predictLongRunning | POST /v1/{endpoint}:predictLongRunning | 
| rawPredict | POST /v1/{endpoint}:rawPredictPerform an online prediction with an arbitrary HTTP payload. | 
| serverStreamingPredict | POST /v1/{endpoint}:serverStreamingPredictPerform a server-side streaming online prediction request for Vertex LLM streaming. | 
| streamRawPredict | POST /v1/{endpoint}:streamRawPredictPerform a streaming online prediction with an arbitrary HTTP payload. | 
| undeployModel | POST /v1/{endpoint}:undeployModelUndeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. | 
| update | POST /v1/{endpoint.name}:updateUpdates an Endpoint with a long running operation. | 
REST Resource: v1.projects.locations.featureGroups
| Methods | |
|---|---|
| create | POST /v1/{parent}/featureGroupsCreates a new FeatureGroup in a given project and location. | 
| delete | DELETE /v1/{name}Deletes a single FeatureGroup. | 
| get | GET /v1/{name}Gets details of a single FeatureGroup. | 
| getIamPolicy | POST /v1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1/{parent}/featureGroupsLists FeatureGroups in a given project and location. | 
| patch | PATCH /v1/{featureGroup.name}Updates the parameters of a single FeatureGroup. | 
| setIamPolicy | POST /v1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1.projects.locations.featureGroups.features
| Methods | |
|---|---|
| batchCreate | POST /v1/{parent}/features:batchCreateCreates a batch of Features in a given FeatureGroup. | 
| create | POST /v1/{parent}/featuresCreates a new Feature in a given FeatureGroup. | 
| delete | DELETE /v1/{name}Deletes a single Feature. | 
| get | GET /v1/{name}Gets details of a single Feature. | 
| list | GET /v1/{parent}/featuresLists Features in a given FeatureGroup. | 
| patch | PATCH /v1/{feature.name}Updates the parameters of a single Feature. | 
REST Resource: v1.projects.locations.featureOnlineStores
| Methods | |
|---|---|
| create | POST /v1/{parent}/featureOnlineStoresCreates a new FeatureOnlineStore in a given project and location. | 
| delete | DELETE /v1/{name}Deletes a single FeatureOnlineStore. | 
| get | GET /v1/{name}Gets details of a single FeatureOnlineStore. | 
| getIamPolicy | POST /v1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1/{parent}/featureOnlineStoresLists FeatureOnlineStores in a given project and location. | 
| patch | PATCH /v1/{featureOnlineStore.name}Updates the parameters of a single FeatureOnlineStore. | 
| setIamPolicy | POST /v1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1.projects.locations.featureOnlineStores.featureViews
| Methods | |
|---|---|
| create | POST /v1/{parent}/featureViewsCreates a new FeatureView in a given FeatureOnlineStore. | 
| delete | DELETE /v1/{name}Deletes a single FeatureView. | 
| directWrite | POST /v1/{featureView}:directWriteBidirectional streaming RPC to directly write to feature values in a feature view. | 
| fetchFeatureValues | POST /v1/{featureView}:fetchFeatureValuesFetch feature values under a FeatureView. | 
| get | GET /v1/{name}Gets details of a single FeatureView. | 
| getIamPolicy | POST /v1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1/{parent}/featureViewsLists FeatureViews in a given FeatureOnlineStore. | 
| patch | PATCH /v1/{featureView.name}Updates the parameters of a single FeatureView. | 
| searchNearestEntities | POST /v1/{featureView}:searchNearestEntitiesSearch the nearest entities under a FeatureView. | 
| setIamPolicy | POST /v1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| sync | POST /v1/{featureView}:syncTriggers on-demand sync for the FeatureView. | 
| testIamPermissions | POST /v1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1.projects.locations.featureOnlineStores.featureViews.featureViewSyncs
| Methods | |
|---|---|
| get | GET /v1/{name}Gets details of a single FeatureViewSync. | 
| list | GET /v1/{parent}/featureViewSyncsLists FeatureViewSyncs in a given FeatureView. | 
REST Resource: v1.projects.locations.featurestores
| Methods | |
|---|---|
| batchReadFeatureValues | POST /v1/{featurestore}:batchReadFeatureValuesBatch reads Feature values from a Featurestore. | 
| create | POST /v1/{parent}/featurestoresCreates a new Featurestore in a given project and location. | 
| delete | DELETE /v1/{name}Deletes a single Featurestore. | 
| get | GET /v1/{name}Gets details of a single Featurestore. | 
| getIamPolicy | POST /v1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1/{parent}/featurestoresLists Featurestores in a given project and location. | 
| patch | PATCH /v1/{featurestore.name}Updates the parameters of a single Featurestore. | 
| searchFeatures | GET /v1/{location}/featurestores:searchFeaturesSearches Features matching a query in a given project. | 
| setIamPolicy | POST /v1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1.projects.locations.featurestores.entityTypes
| Methods | |
|---|---|
| create | POST /v1/{parent}/entityTypesCreates a new EntityType in a given Featurestore. | 
| delete | DELETE /v1/{name}Deletes a single EntityType. | 
| deleteFeatureValues | POST /v1/{entityType}:deleteFeatureValuesDelete Feature values from Featurestore. | 
| exportFeatureValues | POST /v1/{entityType}:exportFeatureValuesExports Feature values from all the entities of a target EntityType. | 
| get | GET /v1/{name}Gets details of a single EntityType. | 
| getIamPolicy | POST /v1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| importFeatureValues | POST /v1/{entityType}:importFeatureValuesImports Feature values into the Featurestore from a source storage. | 
| list | GET /v1/{parent}/entityTypesLists EntityTypes in a given Featurestore. | 
| patch | PATCH /v1/{entityType.name}Updates the parameters of a single EntityType. | 
| readFeatureValues | POST /v1/{entityType}:readFeatureValuesReads Feature values of a specific entity of an EntityType. | 
| setIamPolicy | POST /v1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| streamingReadFeatureValues | POST /v1/{entityType}:streamingReadFeatureValuesReads Feature values for multiple entities. | 
| testIamPermissions | POST /v1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
| writeFeatureValues | POST /v1/{entityType}:writeFeatureValuesWrites Feature values of one or more entities of an EntityType. | 
REST Resource: v1.projects.locations.featurestores.entityTypes.features
| Methods | |
|---|---|
| batchCreate | POST /v1/{parent}/features:batchCreateCreates a batch of Features in a given EntityType. | 
| create | POST /v1/{parent}/featuresCreates a new Feature in a given EntityType. | 
| delete | DELETE /v1/{name}Deletes a single Feature. | 
| get | GET /v1/{name}Gets details of a single Feature. | 
| list | GET /v1/{parent}/featuresLists Features in a given EntityType. | 
| patch | PATCH /v1/{feature.name}Updates the parameters of a single Feature. | 
REST Resource: v1.projects.locations.hyperparameterTuningJobs
| Methods | |
|---|---|
| cancel | POST /v1/{name}:cancelCancels a HyperparameterTuningJob. | 
| create | POST /v1/{parent}/hyperparameterTuningJobsCreates a HyperparameterTuningJob | 
| delete | DELETE /v1/{name}Deletes a HyperparameterTuningJob. | 
| get | GET /v1/{name}Gets a HyperparameterTuningJob | 
| list | GET /v1/{parent}/hyperparameterTuningJobsLists HyperparameterTuningJobs in a Location. | 
REST Resource: v1.projects.locations.indexEndpoints
| Methods | |
|---|---|
| create | POST /v1/{parent}/indexEndpointsCreates an IndexEndpoint. | 
| delete | DELETE /v1/{name}Deletes an IndexEndpoint. | 
| deployIndex | POST /v1/{indexEndpoint}:deployIndexDeploys an Index into this IndexEndpoint, creating a DeployedIndex within it. | 
| get | GET /v1/{name}Gets an IndexEndpoint. | 
| list | GET /v1/{parent}/indexEndpointsLists IndexEndpoints in a Location. | 
| mutateDeployedIndex | POST /v1/{indexEndpoint}:mutateDeployedIndexUpdate an existing DeployedIndex under an IndexEndpoint. | 
| patch | PATCH /v1/{indexEndpoint.name}Updates an IndexEndpoint. | 
| undeployIndex | POST /v1/{indexEndpoint}:undeployIndexUndeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. | 
REST Resource: v1.projects.locations.indexes
| Methods | |
|---|---|
| create | POST /v1/{parent}/indexesCreates an Index. | 
| delete | DELETE /v1/{name}Deletes an Index. | 
| get | GET /v1/{name}Gets an Index. | 
| list | GET /v1/{parent}/indexesLists Indexes in a Location. | 
| patch | PATCH /v1/{index.name}Updates an Index. | 
| removeDatapoints | POST /v1/{index}:removeDatapointsRemove Datapoints from an Index. | 
| upsertDatapoints | POST /v1/{index}:upsertDatapointsAdd/update Datapoints into an Index. | 
REST Resource: v1.projects.locations.metadataStores
| Methods | |
|---|---|
| create | POST /v1/{parent}/metadataStoresInitializes a MetadataStore, including allocation of resources. | 
| delete | DELETE /v1/{name}Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). | 
| get | GET /v1/{name}Retrieves a specific MetadataStore. | 
| list | GET /v1/{parent}/metadataStoresLists MetadataStores for a Location. | 
REST Resource: v1.projects.locations.metadataStores.artifacts
| Methods | |
|---|---|
| create | POST /v1/{parent}/artifactsCreates an Artifact associated with a MetadataStore. | 
| delete | DELETE /v1/{name}Deletes an Artifact. | 
| get | GET /v1/{name}Retrieves a specific Artifact. | 
| list | GET /v1/{parent}/artifactsLists Artifacts in the MetadataStore. | 
| patch | PATCH /v1/{artifact.name}Updates a stored Artifact. | 
| purge | POST /v1/{parent}/artifacts:purgePurges Artifacts. | 
| queryArtifactLineageSubgraph | GET /v1/{artifact}:queryArtifactLineageSubgraphRetrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. | 
REST Resource: v1.projects.locations.metadataStores.contexts
| Methods | |
|---|---|
| addContextArtifactsAndExecutions | POST /v1/{context}:addContextArtifactsAndExecutionsAdds a set of Artifacts and Executions to a Context. | 
| addContextChildren | POST /v1/{context}:addContextChildrenAdds a set of Contexts as children to a parent Context. | 
| create | POST /v1/{parent}/contextsCreates a Context associated with a MetadataStore. | 
| delete | DELETE /v1/{name}Deletes a stored Context. | 
| get | GET /v1/{name}Retrieves a specific Context. | 
| list | GET /v1/{parent}/contextsLists Contexts on the MetadataStore. | 
| patch | PATCH /v1/{context.name}Updates a stored Context. | 
| purge | POST /v1/{parent}/contexts:purgePurges Contexts. | 
| queryContextLineageSubgraph | GET /v1/{context}:queryContextLineageSubgraphRetrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. | 
| removeContextChildren | POST /v1/{context}:removeContextChildrenRemove a set of children contexts from a parent Context. | 
REST Resource: v1.projects.locations.metadataStores.executions
| Methods | |
|---|---|
| addExecutionEvents | POST /v1/{execution}:addExecutionEventsAdds Events to the specified Execution. | 
| create | POST /v1/{parent}/executionsCreates an Execution associated with a MetadataStore. | 
| delete | DELETE /v1/{name}Deletes an Execution. | 
| get | GET /v1/{name}Retrieves a specific Execution. | 
| list | GET /v1/{parent}/executionsLists Executions in the MetadataStore. | 
| patch | PATCH /v1/{execution.name}Updates a stored Execution. | 
| purge | POST /v1/{parent}/executions:purgePurges Executions. | 
| queryExecutionInputsAndOutputs | GET /v1/{execution}:queryExecutionInputsAndOutputsObtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. | 
REST Resource: v1.projects.locations.metadataStores.metadataSchemas
| Methods | |
|---|---|
| create | POST /v1/{parent}/metadataSchemasCreates a MetadataSchema. | 
| get | GET /v1/{name}Retrieves a specific MetadataSchema. | 
| list | GET /v1/{parent}/metadataSchemasLists MetadataSchemas. | 
REST Resource: v1.projects.locations.migratableResources
| Methods | |
|---|---|
| batchMigrate | POST /v1/{parent}/migratableResources:batchMigrateBatch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI. | 
| search | POST /v1/{parent}/migratableResources:searchSearches 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. | 
REST Resource: v1.projects.locations.modelDeploymentMonitoringJobs
| Methods | |
|---|---|
| create | POST /v1/{parent}/modelDeploymentMonitoringJobsCreates a ModelDeploymentMonitoringJob. | 
| delete | DELETE /v1/{name}Deletes a ModelDeploymentMonitoringJob. | 
| get | GET /v1/{name}Gets a ModelDeploymentMonitoringJob. | 
| list | GET /v1/{parent}/modelDeploymentMonitoringJobsLists ModelDeploymentMonitoringJobs in a Location. | 
| patch | PATCH /v1/{modelDeploymentMonitoringJob.name}Updates a ModelDeploymentMonitoringJob. | 
| pause | POST /v1/{name}:pausePauses a ModelDeploymentMonitoringJob. | 
| resume | POST /v1/{name}:resumeResumes a paused ModelDeploymentMonitoringJob. | 
| searchModelDeploymentMonitoringStatsAnomalies | POST /v1/{modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomaliesSearches Model Monitoring Statistics generated within a given time window. | 
REST Resource: v1.projects.locations.models
| Methods | |
|---|---|
| copy | POST /v1/{parent}/models:copyCopies an already existing Vertex AI Model into the specified Location. | 
| delete | DELETE /v1/{name}Deletes a Model. | 
| deleteVersion | DELETE /v1/{name}:deleteVersionDeletes a Model version. | 
| export | POST /v1/{name}:exportExports a trained, exportable Model to a location specified by the user. | 
| get | GET /v1/{name}Gets a Model. | 
| getIamPolicy | POST /v1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1/{parent}/modelsLists Models in a Location. | 
| listCheckpoints | GET /v1/{name}:listCheckpointsLists checkpoints of the specified model version. | 
| listVersions | GET /v1/{name}:listVersionsLists versions of the specified model. | 
| mergeVersionAliases | POST /v1/{name}:mergeVersionAliasesMerges a set of aliases for a Model version. | 
| patch | PATCH /v1/{model.name}Updates a Model. | 
| setIamPolicy | POST /v1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
| updateExplanationDataset | POST /v1/{model}:updateExplanationDatasetIncrementally update the dataset used for an examples model. | 
| upload | POST /v1/{parent}/models:uploadUploads a Model artifact into Vertex AI. | 
REST Resource: v1.projects.locations.models.evaluations
| Methods | |
|---|---|
| get | GET /v1/{name}Gets a ModelEvaluation. | 
| import | POST /v1/{parent}/evaluations:importImports an externally generated ModelEvaluation. | 
| list | GET /v1/{parent}/evaluationsLists ModelEvaluations in a Model. | 
REST Resource: v1.projects.locations.models.evaluations.slices
| Methods | |
|---|---|
| batchImport | POST /v1/{parent}:batchImportImports a list of externally generated EvaluatedAnnotations. | 
| get | GET /v1/{name}Gets a ModelEvaluationSlice. | 
| list | GET /v1/{parent}/slicesLists ModelEvaluationSlices in a ModelEvaluation. | 
REST Resource: v1.projects.locations.nasJobs
| Methods | |
|---|---|
| cancel | POST /v1/{name}:cancelCancels a NasJob. | 
| create | POST /v1/{parent}/nasJobsCreates a NasJob | 
| delete | DELETE /v1/{name}Deletes a NasJob. | 
| get | GET /v1/{name}Gets a NasJob | 
| list | GET /v1/{parent}/nasJobsLists NasJobs in a Location. | 
REST Resource: v1.projects.locations.nasJobs.nasTrialDetails
| Methods | |
|---|---|
| get | GET /v1/{name}Gets a NasTrialDetail. | 
| list | GET /v1/{parent}/nasTrialDetailsList top NasTrialDetails of a NasJob. | 
REST Resource: v1.projects.locations.notebookExecutionJobs
| Methods | |
|---|---|
| create | POST /v1/{parent}/notebookExecutionJobsCreates a NotebookExecutionJob. | 
| delete | DELETE /v1/{name}Deletes a NotebookExecutionJob. | 
| get | GET /v1/{name}Gets a NotebookExecutionJob. | 
| list | GET /v1/{parent}/notebookExecutionJobsLists NotebookExecutionJobs in a Location. | 
REST Resource: v1.projects.locations.notebookRuntimeTemplates
| Methods | |
|---|---|
| create | POST /v1/{parent}/notebookRuntimeTemplatesCreates a NotebookRuntimeTemplate. | 
| delete | DELETE /v1/{name}Deletes a NotebookRuntimeTemplate. | 
| get | GET /v1/{name}Gets a NotebookRuntimeTemplate. | 
| getIamPolicy | POST /v1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1/{parent}/notebookRuntimeTemplatesLists NotebookRuntimeTemplates in a Location. | 
| patch | PATCH /v1/{notebookRuntimeTemplate.name}Updates a NotebookRuntimeTemplate. | 
| setIamPolicy | POST /v1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1.projects.locations.notebookRuntimes
| Methods | |
|---|---|
| assign | POST /v1/{parent}/notebookRuntimes:assignAssigns a NotebookRuntime to a user for a particular Notebook file. | 
| delete | DELETE /v1/{name}Deletes a NotebookRuntime. | 
| get | GET /v1/{name}Gets a NotebookRuntime. | 
| list | GET /v1/{parent}/notebookRuntimesLists NotebookRuntimes in a Location. | 
| start | POST /v1/{name}:startStarts a NotebookRuntime. | 
| stop | POST /v1/{name}:stopStops a NotebookRuntime. | 
| upgrade | POST /v1/{name}:upgradeUpgrades a NotebookRuntime. | 
REST Resource: v1.projects.locations.operations
| Methods | |
|---|---|
| cancel | POST /v1/{name}:cancelStarts asynchronous cancellation on a long-running operation. | 
| delete | DELETE /v1/{name}Deletes a long-running operation. | 
| get | GET /v1/{name}Gets the latest state of a long-running operation. | 
| list | GET /v1/{name}/operationsLists operations that match the specified filter in the request. | 
| wait | POST /v1/{name}:waitWaits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. | 
REST Resource: v1.projects.locations.persistentResources
| Methods | |
|---|---|
| create | POST /v1/{parent}/persistentResourcesCreates a PersistentResource. | 
| delete | DELETE /v1/{name}Deletes a PersistentResource. | 
| get | GET /v1/{name}Gets a PersistentResource. | 
| list | GET /v1/{parent}/persistentResourcesLists PersistentResources in a Location. | 
| patch | PATCH /v1/{persistentResource.name}Updates a PersistentResource. | 
| reboot | POST /v1/{name}:rebootReboots a PersistentResource. | 
REST Resource: v1.projects.locations.pipelineJobs
| Methods | |
|---|---|
| batchCancel | POST /v1/{parent}/pipelineJobs:batchCancelBatch cancel PipelineJobs. | 
| batchDelete | POST /v1/{parent}/pipelineJobs:batchDeleteBatch deletes PipelineJobs The Operation is atomic. | 
| cancel | POST /v1/{name}:cancelCancels a PipelineJob. | 
| create | POST /v1/{parent}/pipelineJobsCreates a PipelineJob. | 
| delete | DELETE /v1/{name}Deletes a PipelineJob. | 
| get | GET /v1/{name}Gets a PipelineJob. | 
| list | GET /v1/{parent}/pipelineJobsLists PipelineJobs in a Location. | 
REST Resource: v1.projects.locations.publishers.models
| Methods | |
|---|---|
| predict | POST /v1/{endpoint}:predictPerform an online prediction. | 
| predictLongRunning | POST /v1/{endpoint}:predictLongRunning | 
| rawPredict | POST /v1/{endpoint}:rawPredictPerform an online prediction with an arbitrary HTTP payload. | 
| serverStreamingPredict | POST /v1/{endpoint}:serverStreamingPredictPerform a server-side streaming online prediction request for Vertex LLM streaming. | 
| streamRawPredict | POST /v1/{endpoint}:streamRawPredictPerform a streaming online prediction with an arbitrary HTTP payload. | 
REST Resource: v1.projects.locations.ragCorpora
| Methods | |
|---|---|
| create | POST /v1/{parent}/ragCorporaCreates a RagCorpus. | 
| delete | DELETE /v1/{name}Deletes a RagCorpus. | 
| get | GET /v1/{name}Gets a RagCorpus. | 
| list | GET /v1/{parent}/ragCorporaLists RagCorpora in a Location. | 
| patch | PATCH /v1/{ragCorpus.name}Updates a RagCorpus. | 
REST Resource: v1.projects.locations.ragCorpora.ragFiles
| Methods | |
|---|---|
| delete | DELETE /v1/{name}Deletes a RagFile. | 
| get | GET /v1/{name}Gets a RagFile. | 
| import | POST /v1/{parent}/ragFiles:importImport files from Google Cloud Storage or Google Drive into a RagCorpus. | 
| list | GET /v1/{parent}/ragFilesLists RagFiles in a RagCorpus. | 
REST Resource: v1.projects.locations.reasoningEngines
| Methods | |
|---|---|
| create | POST /v1/{parent}/reasoningEnginesCreates a reasoning engine. | 
| delete | DELETE /v1/{name}Deletes a reasoning engine. | 
| get | GET /v1/{name}Gets a reasoning engine. | 
| list | GET /v1/{parent}/reasoningEnginesLists reasoning engines in a location. | 
| patch | PATCH /v1/{reasoningEngine.name}Updates a reasoning engine. | 
| query | POST /v1/{name}:queryQueries using a reasoning engine. | 
| streamQuery | POST /v1/{name}:streamQueryStreams queries using a reasoning engine. | 
REST Resource: v1.projects.locations.schedules
| Methods | |
|---|---|
| create | POST /v1/{parent}/schedulesCreates a Schedule. | 
| delete | DELETE /v1/{name}Deletes a Schedule. | 
| get | GET /v1/{name}Gets a Schedule. | 
| list | GET /v1/{parent}/schedulesLists Schedules in a Location. | 
| patch | PATCH /v1/{schedule.name}Updates an active or paused Schedule. | 
| pause | POST /v1/{name}:pausePauses a Schedule. | 
| resume | POST /v1/{name}:resumeResumes a paused Schedule to start scheduling new runs. | 
REST Resource: v1.projects.locations.specialistPools
| Methods | |
|---|---|
| create | POST /v1/{parent}/specialistPoolsCreates a SpecialistPool. | 
| delete | DELETE /v1/{name}Deletes a SpecialistPool as well as all Specialists in the pool. | 
| get | GET /v1/{name}Gets a SpecialistPool. | 
| list | GET /v1/{parent}/specialistPoolsLists SpecialistPools in a Location. | 
| patch | PATCH /v1/{specialistPool.name}Updates a SpecialistPool. | 
REST Resource: v1.projects.locations.studies
| Methods | |
|---|---|
| create | POST /v1/{parent}/studiesCreates a Study. | 
| delete | DELETE /v1/{name}Deletes a Study. | 
| get | GET /v1/{name}Gets a Study by name. | 
| list | GET /v1/{parent}/studiesLists all the studies in a region for an associated project. | 
| lookup | POST /v1/{parent}/studies:lookupLooks a study up using the user-defined display_name field instead of the fully qualified resource name. | 
REST Resource: v1.projects.locations.studies.trials
| Methods | |
|---|---|
| addTrialMeasurement | POST /v1/{trialName}:addTrialMeasurementAdds a measurement of the objective metrics to a Trial. | 
| checkTrialEarlyStoppingState | POST /v1/{trialName}:checkTrialEarlyStoppingStateChecks whether a Trial should stop or not. | 
| complete | POST /v1/{name}:completeMarks a Trial as complete. | 
| create | POST /v1/{parent}/trialsAdds a user provided Trial to a Study. | 
| delete | DELETE /v1/{name}Deletes a Trial. | 
| get | GET /v1/{name}Gets a Trial. | 
| list | GET /v1/{parent}/trialsLists the Trials associated with a Study. | 
| listOptimalTrials | POST /v1/{parent}/trials:listOptimalTrialsLists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. | 
| stop | POST /v1/{name}:stopStops a Trial. | 
| suggest | POST /v1/{parent}/trials:suggestAdds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. | 
REST Resource: v1.projects.locations.tensorboards
| Methods | |
|---|---|
| batchRead | GET /v1/{tensorboard}:batchReadReads multiple TensorboardTimeSeries' data. | 
| create | POST /v1/{parent}/tensorboardsCreates a Tensorboard. | 
| delete | DELETE /v1/{name}Deletes a Tensorboard. | 
| get | GET /v1/{name}Gets a Tensorboard. | 
| list | GET /v1/{parent}/tensorboardsLists Tensorboards in a Location. | 
| patch | PATCH /v1/{tensorboard.name}Updates a Tensorboard. | 
| readSize | GET /v1/{tensorboard}:readSizeReturns the storage size for a given TensorBoard instance. | 
| readUsage | GET /v1/{tensorboard}:readUsageReturns a list of monthly active users for a given TensorBoard instance. | 
REST Resource: v1.projects.locations.tensorboards.experiments
| Methods | |
|---|---|
| batchCreate | POST /v1/{parent}:batchCreateBatch create TensorboardTimeSeries that belong to a TensorboardExperiment. | 
| create | POST /v1/{parent}/experimentsCreates a TensorboardExperiment. | 
| delete | DELETE /v1/{name}Deletes a TensorboardExperiment. | 
| get | GET /v1/{name}Gets a TensorboardExperiment. | 
| list | GET /v1/{parent}/experimentsLists TensorboardExperiments in a Location. | 
| patch | PATCH /v1/{tensorboardExperiment.name}Updates a TensorboardExperiment. | 
| write | POST /v1/{tensorboardExperiment}:writeWrite time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. | 
REST Resource: v1.projects.locations.tensorboards.experiments.runs
| Methods | |
|---|---|
| batchCreate | POST /v1/{parent}/runs:batchCreateBatch create TensorboardRuns. | 
| create | POST /v1/{parent}/runsCreates a TensorboardRun. | 
| delete | DELETE /v1/{name}Deletes a TensorboardRun. | 
| get | GET /v1/{name}Gets a TensorboardRun. | 
| list | GET /v1/{parent}/runsLists TensorboardRuns in a Location. | 
| patch | PATCH /v1/{tensorboardRun.name}Updates a TensorboardRun. | 
| write | POST /v1/{tensorboardRun}:writeWrite time series data points into multiple TensorboardTimeSeries under a TensorboardRun. | 
REST Resource: v1.projects.locations.tensorboards.experiments.runs.timeSeries
| Methods | |
|---|---|
| create | POST /v1/{parent}/timeSeriesCreates a TensorboardTimeSeries. | 
| delete | DELETE /v1/{name}Deletes a TensorboardTimeSeries. | 
| exportTensorboardTimeSeries | POST /v1/{tensorboardTimeSeries}:exportTensorboardTimeSeriesExports a TensorboardTimeSeries' data. | 
| get | GET /v1/{name}Gets a TensorboardTimeSeries. | 
| list | GET /v1/{parent}/timeSeriesLists TensorboardTimeSeries in a Location. | 
| patch | PATCH /v1/{tensorboardTimeSeries.name}Updates a TensorboardTimeSeries. | 
| read | GET /v1/{tensorboardTimeSeries}:readReads a TensorboardTimeSeries' data. | 
| readBlobData | GET /v1/{timeSeries}:readBlobDataGets bytes of TensorboardBlobs. | 
REST Resource: v1.projects.locations.trainingPipelines
| Methods | |
|---|---|
| cancel | POST /v1/{name}:cancelCancels a TrainingPipeline. | 
| create | POST /v1/{parent}/trainingPipelinesCreates a TrainingPipeline. | 
| delete | DELETE /v1/{name}Deletes a TrainingPipeline. | 
| get | GET /v1/{name}Gets a TrainingPipeline. | 
| list | GET /v1/{parent}/trainingPipelinesLists TrainingPipelines in a Location. | 
REST Resource: v1.projects.locations.tuningJobs
| Methods | |
|---|---|
| cancel | POST /v1/{name}:cancelCancels a TuningJob. | 
| create | POST /v1/{parent}/tuningJobsCreates a TuningJob. | 
| get | GET /v1/{name}Gets a TuningJob. | 
| list | GET /v1/{parent}/tuningJobsLists TuningJobs in a Location. | 
| rebaseTunedModel | POST /v1/{parent}/tuningJobs:rebaseTunedModelRebase a TunedModel. | 
REST Resource: v1.publishers.models
| Methods | |
|---|---|
| get | GET /v1/{name}Gets a Model Garden publisher model. | 
REST Resource: v1beta1.media
| Methods | |
|---|---|
| upload | POST /v1beta1/{parent}/ragFiles:uploadPOST /upload/v1beta1/{parent}/ragFiles:uploadUpload a file into a RagCorpus. | 
REST Resource: v1beta1.projects
| Methods | |
|---|---|
| fetchPublisherModelConfig | GET /v1beta1/{name}:fetchPublisherModelConfigFetches the configs of publisher models. | 
| setPublisherModelConfig | POST /v1beta1/{name}:setPublisherModelConfigSets (creates or updates) configs of publisher models. | 
REST Resource: v1beta1.projects.locations
| Methods | |
|---|---|
| augmentPrompt | POST /v1beta1/{parent}:augmentPromptGiven an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses. | 
| corroborateContent | POST /v1beta1/{parent}:corroborateContentGiven an input text, it returns a score that evaluates the factuality of the text. | 
| deploy | POST /v1beta1/{destination}:deployDeploys a model to a new endpoint. | 
| deployPublisherModel  | POST /v1beta1/{destination}:deployPublisherModelDeploys publisher models. | 
| evaluateDataset | POST /v1beta1/{location}:evaluateDatasetEvaluates a dataset based on a set of given metrics. | 
| evaluateInstances | POST /v1beta1/{location}:evaluateInstancesEvaluates instances based on a given metric. | 
| getRagEngineConfig | GET /v1beta1/{name}Gets a RagEngineConfig. | 
| recommendSpec | POST /v1beta1/{parent}:recommendSpecGets a Model's spec recommendations. | 
| retrieveContexts | POST /v1beta1/{parent}:retrieveContextsRetrieves relevant contexts for a query. | 
| updateRagEngineConfig | PATCH /v1beta1/{ragEngineConfig.name}Updates a RagEngineConfig. | 
REST Resource: v1beta1.projects.locations.batchPredictionJobs
| Methods | |
|---|---|
| cancel | POST /v1beta1/{name}:cancelCancels a BatchPredictionJob. | 
| create | POST /v1beta1/{parent}/batchPredictionJobsCreates a BatchPredictionJob. | 
| delete | DELETE /v1beta1/{name}Deletes a BatchPredictionJob. | 
| get | GET /v1beta1/{name}Gets a BatchPredictionJob | 
| list | GET /v1beta1/{parent}/batchPredictionJobsLists BatchPredictionJobs in a Location. | 
REST Resource: v1beta1.projects.locations.cachedContents
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/cachedContentsCreates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage. | 
| delete | DELETE /v1beta1/{name}Deletes cached content | 
| get | GET /v1beta1/{name}Gets cached content configurations | 
| list | GET /v1beta1/{parent}/cachedContentsLists cached contents in a project | 
| patch | PATCH /v1beta1/{cachedContent.name}Updates cached content configurations | 
REST Resource: v1beta1.projects.locations.customJobs
| Methods | |
|---|---|
| cancel | POST /v1beta1/{name}:cancelCancels a CustomJob. | 
| create | POST /v1beta1/{parent}/customJobsCreates a CustomJob. | 
| delete | DELETE /v1beta1/{name}Deletes a CustomJob. | 
| get | GET /v1beta1/{name}Gets a CustomJob. | 
| list | GET /v1beta1/{parent}/customJobsLists CustomJobs in a Location. | 
REST Resource: v1beta1.projects.locations.datasets
| Methods | |
|---|---|
| assemble | POST /v1beta1/{name}:assembleAssembles each row of a multimodal dataset and writes the result into a BigQuery table. | 
| assess | POST /v1beta1/{name}:assessAssesses the state or validity of the dataset with respect to a given use case. | 
| create | POST /v1beta1/{parent}/datasetsCreates a Dataset. | 
| delete | DELETE /v1beta1/{name}Deletes a Dataset. | 
| export | POST /v1beta1/{name}:exportExports data from a Dataset. | 
| get | GET /v1beta1/{name}Gets a Dataset. | 
| import | POST /v1beta1/{name}:importImports data into a Dataset. | 
| list | GET /v1beta1/{parent}/datasetsLists Datasets in a Location. | 
| patch | PATCH /v1beta1/{dataset.name}Updates a Dataset. | 
| searchDataItems | GET /v1beta1/{dataset}:searchDataItemsSearches DataItems in a Dataset. | 
REST Resource: v1beta1.projects.locations.datasets.annotationSpecs
| Methods | |
|---|---|
| get | GET /v1beta1/{name}Gets an AnnotationSpec. | 
REST Resource: v1beta1.projects.locations.datasets.dataItems
| Methods | |
|---|---|
| list | GET /v1beta1/{parent}/dataItemsLists DataItems in a Dataset. | 
REST Resource: v1beta1.projects.locations.datasets.dataItems.annotations
| Methods | |
|---|---|
| list | GET /v1beta1/{parent}/annotationsLists Annotations belongs to a dataitem. | 
REST Resource: v1beta1.projects.locations.datasets.datasetVersions
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/datasetVersionsCreate a version from a Dataset. | 
| delete | DELETE /v1beta1/{name}Deletes a Dataset version. | 
| get | GET /v1beta1/{name}Gets a Dataset version. | 
| list | GET /v1beta1/{parent}/datasetVersionsLists DatasetVersions in a Dataset. | 
| patch | PATCH /v1beta1/{datasetVersion.name}Updates a DatasetVersion. | 
| restore | GET /v1beta1/{name}:restoreRestores a dataset version. | 
REST Resource: v1beta1.projects.locations.datasets.savedQueries
| Methods | |
|---|---|
| delete | DELETE /v1beta1/{name}Deletes a SavedQuery. | 
| list | GET /v1beta1/{parent}/savedQueriesLists SavedQueries in a Dataset. | 
REST Resource: v1beta1.projects.locations.deploymentResourcePools
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/deploymentResourcePoolsCreate a DeploymentResourcePool. | 
| delete | DELETE /v1beta1/{name}Delete a DeploymentResourcePool. | 
| get | GET /v1beta1/{name}Get a DeploymentResourcePool. | 
| list | GET /v1beta1/{parent}/deploymentResourcePoolsList DeploymentResourcePools in a location. | 
| patch | PATCH /v1beta1/{deploymentResourcePool.name}Update a DeploymentResourcePool. | 
| queryDeployedModels | GET /v1beta1/{deploymentResourcePool}:queryDeployedModelsList DeployedModels that have been deployed on this DeploymentResourcePool. | 
REST Resource: v1beta1.projects.locations.endpoints
| Methods | |
|---|---|
| countTokens | POST /v1beta1/{endpoint}:countTokensPerform a token counting. | 
| create | POST /v1beta1/{parent}/endpointsCreates an Endpoint. | 
| delete | DELETE /v1beta1/{name}Deletes an Endpoint. | 
| deployModel | POST /v1beta1/{endpoint}:deployModelDeploys a Model into this Endpoint, creating a DeployedModel within it. | 
| directPredict | POST /v1beta1/{endpoint}:directPredictPerform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks. | 
| directRawPredict | POST /v1beta1/{endpoint}:directRawPredictPerform an unary online prediction request to a gRPC model server for custom containers. | 
| explain | POST /v1beta1/{endpoint}:explainPerform an online explanation. | 
| get | GET /v1beta1/{name}Gets an Endpoint. | 
| getIamPolicy | POST /v1beta1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1beta1/{parent}/endpointsLists Endpoints in a Location. | 
| mutateDeployedModel | POST /v1beta1/{endpoint}:mutateDeployedModelUpdates an existing deployed model. | 
| patch | PATCH /v1beta1/{endpoint.name}Updates an Endpoint. | 
| predict | POST /v1beta1/{endpoint}:predictPerform an online prediction. | 
| rawPredict | POST /v1beta1/{endpoint}:rawPredictPerform an online prediction with an arbitrary HTTP payload. | 
| serverStreamingPredict | POST /v1beta1/{endpoint}:serverStreamingPredictPerform a server-side streaming online prediction request for Vertex LLM streaming. | 
| setIamPolicy | POST /v1beta1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| streamRawPredict | POST /v1beta1/{endpoint}:streamRawPredictPerform a streaming online prediction with an arbitrary HTTP payload. | 
| testIamPermissions | POST /v1beta1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
| undeployModel | POST /v1beta1/{endpoint}:undeployModelUndeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. | 
| update | POST /v1beta1/{endpoint.name}:updateUpdates an Endpoint with a long running operation. | 
REST Resource: v1beta1.projects.locations.endpoints.chat
| Methods | |
|---|---|
| completions | POST /v1beta1/{endpoint}/chat/completionsExposes an OpenAI-compatible endpoint for chat completions. | 
REST Resource: v1beta1.projects.locations.exampleStores
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/exampleStoresCreate an ExampleStore. | 
| delete | DELETE /v1beta1/{name}Delete an ExampleStore. | 
| fetchExamples | POST /v1beta1/{exampleStore}:fetchExamplesGet Examples from the Example Store. | 
| get | GET /v1beta1/{name}Get an ExampleStore. | 
| list | GET /v1beta1/{parent}/exampleStoresList ExampleStores in a Location. | 
| patch | PATCH /v1beta1/{exampleStore.name}Update an ExampleStore. | 
| removeExamples | POST /v1beta1/{exampleStore}:removeExamplesRemove Examples from the Example Store. | 
| searchExamples | POST /v1beta1/{exampleStore}:searchExamplesSearch for similar Examples for given selection criteria. | 
| upsertExamples | POST /v1beta1/{exampleStore}:upsertExamplesCreate or update Examples in the Example Store. | 
REST Resource: v1beta1.projects.locations.extensions
| Methods | |
|---|---|
| delete | DELETE /v1beta1/{name}Deletes an Extension. | 
| execute | POST /v1beta1/{name}:executeExecutes the request against a given extension. | 
| get | GET /v1beta1/{name}Gets an Extension. | 
| import | POST /v1beta1/{parent}/extensions:importImports an Extension. | 
| list | GET /v1beta1/{parent}/extensionsLists Extensions in a location. | 
| patch | PATCH /v1beta1/{extension.name}Updates an Extension. | 
| query | POST /v1beta1/{name}:queryQueries an extension with a default controller. | 
REST Resource: v1beta1.projects.locations.featureGroups
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/featureGroupsCreates a new FeatureGroup in a given project and location. | 
| delete | DELETE /v1beta1/{name}Deletes a single FeatureGroup. | 
| get | GET /v1beta1/{name}Gets details of a single FeatureGroup. | 
| getIamPolicy | POST /v1beta1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1beta1/{parent}/featureGroupsLists FeatureGroups in a given project and location. | 
| patch | PATCH /v1beta1/{featureGroup.name}Updates the parameters of a single FeatureGroup. | 
| setIamPolicy | POST /v1beta1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1beta1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1beta1.projects.locations.featureGroups.featureMonitors
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/featureMonitorsCreates a new FeatureMonitor in a given project, location and FeatureGroup. | 
| delete | DELETE /v1beta1/{name}Deletes a single FeatureMonitor. | 
| get | GET /v1beta1/{name}Gets details of a single FeatureMonitor. | 
| list | GET /v1beta1/{parent}/featureMonitorsLists FeatureGroups in a given project and location. | 
| patch | PATCH /v1beta1/{featureMonitor.name}Updates the parameters of a single FeatureMonitor. | 
REST Resource: v1beta1.projects.locations.featureGroups.featureMonitors.featureMonitorJobs
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/featureMonitorJobsCreates a new feature monitor job. | 
| get | GET /v1beta1/{name}Get a feature monitor job. | 
| list | GET /v1beta1/{parent}/featureMonitorJobsList feature monitor jobs. | 
REST Resource: v1beta1.projects.locations.featureGroups.features
| Methods | |
|---|---|
| batchCreate | POST /v1beta1/{parent}/features:batchCreateCreates a batch of Features in a given FeatureGroup. | 
| create | POST /v1beta1/{parent}/featuresCreates a new Feature in a given FeatureGroup. | 
| delete | DELETE /v1beta1/{name}Deletes a single Feature. | 
| get | GET /v1beta1/{name}Gets details of a single Feature. | 
| list | GET /v1beta1/{parent}/featuresLists Features in a given FeatureGroup. | 
| patch | PATCH /v1beta1/{feature.name}Updates the parameters of a single Feature. | 
REST Resource: v1beta1.projects.locations.featureOnlineStores
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/featureOnlineStoresCreates a new FeatureOnlineStore in a given project and location. | 
| delete | DELETE /v1beta1/{name}Deletes a single FeatureOnlineStore. | 
| get | GET /v1beta1/{name}Gets details of a single FeatureOnlineStore. | 
| getIamPolicy | POST /v1beta1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1beta1/{parent}/featureOnlineStoresLists FeatureOnlineStores in a given project and location. | 
| patch | PATCH /v1beta1/{featureOnlineStore.name}Updates the parameters of a single FeatureOnlineStore. | 
| setIamPolicy | POST /v1beta1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1beta1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1beta1.projects.locations.featureOnlineStores.featureViews
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/featureViewsCreates a new FeatureView in a given FeatureOnlineStore. | 
| delete | DELETE /v1beta1/{name}Deletes a single FeatureView. | 
| directWrite | POST /v1beta1/{featureView}:directWriteBidirectional streaming RPC to directly write to feature values in a feature view. | 
| fetchFeatureValues | POST /v1beta1/{featureView}:fetchFeatureValuesFetch feature values under a FeatureView. | 
| get | GET /v1beta1/{name}Gets details of a single FeatureView. | 
| getIamPolicy | POST /v1beta1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1beta1/{parent}/featureViewsLists FeatureViews in a given FeatureOnlineStore. | 
| patch | PATCH /v1beta1/{featureView.name}Updates the parameters of a single FeatureView. | 
| searchNearestEntities | POST /v1beta1/{featureView}:searchNearestEntitiesSearch the nearest entities under a FeatureView. | 
| setIamPolicy | POST /v1beta1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| streamingFetchFeatureValues | POST /v1beta1/{featureView}:streamingFetchFeatureValuesBidirectional streaming RPC to fetch feature values under a FeatureView. | 
| sync | POST /v1beta1/{featureView}:syncTriggers on-demand sync for the FeatureView. | 
| testIamPermissions | POST /v1beta1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1beta1.projects.locations.featureOnlineStores.featureViews.featureViewSyncs
| Methods | |
|---|---|
| get | GET /v1beta1/{name}Gets details of a single FeatureViewSync. | 
| list | GET /v1beta1/{parent}/featureViewSyncsLists FeatureViewSyncs in a given FeatureView. | 
REST Resource: v1beta1.projects.locations.featurestores
| Methods | |
|---|---|
| batchReadFeatureValues | POST /v1beta1/{featurestore}:batchReadFeatureValuesBatch reads Feature values from a Featurestore. | 
| create | POST /v1beta1/{parent}/featurestoresCreates a new Featurestore in a given project and location. | 
| delete | DELETE /v1beta1/{name}Deletes a single Featurestore. | 
| get | GET /v1beta1/{name}Gets details of a single Featurestore. | 
| getIamPolicy | POST /v1beta1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1beta1/{parent}/featurestoresLists Featurestores in a given project and location. | 
| patch | PATCH /v1beta1/{featurestore.name}Updates the parameters of a single Featurestore. | 
| searchFeatures | GET /v1beta1/{location}/featurestores:searchFeaturesSearches Features matching a query in a given project. | 
| setIamPolicy | POST /v1beta1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1beta1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1beta1.projects.locations.featurestores.entityTypes
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/entityTypesCreates a new EntityType in a given Featurestore. | 
| delete | DELETE /v1beta1/{name}Deletes a single EntityType. | 
| deleteFeatureValues | POST /v1beta1/{entityType}:deleteFeatureValuesDelete Feature values from Featurestore. | 
| exportFeatureValues | POST /v1beta1/{entityType}:exportFeatureValuesExports Feature values from all the entities of a target EntityType. | 
| get | GET /v1beta1/{name}Gets details of a single EntityType. | 
| getIamPolicy | POST /v1beta1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| importFeatureValues | POST /v1beta1/{entityType}:importFeatureValuesImports Feature values into the Featurestore from a source storage. | 
| list | GET /v1beta1/{parent}/entityTypesLists EntityTypes in a given Featurestore. | 
| patch | PATCH /v1beta1/{entityType.name}Updates the parameters of a single EntityType. | 
| readFeatureValues | POST /v1beta1/{entityType}:readFeatureValuesReads Feature values of a specific entity of an EntityType. | 
| setIamPolicy | POST /v1beta1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| streamingReadFeatureValues | POST /v1beta1/{entityType}:streamingReadFeatureValuesReads Feature values for multiple entities. | 
| testIamPermissions | POST /v1beta1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
| writeFeatureValues | POST /v1beta1/{entityType}:writeFeatureValuesWrites Feature values of one or more entities of an EntityType. | 
REST Resource: v1beta1.projects.locations.featurestores.entityTypes.features
| Methods | |
|---|---|
| batchCreate | POST /v1beta1/{parent}/features:batchCreateCreates a batch of Features in a given EntityType. | 
| create | POST /v1beta1/{parent}/featuresCreates a new Feature in a given EntityType. | 
| delete | DELETE /v1beta1/{name}Deletes a single Feature. | 
| get | GET /v1beta1/{name}Gets details of a single Feature. | 
| list | GET /v1beta1/{parent}/featuresLists Features in a given EntityType. | 
| patch | PATCH /v1beta1/{feature.name}Updates the parameters of a single Feature. | 
REST Resource: v1beta1.projects.locations.hyperparameterTuningJobs
| Methods | |
|---|---|
| cancel | POST /v1beta1/{name}:cancelCancels a HyperparameterTuningJob. | 
| create | POST /v1beta1/{parent}/hyperparameterTuningJobsCreates a HyperparameterTuningJob | 
| delete | DELETE /v1beta1/{name}Deletes a HyperparameterTuningJob. | 
| get | GET /v1beta1/{name}Gets a HyperparameterTuningJob | 
| list | GET /v1beta1/{parent}/hyperparameterTuningJobsLists HyperparameterTuningJobs in a Location. | 
REST Resource: v1beta1.projects.locations.indexEndpoints
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/indexEndpointsCreates an IndexEndpoint. | 
| delete | DELETE /v1beta1/{name}Deletes an IndexEndpoint. | 
| deployIndex | POST /v1beta1/{indexEndpoint}:deployIndexDeploys an Index into this IndexEndpoint, creating a DeployedIndex within it. | 
| get | GET /v1beta1/{name}Gets an IndexEndpoint. | 
| list | GET /v1beta1/{parent}/indexEndpointsLists IndexEndpoints in a Location. | 
| mutateDeployedIndex | POST /v1beta1/{indexEndpoint}:mutateDeployedIndexUpdate an existing DeployedIndex under an IndexEndpoint. | 
| patch | PATCH /v1beta1/{indexEndpoint.name}Updates an IndexEndpoint. | 
| undeployIndex | POST /v1beta1/{indexEndpoint}:undeployIndexUndeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. | 
REST Resource: v1beta1.projects.locations.indexes
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/indexesCreates an Index. | 
| delete | DELETE /v1beta1/{name}Deletes an Index. | 
| get | GET /v1beta1/{name}Gets an Index. | 
| import | POST /v1beta1/{name}:importImports an Index from an external source (e.g., BigQuery). | 
| list | GET /v1beta1/{parent}/indexesLists Indexes in a Location. | 
| patch | PATCH /v1beta1/{index.name}Updates an Index. | 
| removeDatapoints | POST /v1beta1/{index}:removeDatapointsRemove Datapoints from an Index. | 
| upsertDatapoints | POST /v1beta1/{index}:upsertDatapointsAdd/update Datapoints into an Index. | 
REST Resource: v1beta1.projects.locations.metadataStores
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/metadataStoresInitializes a MetadataStore, including allocation of resources. | 
| delete | DELETE /v1beta1/{name}Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). | 
| get | GET /v1beta1/{name}Retrieves a specific MetadataStore. | 
| list | GET /v1beta1/{parent}/metadataStoresLists MetadataStores for a Location. | 
REST Resource: v1beta1.projects.locations.metadataStores.artifacts
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/artifactsCreates an Artifact associated with a MetadataStore. | 
| delete | DELETE /v1beta1/{name}Deletes an Artifact. | 
| get | GET /v1beta1/{name}Retrieves a specific Artifact. | 
| list | GET /v1beta1/{parent}/artifactsLists Artifacts in the MetadataStore. | 
| patch | PATCH /v1beta1/{artifact.name}Updates a stored Artifact. | 
| purge | POST /v1beta1/{parent}/artifacts:purgePurges Artifacts. | 
| queryArtifactLineageSubgraph | GET /v1beta1/{artifact}:queryArtifactLineageSubgraphRetrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. | 
REST Resource: v1beta1.projects.locations.metadataStores.contexts
| Methods | |
|---|---|
| addContextArtifactsAndExecutions | POST /v1beta1/{context}:addContextArtifactsAndExecutionsAdds a set of Artifacts and Executions to a Context. | 
| addContextChildren | POST /v1beta1/{context}:addContextChildrenAdds a set of Contexts as children to a parent Context. | 
| create | POST /v1beta1/{parent}/contextsCreates a Context associated with a MetadataStore. | 
| delete | DELETE /v1beta1/{name}Deletes a stored Context. | 
| get | GET /v1beta1/{name}Retrieves a specific Context. | 
| list | GET /v1beta1/{parent}/contextsLists Contexts on the MetadataStore. | 
| patch | PATCH /v1beta1/{context.name}Updates a stored Context. | 
| purge | POST /v1beta1/{parent}/contexts:purgePurges Contexts. | 
| queryContextLineageSubgraph | GET /v1beta1/{context}:queryContextLineageSubgraphRetrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. | 
| removeContextChildren | POST /v1beta1/{context}:removeContextChildrenRemove a set of children contexts from a parent Context. | 
REST Resource: v1beta1.projects.locations.metadataStores.executions
| Methods | |
|---|---|
| addExecutionEvents | POST /v1beta1/{execution}:addExecutionEventsAdds Events to the specified Execution. | 
| create | POST /v1beta1/{parent}/executionsCreates an Execution associated with a MetadataStore. | 
| delete | DELETE /v1beta1/{name}Deletes an Execution. | 
| get | GET /v1beta1/{name}Retrieves a specific Execution. | 
| list | GET /v1beta1/{parent}/executionsLists Executions in the MetadataStore. | 
| patch | PATCH /v1beta1/{execution.name}Updates a stored Execution. | 
| purge | POST /v1beta1/{parent}/executions:purgePurges Executions. | 
| queryExecutionInputsAndOutputs | GET /v1beta1/{execution}:queryExecutionInputsAndOutputsObtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. | 
REST Resource: v1beta1.projects.locations.metadataStores.metadataSchemas
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/metadataSchemasCreates a MetadataSchema. | 
| get | GET /v1beta1/{name}Retrieves a specific MetadataSchema. | 
| list | GET /v1beta1/{parent}/metadataSchemasLists MetadataSchemas. | 
REST Resource: v1beta1.projects.locations.migratableResources
| Methods | |
|---|---|
| batchMigrate | POST /v1beta1/{parent}/migratableResources:batchMigrateBatch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI. | 
| search | POST /v1beta1/{parent}/migratableResources:searchSearches 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. | 
REST Resource: v1beta1.projects.locations.modelDeploymentMonitoringJobs
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/modelDeploymentMonitoringJobsCreates a ModelDeploymentMonitoringJob. | 
| delete | DELETE /v1beta1/{name}Deletes a ModelDeploymentMonitoringJob. | 
| get | GET /v1beta1/{name}Gets a ModelDeploymentMonitoringJob. | 
| list | GET /v1beta1/{parent}/modelDeploymentMonitoringJobsLists ModelDeploymentMonitoringJobs in a Location. | 
| patch | PATCH /v1beta1/{modelDeploymentMonitoringJob.name}Updates a ModelDeploymentMonitoringJob. | 
| pause | POST /v1beta1/{name}:pausePauses a ModelDeploymentMonitoringJob. | 
| resume | POST /v1beta1/{name}:resumeResumes a paused ModelDeploymentMonitoringJob. | 
| searchModelDeploymentMonitoringStatsAnomalies | POST /v1beta1/{modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomaliesSearches Model Monitoring Statistics generated within a given time window. | 
REST Resource: v1beta1.projects.locations.modelMonitors
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/modelMonitorsCreates a ModelMonitor. | 
| delete | DELETE /v1beta1/{name}Deletes a ModelMonitor. | 
| get | GET /v1beta1/{name}Gets a ModelMonitor. | 
| list | GET /v1beta1/{parent}/modelMonitorsLists ModelMonitors in a Location. | 
| patch | PATCH /v1beta1/{modelMonitor.name}Updates a ModelMonitor. | 
| searchModelMonitoringAlerts | POST /v1beta1/{modelMonitor}:searchModelMonitoringAlertsReturns the Model Monitoring alerts. | 
| searchModelMonitoringStats | POST /v1beta1/{modelMonitor}:searchModelMonitoringStatsSearches Model Monitoring Stats generated within a given time window. | 
REST Resource: v1beta1.projects.locations.modelMonitors.modelMonitoringJobs
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/modelMonitoringJobsCreates a ModelMonitoringJob. | 
| delete | DELETE /v1beta1/{name}Deletes a ModelMonitoringJob. | 
| get | GET /v1beta1/{name}Gets a ModelMonitoringJob. | 
| list | GET /v1beta1/{parent}/modelMonitoringJobsLists ModelMonitoringJobs. | 
REST Resource: v1beta1.projects.locations.models
| Methods | |
|---|---|
| copy | POST /v1beta1/{parent}/models:copyCopies an already existing Vertex AI Model into the specified Location. | 
| delete | DELETE /v1beta1/{name}Deletes a Model. | 
| deleteVersion | DELETE /v1beta1/{name}:deleteVersionDeletes a Model version. | 
| export | POST /v1beta1/{name}:exportExports a trained, exportable Model to a location specified by the user. | 
| get | GET /v1beta1/{name}Gets a Model. | 
| getIamPolicy | POST /v1beta1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1beta1/{parent}/modelsLists Models in a Location. | 
| listCheckpoints | GET /v1beta1/{name}:listCheckpointsLists checkpoints of the specified model version. | 
| listVersions | GET /v1beta1/{name}:listVersionsLists versions of the specified model. | 
| mergeVersionAliases | POST /v1beta1/{name}:mergeVersionAliasesMerges a set of aliases for a Model version. | 
| patch | PATCH /v1beta1/{model.name}Updates a Model. | 
| setIamPolicy | POST /v1beta1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1beta1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
| updateExplanationDataset | POST /v1beta1/{model}:updateExplanationDatasetIncrementally update the dataset used for an examples model. | 
| upload | POST /v1beta1/{parent}/models:uploadUploads a Model artifact into Vertex AI. | 
REST Resource: v1beta1.projects.locations.models.evaluations
| Methods | |
|---|---|
| get | GET /v1beta1/{name}Gets a ModelEvaluation. | 
| import | POST /v1beta1/{parent}/evaluations:importImports an externally generated ModelEvaluation. | 
| list | GET /v1beta1/{parent}/evaluationsLists ModelEvaluations in a Model. | 
REST Resource: v1beta1.projects.locations.models.evaluations.slices
| Methods | |
|---|---|
| batchImport | POST /v1beta1/{parent}:batchImportImports a list of externally generated EvaluatedAnnotations. | 
| get | GET /v1beta1/{name}Gets a ModelEvaluationSlice. | 
| list | GET /v1beta1/{parent}/slicesLists ModelEvaluationSlices in a ModelEvaluation. | 
REST Resource: v1beta1.projects.locations.notebookExecutionJobs
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/notebookExecutionJobsCreates a NotebookExecutionJob. | 
| delete | DELETE /v1beta1/{name}Deletes a NotebookExecutionJob. | 
| get | GET /v1beta1/{name}Gets a NotebookExecutionJob. | 
| list | GET /v1beta1/{parent}/notebookExecutionJobsLists NotebookExecutionJobs in a Location. | 
REST Resource: v1beta1.projects.locations.notebookRuntimeTemplates
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/notebookRuntimeTemplatesCreates a NotebookRuntimeTemplate. | 
| delete | DELETE /v1beta1/{name}Deletes a NotebookRuntimeTemplate. | 
| get | GET /v1beta1/{name}Gets a NotebookRuntimeTemplate. | 
| getIamPolicy | POST /v1beta1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1beta1/{parent}/notebookRuntimeTemplatesLists NotebookRuntimeTemplates in a Location. | 
| patch | PATCH /v1beta1/{notebookRuntimeTemplate.name}Updates a NotebookRuntimeTemplate. | 
| setIamPolicy | POST /v1beta1/{resource}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1beta1/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1beta1.projects.locations.notebookRuntimes
| Methods | |
|---|---|
| assign | POST /v1beta1/{parent}/notebookRuntimes:assignAssigns a NotebookRuntime to a user for a particular Notebook file. | 
| delete | DELETE /v1beta1/{name}Deletes a NotebookRuntime. | 
| get | GET /v1beta1/{name}Gets a NotebookRuntime. | 
| list | GET /v1beta1/{parent}/notebookRuntimesLists NotebookRuntimes in a Location. | 
| start | POST /v1beta1/{name}:startStarts a NotebookRuntime. | 
| stop | POST /v1beta1/{name}:stopStops a NotebookRuntime. | 
| upgrade | POST /v1beta1/{name}:upgradeUpgrades a NotebookRuntime. | 
REST Resource: v1beta1.projects.locations.operations
| Methods | |
|---|---|
| cancel | POST /v1beta1/{name}:cancelStarts asynchronous cancellation on a long-running operation. | 
| delete | DELETE /v1beta1/{name}Deletes a long-running operation. | 
| get | GET /v1beta1/{name}Gets the latest state of a long-running operation. | 
| list | GET /v1beta1/{name}/operationsLists operations that match the specified filter in the request. | 
| wait | POST /v1beta1/{name}:waitWaits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. | 
REST Resource: v1beta1.projects.locations.persistentResources
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/persistentResourcesCreates a PersistentResource. | 
| delete | DELETE /v1beta1/{name}Deletes a PersistentResource. | 
| get | GET /v1beta1/{name}Gets a PersistentResource. | 
| list | GET /v1beta1/{parent}/persistentResourcesLists PersistentResources in a Location. | 
| patch | PATCH /v1beta1/{persistentResource.name}Updates a PersistentResource. | 
| reboot | POST /v1beta1/{name}:rebootReboots a PersistentResource. | 
REST Resource: v1beta1.projects.locations.pipelineJobs
| Methods | |
|---|---|
| batchCancel | POST /v1beta1/{parent}/pipelineJobs:batchCancelBatch cancel PipelineJobs. | 
| batchDelete | POST /v1beta1/{parent}/pipelineJobs:batchDeleteBatch deletes PipelineJobs The Operation is atomic. | 
| cancel | POST /v1beta1/{name}:cancelCancels a PipelineJob. | 
| create | POST /v1beta1/{parent}/pipelineJobsCreates a PipelineJob. | 
| delete | DELETE /v1beta1/{name}Deletes a PipelineJob. | 
| get | GET /v1beta1/{name}Gets a PipelineJob. | 
| list | GET /v1beta1/{parent}/pipelineJobsLists PipelineJobs in a Location. | 
REST Resource: v1beta1.projects.locations.publishers.models
| Methods | |
|---|---|
| countTokens | POST /v1beta1/{endpoint}:countTokensPerform a token counting. | 
| export | POST /v1beta1/{parent}/{name}:exportExports a publisher model to a user provided Google Cloud Storage bucket. | 
| fetchPublisherModelConfig | GET /v1beta1/{name}:fetchPublisherModelConfigFetches the configs of publisher models. | 
| getIamPolicy | POST /v1beta1/{resource}:getIamPolicyGets the access control policy for a resource. | 
| predict | POST /v1beta1/{endpoint}:predictPerform an online prediction. | 
| rawPredict | POST /v1beta1/{endpoint}:rawPredictPerform an online prediction with an arbitrary HTTP payload. | 
| serverStreamingPredict | POST /v1beta1/{endpoint}:serverStreamingPredictPerform a server-side streaming online prediction request for Vertex LLM streaming. | 
| setPublisherModelConfig | POST /v1beta1/{name}:setPublisherModelConfigSets (creates or updates) configs of publisher models. | 
| streamRawPredict | POST /v1beta1/{endpoint}:streamRawPredictPerform a streaming online prediction with an arbitrary HTTP payload. | 
REST Resource: v1beta1.projects.locations.ragCorpora
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/ragCorporaCreates a RagCorpus. | 
| delete | DELETE /v1beta1/{name}Deletes a RagCorpus. | 
| get | GET /v1beta1/{name}Gets a RagCorpus. | 
| list | GET /v1beta1/{parent}/ragCorporaLists RagCorpora in a Location. | 
| patch | PATCH /v1beta1/{ragCorpus.name}Updates a RagCorpus. | 
REST Resource: v1beta1.projects.locations.ragCorpora.ragFiles
| Methods | |
|---|---|
| delete | DELETE /v1beta1/{name}Deletes a RagFile. | 
| get | GET /v1beta1/{name}Gets a RagFile. | 
| import | POST /v1beta1/{parent}/ragFiles:importImport files from Google Cloud Storage or Google Drive into a RagCorpus. | 
| list | GET /v1beta1/{parent}/ragFilesLists RagFiles in a RagCorpus. | 
REST Resource: v1beta1.projects.locations.reasoningEngines
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/reasoningEnginesCreates a reasoning engine. | 
| delete | DELETE /v1beta1/{name}Deletes a reasoning engine. | 
| get | GET /v1beta1/{name}Gets a reasoning engine. | 
| list | GET /v1beta1/{parent}/reasoningEnginesLists reasoning engines in a location. | 
| patch | PATCH /v1beta1/{reasoningEngine.name}Updates a reasoning engine. | 
| query | POST /v1beta1/{name}:queryQueries using a reasoning engine. | 
| streamQuery | POST /v1beta1/{name}:streamQueryStreams queries using a reasoning engine. | 
REST Resource: v1beta1.projects.locations.reasoningEngines.memories
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/memoriesCreate a Memory. | 
| delete | DELETE /v1beta1/{name}Delete a Memory. | 
| generate | POST /v1beta1/{parent}/memories:generateGenerate memories. | 
| get | GET /v1beta1/{name}Get a Memory. | 
| list | GET /v1beta1/{parent}/memoriesList Memories. | 
| patch | PATCH /v1beta1/{memory.name}Update a Memory. | 
| retrieve | POST /v1beta1/{parent}/memories:retrieveRetrieve memories. | 
REST Resource: v1beta1.projects.locations.reasoningEngines.sessions
| Methods | |
|---|---|
| appendEvent | POST /v1beta1/{name}:appendEventAppends an event to a given session. | 
| create | POST /v1beta1/{parent}/sessionsCreates a new Session. | 
| delete | DELETE /v1beta1/{name}Deletes details of the specific Session. | 
| get | GET /v1beta1/{name}Gets details of the specific Session. | 
| list | GET /v1beta1/{parent}/sessionsLists Sessionsin a given reasoning engine. | 
| patch | PATCH /v1beta1/{session.name}Updates the specific Session. | 
REST Resource: v1beta1.projects.locations.reasoningEngines.sessions.events
| Methods | |
|---|---|
| list | GET /v1beta1/{parent}/eventsLists Eventsin a given session. | 
REST Resource: v1beta1.projects.locations.schedules
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/schedulesCreates a Schedule. | 
| delete | DELETE /v1beta1/{name}Deletes a Schedule. | 
| get | GET /v1beta1/{name}Gets a Schedule. | 
| list | GET /v1beta1/{parent}/schedulesLists Schedules in a Location. | 
| patch | PATCH /v1beta1/{schedule.name}Updates an active or paused Schedule. | 
| pause | POST /v1beta1/{name}:pausePauses a Schedule. | 
| resume | POST /v1beta1/{name}:resumeResumes a paused Schedule to start scheduling new runs. | 
REST Resource: v1beta1.projects.locations.specialistPools
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/specialistPoolsCreates a SpecialistPool. | 
| delete | DELETE /v1beta1/{name}Deletes a SpecialistPool as well as all Specialists in the pool. | 
| get | GET /v1beta1/{name}Gets a SpecialistPool. | 
| list | GET /v1beta1/{parent}/specialistPoolsLists SpecialistPools in a Location. | 
| patch | PATCH /v1beta1/{specialistPool.name}Updates a SpecialistPool. | 
REST Resource: v1beta1.projects.locations.studies
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/studiesCreates a Study. | 
| delete | DELETE /v1beta1/{name}Deletes a Study. | 
| get | GET /v1beta1/{name}Gets a Study by name. | 
| list | GET /v1beta1/{parent}/studiesLists all the studies in a region for an associated project. | 
| lookup | POST /v1beta1/{parent}/studies:lookupLooks a study up using the user-defined display_name field instead of the fully qualified resource name. | 
REST Resource: v1beta1.projects.locations.studies.trials
| Methods | |
|---|---|
| addTrialMeasurement | POST /v1beta1/{trialName}:addTrialMeasurementAdds a measurement of the objective metrics to a Trial. | 
| checkTrialEarlyStoppingState | POST /v1beta1/{trialName}:checkTrialEarlyStoppingStateChecks whether a Trial should stop or not. | 
| complete | POST /v1beta1/{name}:completeMarks a Trial as complete. | 
| create | POST /v1beta1/{parent}/trialsAdds a user provided Trial to a Study. | 
| delete | DELETE /v1beta1/{name}Deletes a Trial. | 
| get | GET /v1beta1/{name}Gets a Trial. | 
| list | GET /v1beta1/{parent}/trialsLists the Trials associated with a Study. | 
| listOptimalTrials | POST /v1beta1/{parent}/trials:listOptimalTrialsLists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. | 
| stop | POST /v1beta1/{name}:stopStops a Trial. | 
| suggest | POST /v1beta1/{parent}/trials:suggestAdds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. | 
REST Resource: v1beta1.projects.locations.tensorboards
| Methods | |
|---|---|
| batchRead | GET /v1beta1/{tensorboard}:batchReadReads multiple TensorboardTimeSeries' data. | 
| create | POST /v1beta1/{parent}/tensorboardsCreates a Tensorboard. | 
| delete | DELETE /v1beta1/{name}Deletes a Tensorboard. | 
| get | GET /v1beta1/{name}Gets a Tensorboard. | 
| list | GET /v1beta1/{parent}/tensorboardsLists Tensorboards in a Location. | 
| patch | PATCH /v1beta1/{tensorboard.name}Updates a Tensorboard. | 
| readSize | GET /v1beta1/{tensorboard}:readSizeReturns the storage size for a given TensorBoard instance. | 
| readUsage | GET /v1beta1/{tensorboard}:readUsageReturns a list of monthly active users for a given TensorBoard instance. | 
REST Resource: v1beta1.projects.locations.tensorboards.experiments
| Methods | |
|---|---|
| batchCreate | POST /v1beta1/{parent}:batchCreateBatch create TensorboardTimeSeries that belong to a TensorboardExperiment. | 
| create | POST /v1beta1/{parent}/experimentsCreates a TensorboardExperiment. | 
| delete | DELETE /v1beta1/{name}Deletes a TensorboardExperiment. | 
| get | GET /v1beta1/{name}Gets a TensorboardExperiment. | 
| list | GET /v1beta1/{parent}/experimentsLists TensorboardExperiments in a Location. | 
| patch | PATCH /v1beta1/{tensorboardExperiment.name}Updates a TensorboardExperiment. | 
| write | POST /v1beta1/{tensorboardExperiment}:writeWrite time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. | 
REST Resource: v1beta1.projects.locations.tensorboards.experiments.runs
| Methods | |
|---|---|
| batchCreate | POST /v1beta1/{parent}/runs:batchCreateBatch create TensorboardRuns. | 
| create | POST /v1beta1/{parent}/runsCreates a TensorboardRun. | 
| delete | DELETE /v1beta1/{name}Deletes a TensorboardRun. | 
| get | GET /v1beta1/{name}Gets a TensorboardRun. | 
| list | GET /v1beta1/{parent}/runsLists TensorboardRuns in a Location. | 
| patch | PATCH /v1beta1/{tensorboardRun.name}Updates a TensorboardRun. | 
| write | POST /v1beta1/{tensorboardRun}:writeWrite time series data points into multiple TensorboardTimeSeries under a TensorboardRun. | 
REST Resource: v1beta1.projects.locations.tensorboards.experiments.runs.timeSeries
| Methods | |
|---|---|
| create | POST /v1beta1/{parent}/timeSeriesCreates a TensorboardTimeSeries. | 
| delete | DELETE /v1beta1/{name}Deletes a TensorboardTimeSeries. | 
| exportTensorboardTimeSeries | POST /v1beta1/{tensorboardTimeSeries}:exportTensorboardTimeSeriesExports a TensorboardTimeSeries' data. | 
| get | GET /v1beta1/{name}Gets a TensorboardTimeSeries. | 
| list | GET /v1beta1/{parent}/timeSeriesLists TensorboardTimeSeries in a Location. | 
| patch | PATCH /v1beta1/{tensorboardTimeSeries.name}Updates a TensorboardTimeSeries. | 
| read | GET /v1beta1/{tensorboardTimeSeries}:readReads a TensorboardTimeSeries' data. | 
| readBlobData | GET /v1beta1/{timeSeries}:readBlobDataGets bytes of TensorboardBlobs. | 
REST Resource: v1beta1.projects.locations.trainingPipelines
| Methods | |
|---|---|
| cancel | POST /v1beta1/{name}:cancelCancels a TrainingPipeline. | 
| create | POST /v1beta1/{parent}/trainingPipelinesCreates a TrainingPipeline. | 
| delete | DELETE /v1beta1/{name}Deletes a TrainingPipeline. | 
| get | GET /v1beta1/{name}Gets a TrainingPipeline. | 
| list | GET /v1beta1/{parent}/trainingPipelinesLists TrainingPipelines in a Location. | 
REST Resource: v1beta1.projects.locations.tuningJobs
| Methods | |
|---|---|
| cancel | POST /v1beta1/{name}:cancelCancels a TuningJob. | 
| create | POST /v1beta1/{parent}/tuningJobsCreates a TuningJob. | 
| get | GET /v1beta1/{name}Gets a TuningJob. | 
| list | GET /v1beta1/{parent}/tuningJobsLists TuningJobs in a Location. | 
| rebaseTunedModel | POST /v1beta1/{parent}/tuningJobs:rebaseTunedModelRebase a TunedModel. | 
REST Resource: v1beta1.projects.modelGardenEula
| Methods | |
|---|---|
| accept | POST /v1beta1/{parent}/modelGardenEula:acceptAccepts the EULA acceptance status of a publisher model. | 
| check | POST /v1beta1/{parent}/modelGardenEula:checkChecks the EULA acceptance status of a publisher model. | 
REST Resource: v1beta1.publishers.models
| Methods | |
|---|---|
| get | GET /v1beta1/{name}Gets a Model Garden publisher model. | 
| list | GET /v1beta1/{parent}/modelsLists publisher models in Model Garden. |