Se usó la API de Cloud Translation para traducir esta página.

Actualiza un esquema

Puedes actualizar el esquema de cualquier dato que contenga datos que admitan un esquema, como datos estructurados, datos del sitio web con datos estructurados o cualquier otro dato no estructurado con metadatos.

Puedes actualizar el esquema en la consola de Google Cloud o con el método de la API de schemas.patch. La actualización del esquema de un sitio web solo es compatible con la API de REST.

Para actualizar el esquema, puedes agregar campos nuevos, cambiar las anotaciones indexables, searchable y recuperables de un campo, o marcar un campo como una propiedad clave, como title, uri y description.

Actualiza tu esquema

Puedes actualizar tu esquema en la consola de Google Cloud o con la API.

Console

Para actualizar un esquema en la consola de Google Cloud, sigue estos pasos:

Revisa la sección Requisitos y limitaciones para verificar que la actualización del esquema sea válida.
Si actualizas anotaciones de campo (estableces campos como indexables, recuperables, dinámicos, con facetas, que se pueden buscar o completar), consulta Configurar la configuración de campos para conocer las limitaciones y los requisitos de cada tipo de anotación.
Verifica que hayas completado la transferencia de datos. De lo contrario, es posible que el esquema aún no esté disponible para editarlo.
En la consola de Google Cloud, ve a la página Agent Builder.

Agent Builder
En el menú de navegación, haz clic en Almacenes de datos.
En la columna Nombre, haz clic en el almacén de datos con el esquema que deseas actualizar.
Haz clic en la pestaña Esquema para ver el esquema de tus datos.

Es posible que esta pestaña esté vacía si es la primera vez que editas los campos.
Haz clic en el botón Editar.
Actualiza tu esquema:
- Asigna propiedades clave: En la columna Key properties de tu esquema, selecciona una propiedad clave a la que quieras asignar un campo. Por ejemplo, si un campo llamado details siempre contiene la descripción de un documento, asigna ese campo a la propiedad clave Description.
- Actualizar la cantidad de dimensiones (avanzado): Puedes actualizar esta configuración si usas incorporaciones vectoriales personalizadas con la Búsqueda de Vertex AI. Consulta Avanzado: Usa incorporaciones personalizadas.
- Actualiza las anotaciones de un campo: Para actualizar las anotaciones de un campo, selecciona o anula la selección del parámetro de configuración de anotaciones de un campo. Las anotaciones disponibles son recuperables, indexables, facetas dinámicas, se pueden buscar y completar. Algunos parámetros de configuración de campos tienen limitaciones. Consulta Configura la configuración de los campos para obtener descripciones y requisitos de cada tipo de anotación.
- Agregar un campo nuevo: Si agregas campos nuevos a tu esquema antes de importar documentos nuevos con esos campos, puedes acortar el tiempo que tarda Vertex AI Agent Builder en volver a indexar tus datos después de la importación.
  1. Haz clic en Agregar campos nuevos para expandir esa sección.
  2. Haz clic en add_box Agregar nodo y especifica la configuración del campo nuevo.
    
    Para indicar un array, establece Array en Sí. Por ejemplo, para agregar un array de cadenas, establece type en string y Array en Yes.
    
    En el caso de un índice de almacén de datos de sitios web, todos los campos que agregues son arrays de forma predeterminada.
Haz clic en Guardar para aplicar los cambios en el esquema.

Cambiar el esquema activa la nueva indexación. En el caso de los almacenes de datos grandes, la reindexación puede tardar horas.

REST

Para usar la API y actualizar tu esquema, sigue estos pasos:

Revisa las secciones Requisitos y limitaciones y Ejemplos de limitaciones (solo REST) para verificar que los cambios en tu esquema sean válidos.

Para actualizar el esquema de los almacenes de datos con sitios web o datos no estructurados con metadatos, avanza al paso 5 para llamar al método schema.patch.
Si actualizas las anotaciones de campo (estableces campos como indexables, recuperables, dinámicos, con facetas o que se pueden buscar), consulta Configurar la configuración de campos para conocer las limitaciones y los requisitos de cada tipo de anotación.
Si editas un esquema detectado automáticamente, asegúrate de haber completado la transferencia de datos. De lo contrario, es posible que el esquema aún no esté disponible para su edición.
Busca el ID de tu almacén de datos. Si ya tienes el ID del almacén de datos, ve al siguiente paso.
1. En la consola de Google Cloud, ve a la página Agent Builder y, en el menú de navegación, haz clic en Almacenes de datos.
  
  Ve a la página Almacenes de datos.
2. Haz clic en el nombre de tu almacén de datos.
3. En la página Datos de tu almacén de datos, obtén el ID del almacén de datos.

Usa el método de la API schemas.patch para proporcionar tu nuevo esquema JSON como un objeto 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
}'

Reemplaza lo siguiente:

PROJECT_ID: El ID del proyecto de Google Cloud.
DATA_STORE_ID: el ID del almacén de datos de Vertex AI Search.

JSON_SCHEMA_OBJECT: Tu nuevo esquema JSON como objeto JSON Por ejemplo:

{
  "$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"
    }
  }
}

Ejemplo de comando y resultado

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"
}
}

Opcional: Para revisar el esquema, sigue el procedimiento Cómo ver la definición de un esquema.

C#

Para obtener más información, consulta la documentación de referencia de la API de C# del compilador de agentes de Vertex AI.

Para autenticarte en Vertex AI Agent Builder, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo 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

Para obtener más información, consulta la documentación de referencia de la API de Go del compilador de agentes de Vertex AI.


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

Para obtener más información, consulta la documentación de referencia de la API de Java del compilador de agentes de Vertex AI.

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

Para obtener más información, consulta la documentación de referencia de la API de Python del compilador de agentes de Vertex AI.

# 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

Para obtener más información, consulta la documentación de referencia de la API de Ruby del compilador de agentes de Vertex AI.

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

Requisitos y limitaciones

Cuando actualices un esquema, asegúrate de que el nuevo sea retrocompatible con el esquema que estás actualizando. Para actualizar un esquema con uno nuevo que no sea retrocompatible, debes borrar todos los documentos del almacén de datos, borrar el esquema y crear uno nuevo.

La actualización de un esquema activa la reindexación de todos los documentos. Esto puede llevar tiempo y generar costos adicionales:

Time. La reindexación de un almacén de datos grande puede tardar horas o días.
Gasto. La reinstalación del índice puede generar costos, según el analizador. Por ejemplo, la reindeksación de almacenes de datos que usan el analizador de OCR o el analizador de diseño genera costos. Para obtener más información, consulta los precios de las funciones de Document AI.

Las actualizaciones de esquemas no son compatibles con lo siguiente:

Cambiar el tipo de campo Una actualización de esquema no admite el cambio del tipo del campo. Por ejemplo, un campo asociado a un número entero no se puede cambiar a una cadena.
Quitar un campo. Una vez definido, no se puede quitar un campo. Puedes seguir agregando campos nuevos, pero no puedes quitar un campo existente.

Ejemplos de limitaciones (solo REST)

En esta sección, se muestran ejemplos de tipos de actualizaciones de esquemas válidos y no válidos. En estos ejemplos, se usa el siguiente esquema JSON de ejemplo:

{
  "$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"
      }
    }
  }
}

Ejemplos de actualizaciones compatibles

Se admiten las siguientes actualizaciones del esquema de ejemplo.

Agregar un campo En este ejemplo, se agregó el campo properties.uri al esquema.

{
  "$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"
      }
    }
  }
}

Agregar o quitar anotaciones de propiedades clave para title, description o uri En este ejemplo, se agregó keyPropertyMapping al campo 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"
      }
    }
  }
}

Ejemplos de actualizaciones de esquemas no válidas

No se admiten las siguientes actualizaciones del esquema de ejemplo.

Cambiar el tipo de campo En este ejemplo, el tipo del campo title se cambió de cadena a número. No se admite esta opción.

  {
    "$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"
        }
      }
    }
  }

Quitar un campo. En este ejemplo, se quitó el campo title. No se admite esta opción.

  {
    "$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"
        }
      }
    }
  }