Mettre à jour un schéma

Console

Pour mettre à jour un schéma dans la console Google Cloud  :

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 les annotations de champ (en définissant des champs comme indexables, récupérables, dynamiques, pouvant être utilisés comme facettes, pouvant faire l'objet d'une recherche ou pouvant être complétés), consultez Configurer les paramètres des champs 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. Dans le cas contraire, il est possible que le schéma ne soit pas encore modifiable.

4. Dans la console Google Cloud , accédez à la page AI Applications.

   AI Applications

5. Dans le menu de navigation, cliquez sur Data Stores (Magasins de données).

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

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

   Cet onglet peut être vide si vous modifiez les champs pour la première fois.

8. Cliquez sur le bouton Modifier.

9. Mettez à jour votre schéma :

   • Mappez les propriétés clés : dans la colonne Propriétés clés de votre schéma, sélectionnez une propriété 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é clé Description.

   • Mettre à jour le nombre de dimensions (paramètre avancé) : vous pouvez modifier ce paramètre si vous utilisez des embeddings vectoriels personnalisés avec Vertex AI Search. Consultez Avancé : utiliser des embeddings personnalisés.

   • 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 du 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 soumis à des limites. Pour obtenir des descriptions et des exigences pour chaque type d'annotation, consultez Configurer les paramètres des champs.

   • Ajoutez un champ : si vous ajoutez un champ à votre schéma avant d'importer de nouveaux documents contenant ce champ, les applications d'IA pourront réindexer vos données plus rapidement 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.

        Pour un index de data store de site Web, tous les champs que vous ajoutez sont des tableaux par défaut.

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 Conditions requises et limites et Exemples de limites (REST uniquement) pour vérifier que les modifications apportées à votre schéma sont valides.

   Pour mettre à jour le schéma des data stores contenant des sites Web ou 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 les annotations de champ (en définissant des champs comme indexables, récupérables, dynamiques et pouvant être utilisés pour la création de facettes ou pour la recherche), consultez Configurer les paramètres des champs 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. Dans le cas contraire, il est possible que le schéma ne soit pas encore disponible pour la modification.

4. Trouvez 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 Applications d'IA et cliquez sur Data stores dans le menu de navigation.

      Accéder à la page "Data stores"

   2. Cliquez sur le nom de votre data store.

   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 : ID de votre projet Google Cloud .
   • DATA_STORE_ID : ID du data store Vertex AI Search.

   • JSON_SCHEMA_OBJECT : votre nouveau schéma JSON sous forme d'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"
         }
       }
     }

     Exemple de commande et de résultat

     curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" "https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/collections/default_collection/dataStores/my-data-store/schemas/default_schema" -d '{
     "structSchema": {
     "$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"
     }
     }
     }
     }'
     
     {
     "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/schemas/default_schema/operations/update-schema-10569824819404198922",
     "metadata": {
     "@type": "type.googleapis.com/google.cloud.discoveryengine.v1.UpdateSchemaMetadata"
     }
     }
     

6. Facultatif : Examinez le schéma en suivant la procédure Afficher une définition de schéma.

C#

Pour en savoir plus, consultez la documentation de référence de l'API AI Applications C#.

Pour vous authentifier auprès des applications d'IA, 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

Pour en savoir plus, consultez la documentation de référence de l'API AI Applications Go.

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

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

Pour en savoir plus, consultez la documentation de référence de l'API AI Applications Java.

Pour vous authentifier auprès des applications d'IA, 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

Pour en savoir plus, consultez la documentation de référence de l'API AI Applications Python.

Pour vous authentifier auprès des applications d'IA, 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

Pour en savoir plus, consultez la documentation de référence de l'API AI Applications Ruby.

Pour vous authentifier auprès des applications d'IA, 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