システムスキーマ

各メタデータリソースは、特定の MetadataSchema に関連付けられます。メタデータリソースの作成プロセスを簡素化するために、Vertex ML Metadata では、一般的な ML のコンセプトに対応するシステムスキーマという事前定義のタイプを公開しています。システムスキーマは名前空間 system に存在します。システムスキーマは、Vertex ML Metadata API の MetadataSchema リソースとしてアクセスできます。スキーマは常にバージョニングされます。システムスキーマの形式は OpenAPI 3.0 仕様のサブセットです。

システムスキーマの使用方法

Vertex AI は、システムスキーマを使用して ML ワークフローを追跡するメタデータリソースを作成します。その後、schema_title フィールドを使用して、メタデータフィールド内のリソースをフィルタリングしてグループ化できます。フィルタ関数の使用方法については、Vertex ML Metadata の分析をご覧ください。

また、Vertex ML Metadata API でシステムスキーマを使用して、メタデータリソースを直接作成することもできます。システムスキーマは、スキーマタイトルとスキーマバージョンによって識別できます。システムスキーマ内のフィールドは常にオプションとみなされます。システムスキーマの事前定義フィールドに制限されることはなく、任意のメタデータを任意のメタデータリソースに記録できます。システムスキーマを使用してメタデータリソースを作成する方法については、Vertex ML Metadata の追跡をご覧ください。

スキーマを一覧表示する

既存のすべての登録済みスキーマのリストを表示するには、次のコマンドを使用します。

REST

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

LOCATION_ID: 使用するリージョン。
PROJECT_ID: 実際のプロジェクト ID。

HTTP メソッドと URL:

GET https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/metadataStores/default/metadataSchemas?pageSize=100&filter=schema_title=%22system*%22+OR+schema_title=%22google*%22

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

curl（Linux、macOS、Cloud Shell）

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

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

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    "https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/metadataStores/default/metadataSchemas?pageSize=100&filter=schema_title=%22system*%22+OR+schema_title=%22google*%22"

PowerShell（Windows）

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

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/metadataStores/default/metadataSchemas?pageSize=100&filter=schema_title=%22system*%22+OR+schema_title=%22google*%22" | Select-Object -Expand Content

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

{
  "metadataSchemas": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION_ID/metadataStores/default/metadataSchemas/system-resolver-execution-v0-0-1",
      "schemaVersion": "0.0.1",
      "schema": "title: system.ResolverExecution\ntype: object\n",
      "schemaType": "EXECUTION_TYPE",
      "createTime": "2022-07-27T17:41:35.634Z"
    },
    {
      "name": "projects/PROJECT_ID/locations/LOCATION_ID//metadataStores/default/metadataSchemas/system-html-v0-0-1",
      "schemaVersion": "0.0.1",
      "schema": "title: system.HTML\ntype: object\n",
      "schemaType": "ARTIFACT_TYPE",
      "createTime": "2022-07-27T17:41:35.602Z"
    }
}

厳密なスキーママッチング

Vertex ML Metadata は、スキーマ作成者が厳密なスキーママッチングを適用できる 2 つのフラグをサポートしています。

additionalProperties

additionalProperties の値は true または false です。JSON スキーマに合わせて、additionalProperties はデフォルトで true に設定されています。このフラグは、スキーマの最上位に設定されます。false に設定した場合は、省略可能なプロパティは使用できません。たとえば、次のスキーマの場合、このスキーマに基づくメタデータで payload_format と container_format フィールドのみがサポートされます。

title: system.Dataset
version: 0.0.1
type: object
additionalProperties: false
properties:
  container_format:
    type: string
  payload_format:
    type: string

上記のスキーマは、次のメタデータを受け入れます。

fields {
  key: 'container_format'
  value: { string_value: 'Text' }
}
fields {
  key: 'payload_format'
  value: { string_value: 'CSV' }
}

ただし、次のメタデータは拒否されます。

fields {
  key: 'container_format'
  value: { string_value: 'Text' }
}
fields {
  key: 'payload_format'
  value: { string_value: 'CSV' }
}
fields {
  key: 'optional_field'
  value: { string_value: 'optional_value' }
}

required

required キーワードには、0 個以上の文字列の配列を指定します。JSON スキーマにより、properties キーワードで定義されたプロパティは不要です。required キーワードを使用して、必須プロパティのリストを指定できます。たとえば、次のスキーマには常に container_format が必要です。ネストされたプロパティでも機能します。たとえば、次のように container_format は必須になります。

title: system.Dataset
version: 0.0.1
type: object
required: ['container_format']
properties:
  container_format:
    type: string
  payload_format:
    type: string

上記のスキーマは、次のメタデータを受け入れます。

fields {
  key: 'container_format'
  value: { string_value: 'Text' }
}

ただし、次のメタデータは拒否されます。

fields {
  key: 'payload_format'
  value: { string_value: 'CSV' }
}

スキーマは、オブジェクト型のフィールドを持つネストされたプロパティをサポートします。ネストされたスキーマでは、ネストされたプロパティノードに required キーワードを含めることができます。次に例を示します。

title: system.Dataset
version: 0.0.1
type: object
properties:
  container_format:
    type: string
  payload:
    type: string
  nested_property:
    type: object
    required: ['property_1']
    properties:
      property_1:
        type: integer
      property_2:
        type: integer

上記のスキーマは、nested_property フィールド自体が不要なため、次のメタデータを受け入れます。

fields {
  key: 'container_format'
  value: { string_value: 'Text' }
}

以下のメタデータも有効です。

fields {
  key: 'nested_property'
  value: {
    struct_value {
      fields {
        key: 'property_1'
        value: { number_value: 1 }
      }
      fields {
        key: 'property_2'
        value: { number_value: 1 }
      }
    }
  }
}

ただし、次のメタデータは拒否されます。

fields {
  key: 'nested_property'
  value: {
    struct_value {
      fields {
        key: 'property_2'
        value: { number_value: 1 }
      }
    }
  }
}