更新架构

您可以更新支持架构的架构结构化数据和包含元数据的非结构化数据。

您可以在 Google Cloud 控制台中或使用 schemas.patch API 方法更新架构。

如需更新架构，您可以添加新字段、更改字段的可编入索引、可搜索和可检索注释，或将字段标记为关键属性，例如 title、uri 和 description。

重要提示： Google 强烈建议您使用关键属性映射更新架构，尤其是针对 title。这可确保您的结果正确显示，并帮助 Gemini Enterprise 识别重要信息，从而生成更好的结果。

更新架构

您可以在 Google Cloud 控制台中或使用 API 更新架构。

注意： 修改架构会再次为数据存储区编制索引。 对于大型数据存储区，编制索引可能需要数小时。

控制台

如需在 Google Cloud 控制台中更新架构，请按以下步骤操作：

1. 查看要求和限制部分，确保您的架构更新有效。

2. 如果您要更新字段注解（将字段设置为可编制索引、可检索、动态可分面、可搜索或可补全），请查看配置字段设置，了解每种注解类型的限制和要求。

3. 检查您是否已完成数据注入。否则，该架构可能尚未提供修改功能。

4. 在 Google Cloud 控制台中，前往 Gemini Enterprise 页面。

   Gemini Enterprise

5. 在导航菜单中，点击数据存储区。

6. 在名称列中，点击要更新的架构所对应的数据存储区。

7. 点击架构标签页，查看数据的架构。

   如果您是首次修改这些字段，此标签页可能为空。

8. 点击修改按钮。

9. 更新架构：

   • 映射关键属性：在架构的关键属性列中，选择要将字段映射到的关键属性。例如，如果名为 details 的字段始终包含文档的说明，请将该字段映射到键属性 Description。

   • 更新维度数（高级）：如果您将自定义向量嵌入与 Gemini Enterprise 搭配使用，则可以更新此设置。请参阅高级：使用自定义嵌入内容。

   • 更新字段注解：如需更新字段的注解，请选择或取消选择字段的注解设置。可用的注释包括可检索、可编入索引、可动态分面、可搜索和可补全。部分字段设置存在限制。如需了解每种注解类型的说明和要求，请参阅配置字段设置。

   • 添加新字段：在导入包含这些字段的新文档之前，向架构添加新字段可以缩短 Gemini Enterprise 在导入后重新为数据编制索引所需的时间。

     1. 点击添加新字段以展开该部分。

     2. 点击 add_box 添加节点，然后为新字段指定设置。

        如需指明数组，请将数组设置为是。例如，如需添加字符串数组，请将 type 设置为 string，并将 Array 设置为 Yes。

10. 点击保存以应用架构更改。

    更改架构会触发重新编制索引的流程。对于大型数据存储区，重新编制索引的流程可能需要几小时才能完成。

REST

如需使用 API 更新架构，请按以下步骤操作：

1. 查看要求和限制以及限制示例（仅限 REST）部分，确保您的架构变更有效。

   如需更新包含元数据的非结构化数据的数据存储区的架构，请跳至第 5 步以调用 schema.patch 方法。

2. 如果您要更新字段注解（将字段设置为可编制索引、可检索、可进行动态分面或可搜索），请查看配置字段设置，了解每种注解类型的限制和要求。

3. 如果您要修改自动检测到的架构，请确保已完成数据注入。否则，相应架构可能尚未提供编辑功能。

4. 查找数据存储区 ID。如果您已拥有数据存储区 ID，请跳至下一步。

   1. 在 Google Cloud 控制台中，前往 Gemini Enterprise 页面，然后在导航菜单中点击数据存储区。

      前往“数据存储区”页面

   2. 点击您的数据存储区的名称。

   3. 在数据存储区的数据页面上，获取数据存储区 ID。

5. 使用 schemas.patch API 方法以 JSON 对象的形式提供新的 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
   }'
   

   替换以下内容：

   • PROJECT_ID：您的项目的 ID。
   • DATA_STORE_ID：数据存储区的 ID。

   • JSON_SCHEMA_OBJECT：您的新 JSON 架构（以 JSON 对象的形式）。例如：

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

     命令和结果示例

     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. 可选：按照查看架构定义中的步骤查看架构。

C#

试用此示例之前，请按照《Gemini Enterprise 快速入门：使用客户端库》中的 C# 设置说明进行操作。 如需了解详情，请参阅 Gemini Enterprise C# API 参考文档。

如需向 Gemini Enterprise 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。

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

试用此示例之前，请按照《Gemini Enterprise 快速入门：使用客户端库》中的 Go 设置说明进行操作。 如需了解详情，请参阅 Gemini Enterprise Go API 参考文档。

如需向 Gemini Enterprise 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。

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

试用此示例之前，请按照《Gemini Enterprise 快速入门：使用客户端库》中的 Java 设置说明进行操作。 如需了解详情，请参阅 Gemini Enterprise Java API 参考文档。

如需向 Gemini Enterprise 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。

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

试用此示例之前，请按照《Gemini Enterprise 快速入门：使用客户端库》中的 Python 设置说明进行操作。 如需了解详情，请参阅 Gemini Enterprise Python API 参考文档。

如需向 Gemini Enterprise 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。

# 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

试用此示例之前，请按照《Gemini Enterprise 快速入门：使用客户端库》中的 Ruby 设置说明进行操作。 如需了解详情，请参阅 Gemini Enterprise Ruby API 参考文档。

如需向 Gemini Enterprise 进行身份验证，请设置应用默认凭据。 如需了解详情，请参阅为本地开发环境设置身份验证。

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

要求和限制

更新架构时，请务必确保新架构与您要更新的架构向后兼容。如需使用不向后兼容的新架构更新架构，您需要删除数据存储区中的所有文档、删除架构，然后创建新架构。

更新架构会触发对所有文档重新编制索引的流程。 为大型数据存储区重新编制索引可能需要数小时或数天。

架构更新不支持以下操作：

• 更改字段类型。架构更新不支持更改字段的类型。例如，映射到 integer 的字段无法更改为 string。
• 移除字段。字段定义后便无法移除。您可以继续添加新字段，但无法移除现有字段。

限制示例（仅限 REST）

本部分展示了有效和无效的架构更新类型示例。这些示例使用以下 JSON 架构示例：

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

支持的更新示例

支持对示例架构进行以下更新。

• 添加字段。在此示例中，已将字段 properties.uri 添加到架构中。

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

• 为 title、description 或 uri 添加或移除关键属性注释。在此示例中，keyPropertyMapping 已添加到 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"
        }
      }
    }
  }
  

无效的架构更新示例

不支持对示例架构进行以下更新。

• 更改字段类型。在此示例中，title 字段的类型已从字符串更改为数字。系统不支持此操作。

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

• 移除字段。在此示例中，title 字段已被移除。 系统不支持此操作。

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

后续步骤

• 查看结构化数据的架构定义
• 删除结构化数据的架构
• 预览搜索结果