特徴値を削除する

特徴値は、次の方法でエンティティタイプから削除できます。

指定したエンティティから特徴値を削除する
ある時間範囲で指定した特徴の特徴値を削除する

指定したエンティティから特徴値を削除する

特徴値は、エンティティタイプ内の複数のエンティティから削除できます。特徴値を削除するエンティティを指定するには、エンティティ ID を CSV ファイルにリストアップする必要があります。

REST

特徴値を削除するには、featurestores.entityTypes.deleteFeatureValues メソッドを使用して POST リクエストを送信します。

リクエストのデータを使用する前に、次のように置き換えます。

LOCATION_ID: featurestore が作成されるリージョンまたはロケーション。例: us-central1
PROJECT_ID: 実際のプロジェクト ID。
FEATURESTORE_ID: featurestore の ID。
ENTITY_TYPE: 特徴値を削除するエンティティタイプの ID。
CSV_FILE_URI: 特徴値を削除するエンティティ ID を含む CSV ファイルの Cloud Storage URI を指定します。このファイルの最初の行は、次のいずれかにする必要があります。
- entity_id_field パラメータを指定する場合、CSV ファイルの 1 行目は ENTITY_ID_FIELD と同じでなければなりません。
- entity_id_field パラメータを指定しない場合、CSV ファイルの 1 行目は「entity_id」でなければなりません。
ENTITY_ID_FIELD: （省略可）CSV_FILE_URI には、CSV ファイルの 1 行目で指定された文字列を入力します。

HTTP メソッドと URL:

POST https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/featurestores/FEATURESTORE_ID/entityTypes/ENTITY_TYPE:deleteFeatureValues

リクエストの本文（JSON）:

{
  "selectEntity": {
    "entityIdSelector": {
      "csv_source": {
        "gcs_source": {
          "uris": [
            "CSV_FILE_URI"
          ]
        },
        "entity_id_field": "ENTITY_ID_FIELD"
      }
    }
  }
}

リクエストを送信するには、次のいずれかのオプションを選択します。

curl

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザーアカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/featurestores/FEATURESTORE_ID/entityTypes/ENTITY_TYPE:deleteFeatureValues"

PowerShell

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザーアカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

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

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/featurestores/FEATURESTORE_ID/entityTypes/ENTITY_TYPE:deleteFeatureValues" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/571445526053/locations/us-central1/operations/7688824614775947264",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.aiplatform.v1.DeleteFeatureValuesOperationMetadata",
    "genericMetadata": {
      "createTime": "2022-05-09T16:59:38.128375Z",
      "updateTime": "2022-05-09T16:59:38.128375Z",
      "state": "RUNNING",
      "worksOn": [
        "projects/PROJECT_ID/locations/LOCATION_ID/featurestores/FEATURESTORE_ID/entityTypes/ENTITY_TYPE_ID"
      ]
    }
  }
}

申請のステータスを表示する

POST リクエストのステータスを確認するには、次の GET リクエストを送信します。

リクエストのデータを使用する前に、次のように置き換えます。

LOCATION_ID: featurestore が作成されるリージョンまたはロケーション。例: us-central1
OPERATION_NAME: 特徴値を削除する POST リクエストから受信した JSON レスポンスにある「name」フィールドの値。

HTTP メソッドと URL:

GET https://LOCATION_ID-aiplatform.googleapis.com/v1/OPERATION_NAME

リクエストを送信するには、次のいずれかのオプションを選択します。

curl

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION_ID-aiplatform.googleapis.com/v1/OPERATION_NAME"

PowerShell

次のコマンドを実行します。

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION_ID-aiplatform.googleapis.com/v1/OPERATION_NAME" | Select-Object -Expand Content

成功を示すステータスコード（2xx）と空のレスポンスが返されます。

ある時間範囲で指定した特徴の特徴値を削除する

エンティティタイプから特徴値を削除するには、特徴 ID と時間範囲を指定します。

REST

エンティティタイプで特徴値を削除するには、featurestores.entityTypes.deleteFeatureValues メソッドを使用して POST リクエストを送信します。

リクエストのデータを使用する前に、次のように置き換えます。

LOCATION_ID: featurestore が作成されるリージョンまたはロケーション。例: us-central1
PROJECT_ID: 実際のプロジェクト ID。
FEATURESTORE_ID: featurestore の ID。
ENTITY_TYPE: 特徴値を削除するエンティティタイプの ID。
START_TIME: 時間範囲の開始時間を指定します。
END_TIME: （省略可）時間範囲の終了時間を指定します。

注: END_TIME を指定せずに START_TIME を指定すると、指定された特徴 ID の特徴値が、現在時刻（リクエストが送信された時刻）まで削除されます。
SKIP_ONLINE_STORAGE_DELETE: （省略可）オンラインストレージとオフラインストレージから特徴値を削除するには、「false」と入力します。また、オフラインストレージからのみ特徴値を削除するには、「true」と入力します。

HTTP メソッドと URL:

POST https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/featurestores/FEATURESTORE_ID/entityTypes/ENTITY_TYPE:deleteFeatureValues

リクエストの本文（JSON）:

{
  "selectTimeRangeAndFeature": {
    "timeRange": {
      "startTime": "START_TIME",
      "endTime": "END_TIME"
    },
    "featureSelector": {
      "idMatcher": {
        "ids": [ "FEATURE_ID", ...]
      }
    },
    "skipOnlineStorageDelete": SKIP_ONLINE_STORAGE_DELETE
  }
}

リクエストを送信するには、次のいずれかのオプションを選択します。

curl

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/featurestores/FEATURESTORE_ID/entityTypes/ENTITY_TYPE:deleteFeatureValues"

PowerShell

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

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

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/featurestores/FEATURESTORE_ID/entityTypes/ENTITY_TYPE:deleteFeatureValues" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/571445526053/locations/us-central1/operations/7688824614775947264",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.aiplatform.v1.DeleteFeatureValuesOperationMetadata",
    "genericMetadata": {
      "createTime": "2022-05-09T16:59:38.128375Z",
      "updateTime": "2022-05-09T16:59:38.128375Z",
      "state": "RUNNING",
      "worksOn": [
        "projects/PROJECT_ID/locations/LOCATION_ID/featurestores/FEATURESTORE_ID/entityTypes/ENTITY_TYPE_ID"
      ]
    }
  }
}

申請のステータスを表示する

POST リクエストのステータスを確認するには、次の GET リクエストを送信します。

リクエストのデータを使用する前に、次のように置き換えます。

LOCATION_ID: featurestore が作成されるリージョンまたはロケーション。例: us-central1
OPERATION_NAME: 特徴値を削除する POST リクエストから受信した JSON レスポンスにある「name」フィールドの値。

HTTP メソッドと URL:

GET https://LOCATION_ID-aiplatform.googleapis.com/v1/OPERATION_NAME

リクエストを送信するには、次のいずれかのオプションを選択します。

curl

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION_ID-aiplatform.googleapis.com/v1/OPERATION_NAME"

PowerShell

次のコマンドを実行します。

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION_ID-aiplatform.googleapis.com/v1/OPERATION_NAME" | Select-Object -Expand Content

成功を示すステータスコード（2xx）と空のレスポンスが返されます。

次のステップ

Vertex AI Feature Store の割り当てと上限を確認する。