Mettre à jour un schéma

Vous pouvez mettre à jour les données structurées du schéma et les données non structurées avec des métadonnées compatibles avec un schéma.

Vous pouvez mettre à jour le schéma dans la console Google Cloud ou à l'aide de la méthode d'API schemas.patch.

Pour mettre à jour le schéma, vous pouvez ajouter des champs, modifier les annotations "indexable", "searchable" et "retrievable" d'un champ, ou marquer un champ comme propriété de clé, par exemple title, uri et description.

Mettre à jour votre schéma

Vous pouvez mettre à jour votre schéma dans la console Google Cloud ou à l'aide de l'API.

Console

Pour mettre à jour un schéma dans la console Google Cloud , procédez comme suit :

  1. Consultez la section Exigences et limites pour vérifier que la mise à jour de votre schéma est valide.

  2. Si vous mettez à jour des annotations de champ (en définissant des champs comme indexables, récupérables, utilisables comme attributs dynamiques, consultables ou complétables), consultez Configurer les paramètres de champ pour connaître les limites et les exigences de chaque type d'annotation.

  3. Vérifiez que vous avez terminé l'ingestion des données. Sinon, il est possible que le schéma ne soit pas encore disponible pour modification.

  4. Dans la console Google Cloud , accédez à la page Gemini Enterprise.

    Gemini Enterprise

  5. Dans le menu de navigation, cliquez sur Datastores.

  6. Dans la colonne Nom, cliquez sur le data store contenant le schéma que vous souhaitez mettre à jour.

  7. Cliquez sur l'onglet Schéma pour afficher le schéma de vos données.

    Cet onglet peut être vide si c'est la première fois que vous modifiez les champs.

  8. Cliquez sur le bouton Modifier.

  9. Mettez à jour votre schéma :

    • Mapper les propriétés de clé : dans la colonne Propriétés de clé de votre schéma, sélectionnez une propriété de clé à laquelle mapper un champ. Par exemple, si un champ appelé details contient toujours la description d'un document, mappez ce champ à la propriété de clé Description.

    • Mettre à jour le nombre de dimensions (avancé) : vous pouvez modifier ce paramètre si vous utilisez des embeddings vectoriels personnalisés avec Gemini Enterprise. Consultez Utiliser des embeddings personnalisés dans la documentation Agent Search.

    • Mettre à jour les annotations de champ : pour mettre à jour les annotations d'un champ, sélectionnez ou désélectionnez le paramètre d'annotation d'un champ. Les annotations disponibles sont Récupérable, Indexable, Ajout d'attributs dynamique, Inclus dans l'index de recherche et Complétable. Certains paramètres de champ sont limités. Consultez Configurer les paramètres des champs pour obtenir une description et les exigences de chaque type d'annotation.

    • Ajouter un champ : l'ajout de champs à votre schéma avant d'importer de nouveaux documents contenant ces champs peut réduire le temps nécessaire à Gemini Enterprise pour réindexer vos données après l'importation.

      1. Cliquez sur Ajouter des champs pour développer cette section.

      2. Cliquez sur add_box Ajouter un nœud et spécifiez les paramètres du nouveau champ.

        Pour indiquer un tableau, définissez Tableau sur Oui. Par exemple, pour ajouter un tableau de chaînes, définissez type sur string et Array sur Yes.

  10. Cliquez sur Enregistrer pour appliquer les modifications apportées au schéma.

    La modification du schéma déclenche la réindexation. Pour les datastores volumineux, la réindexation peut prendre plusieurs heures.

REST

Pour utiliser l'API afin de mettre à jour votre schéma, procédez comme suit :

  1. Consultez les sections Exigences et limites et Exemples de limites (REST uniquement) pour vérifier que vos modifications de schéma sont valides.

    Pour mettre à jour le schéma des datastores contenant des données non structurées avec des métadonnées, passez à l'étape 5 pour appeler la méthode schema.patch.

  2. Si vous mettez à jour des annotations de champ (en définissant des champs comme indexables, récupérables, utilisables comme attributs dynamiques ou consultables), consultez Configurer les paramètres de champ pour connaître les limites et les exigences de chaque type d'annotation.

  3. Si vous modifiez un schéma détecté automatiquement, assurez-vous d'avoir terminé l'ingestion des données. Sinon, il est possible que le schéma ne soit pas encore disponible pour modification.

  4. Recherchez l'ID de votre data store. Si vous disposez déjà de l'ID de votre data store, passez à l'étape suivante.

    1. Dans la console Google Cloud , accédez à la page Gemini Enterprise et cliquez sur Datastores dans le menu de navigation.

      Accéder à la page "Datastores"

    2. Cliquez sur le nom de votre datastore.

    3. Sur la page Données de votre datastore, obtenez l'ID du datastore.

  5. Utilisez la méthode d'API schemas.patch pour fournir votre nouveau schéma JSON en tant qu'objet JSON.

    curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/schemas/default_schema" \
    -d '{
      "structSchema": JSON_SCHEMA_OBJECT
    }'
    

    Remplacez les éléments suivants :

    • PROJECT_ID : par l'ID du projet.
    • DATA_STORE_ID : ID du data store.
    • JSON_SCHEMA_OBJECT : votre nouveau schéma JSON en tant qu'objet JSON. Exemple :

      {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "keyPropertyMapping": "title"
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "string",
              "keyPropertyMapping": "category"
            }
          },
          "uri": {
            "type": "string",
            "keyPropertyMapping": "uri"
          }
        }
      }
  6. Facultatif : examinez le schéma en suivant la procédure Afficher une définition de schéma.

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le guide de démarrage rapide de Gemini Enterprise à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Gemini Enterprise en langage C#.

Pour vous authentifier auprès de Gemini Enterprise, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

using Google.Cloud.DiscoveryEngine.V1;
using Google.LongRunning;

public sealed partial class GeneratedSchemaServiceClientSnippets
{
    /// <summary>Snippet for UpdateSchema</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void UpdateSchemaRequestObject()
    {
        // Create client
        SchemaServiceClient schemaServiceClient = SchemaServiceClient.Create();
        // Initialize request argument(s)
        UpdateSchemaRequest request = new UpdateSchemaRequest
        {
            Schema = new Schema(),
            AllowMissing = false,
        };
        // Make the request
        Operation<Schema, UpdateSchemaMetadata> response = schemaServiceClient.UpdateSchema(request);

        // Poll until the returned long-running operation is complete
        Operation<Schema, UpdateSchemaMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        Schema result = completedResponse.Result;

        // Or get the name of the operation
        string operationName = response.Name;
        // This name can be stored, then the long-running operation retrieved later by name
        Operation<Schema, UpdateSchemaMetadata> retrievedResponse = schemaServiceClient.PollOnceUpdateSchema(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            Schema retrievedResult = retrievedResponse.Result;
        }
    }
}

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le guide de démarrage rapide de Gemini Enterprise à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Gemini Enterprise en langage Go.

Pour vous authentifier auprès de Gemini Enterprise, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.


//go:build examples

package main

import (
	"context"

	discoveryengine "cloud.google.com/go/discoveryengine/apiv1"
	discoveryenginepb "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := discoveryengine.NewSchemaClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &discoveryenginepb.UpdateSchemaRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb#UpdateSchemaRequest.
	}
	op, err := c.UpdateSchema(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le guide de démarrage rapide de Gemini Enterprise à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Gemini Enterprise en langage Java.

Pour vous authentifier auprès de Gemini Enterprise, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

import com.google.cloud.discoveryengine.v1.Schema;
import com.google.cloud.discoveryengine.v1.SchemaServiceClient;
import com.google.cloud.discoveryengine.v1.UpdateSchemaRequest;

public class SyncUpdateSchema {

  public static void main(String[] args) throws Exception {
    syncUpdateSchema();
  }

  public static void syncUpdateSchema() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
      UpdateSchemaRequest request =
          UpdateSchemaRequest.newBuilder()
              .setSchema(Schema.newBuilder().build())
              .setAllowMissing(true)
              .build();
      Schema response = schemaServiceClient.updateSchemaAsync(request).get();
    }
  }
}

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le guide de démarrage rapide de Gemini Enterprise à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Gemini Enterprise en langage Python.

Pour vous authentifier auprès de Gemini Enterprise, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1


def sample_update_schema():
    # Create a client
    client = discoveryengine_v1.SchemaServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1.UpdateSchemaRequest()

    # Make the request
    operation = client.update_schema(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Ruby

Avant d'essayer cet exemple, suivez les instructions de configuration pour Ruby décrites dans le guide de démarrage rapide de Gemini Enterprise à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Gemini Enterprise en langage Ruby.

Pour vous authentifier auprès de Gemini Enterprise, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

require "google/cloud/discovery_engine/v1"

##
# Snippet for the update_schema call in the SchemaService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::DiscoveryEngine::V1::SchemaService::Client#update_schema.
#
def update_schema
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::DiscoveryEngine::V1::SchemaService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::DiscoveryEngine::V1::UpdateSchemaRequest.new

  # Call the update_schema method.
  result = client.update_schema request

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

Conditions requises et limites

Lorsque vous mettez à jour un schéma, assurez-vous que le nouveau schéma est rétrocompatible avec le schéma que vous mettez à jour. Pour mettre à jour un schéma avec un nouveau schéma qui n'est pas rétrocompatible, vous devez supprimer tous les documents du data store, supprimer le schéma et en créer un autre.

La mise à jour d'un schéma déclenche la réindexation de tous les documents. La réindexation d'un data store volumineux peut prendre des heures, voire des jours.

Les mises à jour de schéma ne sont pas compatibles avec les éléments suivants :

  • Modifier le type d'un champ. Une mise à jour de schéma ne permet pas de modifier le type d'un champ, à une exception près : un champ de type integer peut être remplacé par number. Toute autre modification, telle que integer à string, un champ unique à un tableau ou une profondeur d'imbrication différente pour un tableau existant, échoue avec l'erreur Schema update cannot alter the field type. Field type mismatch for field "FIELD_NAME".
  • Supprimer un champ Une fois défini, un champ ne peut pas être supprimé. Vous pouvez continuer à ajouter des champs, mais vous ne pouvez pas en supprimer. Une requête qui omet un champ existant échoue avec l'erreur Schema update doesn't support removing fields. Fields "FIELD_NAME" cannot be removed.
  • Modifier d'autres mappages de propriétés clés Vous pouvez ajouter ou supprimer les mappages de propriétés de clé title, description, uri, create_time et update_time. Vous ne pouvez pas déplacer un mappage de propriété de clé d'un champ à un autre, ni ajouter un autre mappage de propriété de clé à un schéma tant que le data store contient des documents.

Exemples de limites (REST uniquement)

Cette section présente des exemples de types de mises à jour de schéma valides et non valides. Ces exemples utilisent l'exemple de schéma JSON suivant :

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string",
      "keyPropertyMapping": "description"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string",
        "keyPropertyMapping": "category"
      }
    }
  }
}

Exemples de mises à jour acceptées

Les mises à jour suivantes de l'exemple de schéma sont acceptées.

  • Ajouter un champ Dans cet exemple, le champ properties.uri a été ajouté au schéma.

    {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string",
          "keyPropertyMapping": "description"
        },
        "uri": { // Added field. This is supported.
          "type": "string",
          "keyPropertyMapping": "uri"
        },
        "categories": {
          "type": "array",
          "items": {
            "type": "string",
            "keyPropertyMapping": "category"
          }
        }
      }
    }
    
  • Ajout ou suppression d'annotations de propriété de clé pour title, description ou uri. Dans cet exemple, keyPropertyMapping a été ajouté au champ title.

    {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "keyPropertyMapping": "title" // Added "keyPropertyMapping". This is supported.
        },
        "description": {
          "type": "string",
          "keyPropertyMapping": "description"
        },
        "categories": {
          "type": "array",
          "items": {
            "type": "string",
            "keyPropertyMapping": "category"
          }
        }
      }
    }
    

Exemples de mises à jour de schéma non valides

Les mises à jour suivantes de l'exemple de schéma ne sont pas acceptées.

  • Modifier le type d'un champ. Dans cet exemple, le type du champ title est passé de "chaîne" à "nombre". Cette fonctionnalité n'est pas disponible.

      {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "title": {
            "type": "number" // Changed from string. Not allowed.
          },
          "description": {
            "type": "string",
            "keyPropertyMapping": "description"
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "string",
              "keyPropertyMapping": "category"
            }
          }
        }
      }
    
  • Supprimer un champ Dans cet exemple, le champ title a été supprimé. Cette fonctionnalité n'est pas disponible.

      {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          // "title" is removed. Not allowed.
          "description": {
            "type": "string",
            "keyPropertyMapping": "description"
          },
          "uri": {
            "type": "string",
            "keyPropertyMapping": "uri"
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "string",
              "keyPropertyMapping": "category"
            }
          }
        }
      }
    

Étapes suivantes