Creazione e utilizzo di schemi personalizzati

Oltre agli schemi di sistema predefiniti, Vertex ML Metadata fornisce un modello dei dati estensibile tramite schemi personalizzati. Gli schemi personalizzati sono MetadataSchema definiti dall'utente. Utilizza gli schemi personalizzati per digitare le proprietà dei metadati e eseguire query sulle risorse in base allo schema, ad esempio "elenca tutti gli artefatti di tipo MyCustomModel.

Per definire uno schema personalizzato, devi creare una risorsa MetadataSchema all'interno di uno specifico MetadataStore che descriva lo schema previsto. Il formato dello schema è un sottoinsieme della specifica OpenAPI 3.0{class: external}, con la limitazione che lo schema di primo livello deve essere di tipo object. Tutti i tipi di dati supportati da OpenAPI 3.0 (ad esempio, numero intero, numero, stringa, booleano, array, oggetto) sono supportati come proprietà di questo oggetto schema di primo livello. Ogni campo nella sezione delle proprietà può essere assegnato a un solo tipo di dati. I tipi misti non sono supportati. Non sono supportati requisiti avanzati per i dati, come i formati minimo, massimo, multiplo e stringa.

Come registrare schemi personalizzati

La procedura per creare uno schema MetadataSchema personalizzato è simile alla creazione di nuove risorse di metadati. Le seguenti istruzioni mostrano come creare un codice metadataSchema di esempio. I metadatiSchemas hanno come ambito solo l'archivio metadati associato.

REST

Prima di utilizzare i dati della richiesta, effettua le seguenti sostituzioni:

  • LOCATION_ID: la regione del tuo MetadataStore.
  • PROJECT_ID: l'ID o numero del progetto.
  • METADATA_STORE: l'ID dell'archivio di metadati in cui viene creato lo schema MetadataSchema. L'archivio di metadati predefinito è denominato default. A meno che non sia richiesto un nuovo MetadataStore, puoi usare quello predefinito.
  • METADATA_SCHEMA_ID: (facoltativo) l'ID del record MetadataSchema. Se l'ID non è specificato, Vertex ML Metadata crea un identificatore univoco per questo MetadataSchema.
  • METADATA_SCHEMA_TITLE: il titolo dello schema che descrive il campo dei metadati. Il titolo dello schema deve rispettare il formato ".". Lo spazio dei nomi deve iniziare con una lettera minuscola, può contenere caratteri minuscoli e numeri e può avere una lunghezza compresa tra 2 e venti caratteri. Il nome dello schema deve iniziare con una lettera maiuscola, può includere lettere e numeri e può contenere da due a quaranta caratteri.
  • (Facoltativo) METADATA_SCHEMA_VERSION: la versione dello schema che descrive il campo dei metadati. schema_version deve essere una stringa di tre numeri separati da punti, ad esempio 1.0.0, 1.0.1. Questo formato consente di ordinare e confrontare le versioni.
  • METADATA_SCHEMA_TYPE: il tipo di risorsa di metadati a cui si applica lo schema creato. I tipi sono: ARTIFACT_TYPE, EXECUTION_TYPE o CONTEXT_TYPE.
  • METADATA_SCHEMA: lo schema dettagliato da creare.
  • DESCRIPTION: (facoltativo) una stringa leggibile che descrive lo scopo dell'esecuzione da creare.
  • ARTIFACT_ID: (facoltativo) l'ID del record di artefatto. Se l'ID artefatto non è specificato, Vertex ML Metadata crea un identificatore univoco per questo artefatto.
  • DISPLAY_NAME: (facoltativo) il nome dell'elemento definito dall'utente.

Metodo HTTP e URL: 

POST http://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/metadataStores/METADATA_STOREmetadataSchemas?metadata_schema_id=METADATA_SCHEMA_ID

Corpo JSON della richiesta: 

{
    "schemaVersion": "0.0.1",
    "schema": "title: test.Experiment\ntype: object",
    "schemaType": "CONTEXT_TYPE",
}

Per inviare la richiesta, espandi una di queste opzioni:

Dovresti vedere un output simile al seguente. Puoi utilizzare METADATA_SCHEMA_ID è l'ID del record MetadataSchema.

{
  "name": "projects/PROJECT_ID/locations/LOCATION_ID/metadataStores/METADATA_STORE/metadataSchemas/METADATA_SCHEMA_ID",
  "schemaVersion": "0.0.1",
  "schema": "title: test.Experiment\ntype: object",
  "schemaType": "CONTEXT_TYPE",
  "createTime": "2021-04-06T05:24:04.575481815Z"
}

Le chiamate successive per creare, ottenere o elencare gli artefatti possono quindi fare riferimento a questo schema specificando il nome (demo.Artifact) nel campo schema_title e la versione (0.0.1) nel schema_version della risorsa Artifact. Per ulteriori informazioni su come creare, recuperare o elencare le risorse di metadati, consulta Monitorare i metadati Vertex ML.

Versione degli schemi

Tutte le risorse MetadataSchema vengono sottoposte al controllo delle versioni. Un utente può creare uno schema che utilizza lo stesso schema_title di un altro schema, ma schema_version diversa. Per creare una risorsa metadataSchema con una versione diversa, un utente può fornire un numero di versione e un contenuto dello schema modificati.

L'esempio seguente crea una versione 0.0.2 dello schema demo.Artifact:

sample_schema_versioned = aip.MetadataSchema()
sample_schema_versioned.schema_type = aip.MetadataSchema.MetadataSchemaType.ARTIFACT_TYPE
sample_schema_versioned.schema ="title: demo.Artifact\ntype: object\nproperties:\n  framework:\n    type: string\n    description: \"The framework type\"\n  model_version:\n    type: integer\n    description: \"The version of the model\""
sample_schema_versioned.schema_version = "0.0.2"
sample_schema_versioned.description = "sample schema 2"

store_client.create_metadata_schema(parent=metadata_store.name, metadata_schema=sample_schema_versioned)

I campi dello schema sono sempre considerati facoltativi, pertanto non esiste compatibilità con le versioni precedenti o future tra le versioni dello stesso schema_title. Gli utenti possono comunque utilizzare schema_title per filtrare e raggruppare le risorse per l'analisi. Per ulteriori informazioni su come utilizzare le funzioni di filtro, consulta Analisi dei metadati di Vertex ML.

Passaggi successivi