ProjectsLocationsModels
class ProjectsLocationsModels extends Resource (View source)
The "models" collection of methods.
Typical usage is:
$aiplatformService = new Google\Service\Aiplatform(...);
$models = $aiplatformService->projects_locations_models;
Methods
Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region- agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible. (models.copy)
Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.
Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.
Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format. (models.export)
Gets a Model. (models.get)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (models.getIamPolicy)
Lists Models in a Location. (models.listProjectsLocationsModels)
Lists versions of the specified model. (models.listVersions)
Merges a set of aliases for a Model version. (models.mergeVersionAliases)
Updates a Model. (models.patch)
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and
PERMISSION_DENIED
errors. (models.setIamPolicy)
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of permissions, not a
NOT_FOUND
error. Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization checking.
Incrementally update the dataset used for an examples model.
Uploads a Model artifact into Vertex AI. (models.upload)
Details
GoogleLongrunningOperation
copy(string $parent, GoogleCloudAiplatformV1CopyModelRequest $postBody, array $optParams = [])
Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region- agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible. (models.copy)
GoogleLongrunningOperation
delete(string $name, array $optParams = [])
Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.
(models.delete)
GoogleLongrunningOperation
deleteVersion(string $name, array $optParams = [])
Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.
(models.deleteVersion)
GoogleLongrunningOperation
export(string $name, GoogleCloudAiplatformV1ExportModelRequest $postBody, array $optParams = [])
Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format. (models.export)
GoogleCloudAiplatformV1Model
get(string $name, array $optParams = [])
Gets a Model. (models.get)
GoogleIamV1Policy
getIamPolicy(string $resource, array $optParams = [])
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (models.getIamPolicy)
GoogleCloudAiplatformV1ListModelsResponse
listProjectsLocationsModels(string $parent, array $optParams = [])
Lists Models in a Location. (models.listProjectsLocationsModels)
GoogleCloudAiplatformV1ListModelVersionsResponse
listVersions(string $name, array $optParams = [])
Lists versions of the specified model. (models.listVersions)
GoogleCloudAiplatformV1Model
mergeVersionAliases(string $name, GoogleCloudAiplatformV1MergeVersionAliasesRequest $postBody, array $optParams = [])
Merges a set of aliases for a Model version. (models.mergeVersionAliases)
GoogleCloudAiplatformV1Model
patch(string $name, GoogleCloudAiplatformV1Model $postBody, array $optParams = [])
Updates a Model. (models.patch)
GoogleIamV1Policy
setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and
PERMISSION_DENIED
errors. (models.setIamPolicy)
GoogleIamV1TestIamPermissionsResponse
testIamPermissions(string $resource, array $optParams = [])
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of permissions, not a
NOT_FOUND
error. Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization checking.
This operation may "fail open" without warning. (models.testIamPermissions)
GoogleLongrunningOperation
updateExplanationDataset(string $model, GoogleCloudAiplatformV1UpdateExplanationDatasetRequest $postBody, array $optParams = [])
Incrementally update the dataset used for an examples model.
(models.updateExplanationDataset)
GoogleLongrunningOperation
upload(string $parent, GoogleCloudAiplatformV1UploadModelRequest $postBody, array $optParams = [])
Uploads a Model artifact into Vertex AI. (models.upload)