CreateIndex 接口用于在 TOS Vectors 中新建向量索引，本文介绍如何通过 TOS Vectors Java SDK 的 CreateIndex 接口创建索引并指定维度、度量方式与更新策略。

注意事项

您需要根据实际情况，填写示例代码中的地域和访问域名，详细介绍，请参见地域和访问域名（Endpoint）。

为了防止密钥泄露，本文示例代码需要从环境变量中读取 Access Key ID 和 Secret Access Key。因此使用 SDK 前，您需要配置长期访问凭证，详细介绍，请参见配置长期访问凭证。

TOS Vectors Java SDK 支持使用临时访问凭证；也支持配置超时机制、重试策略等多种机制，您可以根据业务需求灵活设置，提升应用安全性，详细介绍，请参见常见配置场景。

向量索引名需要在向量桶中唯一。

权限说明

主账号默认拥有全部权限，但是 IAM 用户默认没有任何权限。如果您需要使用 IAM 用户执行 CreateIndex 操作，主账号需通过 IAM策略和桶策略为该 IAM 用户授予以下权限：tosvectors:CreateIndex

代码示例

创建向量索引基本用法

// 创建向量索引基本用法​
import com.volcengine.tos.TOSVectorsClientBuilder;​
import com.volcengine.tos.TOSVectors;​
import com.volcengine.tos.TosClientException;​
import com.volcengine.tos.TosServerException;​
import com.volcengine.tos.comm.common.DataType;​
import com.volcengine.tos.comm.common.DistanceMetricType;​
import com.volcengine.tos.model.vectors.CreateIndexInput;​
import com.volcengine.tos.model.vectors.CreateIndexOutput;​
import com.volcengine.tos.model.vectors.MetadataConfiguration;​
​
import java.util.Arrays;​
​
public class CreateIndexExample {​
    public static void main(String[] args) {​
        String endpoint = 'Provide your endpoint';​
        String region = 'Provide your region';​
        String accessKey = System.getenv("TOS_ACCESS_KEY");​
        String secretKey = System.getenv("TOS_SECRET_KEY");​
        String accountID = System.getenv("TOS_ACCOUNT_ID");​
​
        // 填写向量存储桶名称​
        String vectorBucketName = 'Provide your vector bucket name';​
        // 填写索引名称​
        String indexName = "testindex";​
​
        // 初始化客户端​
        TOSVectors client = new TOSVectorsClientBuilder().build(region, endpoint, accessKey, secretKey);​
​
        try {​
            // 创建向量索引​
            // 1. 设置索引参数：向量维度为128，数据类型为float32，距离度量方式为cosine​
            // 2. 配置元数据：设置不可过滤的元数据键​
            CreateIndexInput input = CreateIndexInput.builder()​
                    .vectorBucketName(vectorBucketName)​
                    .accountId(accountID)​
                    .indexName(indexName)​
                    .dataType(DataType.DATA_TYPE_FLOAT32)  // 数据类型：float32​
                    .dimension(128)  // 向量维度：128​
                    .distanceMetric(DistanceMetricType.DISTANCE_METRIC_COSINE)  // 距离度量：余弦相似度​
                    .metadataConfiguration(new MetadataConfiguration()​
                            .setNonFilterableMetadataKeys(Arrays.asList("key1", "key2")))  // 不可过滤的元数据键​
                    .build();​
​
            // 调用创建索引API​
            CreateIndexOutput output = client.createIndex(input);​
            ​
            // 处理返回结果​
            System.out.println("创建向量索引成功");​
            System.out.println("RequestID: " + output.getRequestInfo().getRequestId());​
            System.out.println("StatusCode: " + output.getRequestInfo().getStatusCode());​
            System.out.println("索引名称: " + indexName);​
            System.out.println("向量维度: 128");​
            System.out.println("数据类型: float32");​
            System.out.println("距离度量: cosine");​
​
        } catch (TosClientException e) {​
            // 操作失败，捕获客户端异常，一般情况是请求参数错误，此时请求并未发送​
            System.out.println("操作失败");​
            System.out.println("Message: " + e.getMessage());​
            if (e.getCause() != null) {​
                e.getCause().printStackTrace();​
            }​
        } catch (TosServerException e) {​
            // 操作失败，捕获服务端异常，可以获取到从服务端返回的详细错误信息​
            System.out.println("操作失败");​
            System.out.println("StatusCode: " + e.getStatusCode());​
            System.out.println("Code: " + e.getCode());​
            System.out.println("Message: " + e.getMessage());​
            System.out.println("RequestID: " + e.getRequestID());​
        } catch (Throwable t) {​
            // 作为兜底捕获其他异常，一般不会执行到这里​
            System.out.println("操作失败");​
            System.out.println("unexpected exception, message: " + t.getMessage());​
        }​
    }​
}​

对象存储