Manage engine versions

This page shows you how to manage AML AI engine versions. An engine is used to control the architecture or setting for training and running a model. It is a read-only resource.

For more information on engine versions, see Engine versions.

Before you begin

  • To get the permissions that you need to manage engine versions, ask your administrator to grant you the Financial Services Admin (financialservices.admin) IAM role on your project. For more information about granting roles, see Manage access.

    You might also be able to get the required permissions through custom roles or other predefined roles.

  • Create an instance

List the engine versions

To list the engine versions, use the projects.locations.instances.engineVersions.list method.

Before using any of the request data, make the following replacements:

  • PROJECT_ID: your Google Cloud project ID listed in the IAM Settings
  • LOCATION: the location of the instance; use one of the supported regions:
    • us-central1
    • us-east1
    • asia-south1
    • europe-west1
    • europe-west2
    • europe-west4
    • northamerica-northeast1
    • southamerica-east1
  • INSTANCE_ID: the user-defined identifier for the instance

To send your request, choose one of these options:

curl

Execute the following command:

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions"

PowerShell

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "engineVersions": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions/finserv-aml.live-with-data-validation.v1.1.2022-05",
      "state": "ACTIVE",
      "expectedLimitationStartTime": EXPECTED_LIMITATION_START_TIME,
      "expectedDecommissionTime": "EXPECTED_DECOMMISSION_TIME,
      "lineOfBusiness": "RETAIL"
    },
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions/finserv-aml.live.v1.1.2022-05",
      "state": "ACTIVE",
      "expectedLimitationStartTime": EXPECTED_LIMITATION_START_TIME,
      "expectedDecommissionTime": "EXPECTED_DECOMMISSION_TIME,
      "lineOfBusiness": "RETAIL"
    }
  ]
}

Get an engine version

To get an engine version, use the projects.locations.instances.engineVersions.get method.

Before using any of the request data, make the following replacements:

  • PROJECT_ID: your Google Cloud project ID listed in the IAM Settings
  • LOCATION: the location of the instance; use one of the supported regions:
    • us-central1
    • us-east1
    • asia-south1
    • europe-west1
    • europe-west2
    • europe-west4
    • northamerica-northeast1
    • southamerica-east1
  • INSTANCE_ID: the user-defined identifier for the instance
  • ENGINE_VERSION_ID: the identifier for the engine version

To send your request, choose one of these options:

curl

Execute the following command:

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions/ENGINE_VERSION_ID"

PowerShell

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions/ENGINE_VERSION_ID" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions/ENGINE_VERSION_ID",
  "state": "ACTIVE",
  "expectedLimitationStartTime": EXPECTED_LIMITATION_START_TIME,
  "expectedDecommissionTime": "EXPECTED_DECOMMISSION_TIME,
  "lineOfBusiness": "RETAIL"
}