跳到主要内容

Typesense

DeepSeek V3 中英对照 Typesense

本节将引导您设置 TypesenseVectorStore 以存储文档嵌入并执行相似性搜索。

Typesense 是一个开源的容错搜索引擎，专为即时搜索（低于 50 毫秒）而优化，同时提供直观的开发者体验。它提供了向量搜索功能，允许你在常规搜索数据之外存储和查询高维向量。

先决条件​

  • 一个正在运行的 Typesense 实例。以下选项可用：

  • 如果需要，为 EmbeddingModel 提供一个 API 密钥，以生成由 TypesenseVectorStore 存储的嵌入。

自动配置​

Spring AI 为 Typesense Vector Store 提供了 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件中：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-typesense-spring-boot-starter</artifactId>
</dependency>
xml

或者到你的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-typesense-spring-boot-starter'
}
groovy

:::提示
请参考依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。
:::

请查看向量存储的配置参数列表，以了解默认值和配置选项。

提示

请参阅 Repositories 部分，将 Maven Central 和/或 Snapshot 仓库添加到您的构建文件中。

向量存储实现可以为您初始化所需的模式，但您必须通过在 application.properties 文件中设置 …​initialize-schema=true 来选择启用。

此外，你还需要配置一个 EmbeddingModel bean。更多信息请参考 EmbeddingModel 部分。

现在你可以在应用程序中自动装配 TypesenseVectorStore 作为向量存储：

@Autowired VectorStore vectorStore;

// ...

List<Document> documents = List.of(
    new Document("Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!!", Map.of("meta1", "meta1")),
    new Document("The World is Big and Salvation Lurks Around the Corner"),
    new Document("You walk forward facing the past and you turn back toward the future.", Map.of("meta2", "meta2")));

// Add the documents to Typesense
vectorStore.add(documents);

// Retrieve documents similar to a query
List<Document> results = vectorStore.similaritySearch(SearchRequest.builder().query("Spring").topK(5).build());
java

配置属性​

要连接到 Typesense 并使用 TypesenseVectorStore，您需要提供实例的访问详细信息。可以通过 Spring Boot 的 application.yml 提供简单的配置：

spring:
  ai:
    vectorstore:
      typesense:
        initialize-schema: true
        collection-name: vector_store
        embedding-dimension: 1536
        client:
          protocol: http
          host: localhost
          port: 8108
          api-key: xyz
yaml

以 spring.ai.vectorstore.typesense.* 开头的属性用于配置 TypesenseVectorStore：

属性描述默认值
spring.ai.vectorstore.typesense.initialize-schema是否初始化所需的 schemafalse
spring.ai.vectorstore.typesense.collection-name存储向量的集合名称vector_store
spring.ai.vectorstore.typesense.embedding-dimension向量的维度数量1536
spring.ai.vectorstore.typesense.client.protocolHTTP 协议http
spring.ai.vectorstore.typesense.client.host主机名localhost
spring.ai.vectorstore.typesense.client.port端口8108
spring.ai.vectorstore.typesense.client.api-keyAPI 密钥xyz

手动配置​

你可以手动配置 Typesense 向量存储，而不使用 Spring Boot 的自动配置。为此，你需要在项目中添加 spring-ai-typesense-store 依赖：

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-typesense-store</artifactId>
</dependency>
xml

或添加到你的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-typesense-store'
}
groovy
提示

请参考依赖管理部分，将 Spring AI BOM 添加到您的构建文件中。

创建一个 Typesense Client bean：

@Bean
public Client typesenseClient() {
    List<Node> nodes = new ArrayList<>();
    nodes.add(new Node("http", "localhost", "8108"));
    Configuration configuration = new Configuration(nodes, Duration.ofSeconds(5), "xyz");
    return new Client(configuration);
}
java

然后使用构建器模式创建 TypesenseVectorStore bean：

@Bean
public VectorStore vectorStore(Client client, EmbeddingModel embeddingModel) {
    return TypesenseVectorStore.builder(client, embeddingModel)
        .collectionName("custom_vectors")     // Optional: defaults to "vector_store"
        .embeddingDimension(1536)            // Optional: defaults to 1536
        .initializeSchema(true)              // Optional: defaults to false
        .batchingStrategy(new TokenCountBatchingStrategy()) // Optional: defaults to TokenCountBatchingStrategy
        .build();
}

// This can be any EmbeddingModel implementation
@Bean
public EmbeddingModel embeddingModel() {
    return new OpenAiEmbeddingModel(new OpenAiApi(System.getenv("OPENAI_API_KEY")));
}
java

元数据过滤​

你可以利用通用的可移植元数据过滤器与 Typesense 存储一起使用。

例如，你可以使用文本表达式语言：

vectorStore.similaritySearch(
    SearchRequest.builder()
        .query("The World")
        .topK(TOP_K)
        .similarityThreshold(SIMILARITY_THRESHOLD)
        .filterExpression("country in ['UK', 'NL'] && year >= 2020").build());
java

或者通过编程方式使用 Filter.Expression DSL：

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(SearchRequest.builder()
    .query("The World")
    .topK(TOP_K)
    .similarityThreshold(SIMILARITY_THRESHOLD)
    .filterExpression(b.and(
        b.in("country", "UK", "NL"),
        b.gte("year", 2020)).build()).build());
java
备注

这些（可移植的）过滤表达式会自动转换为 Typesense 搜索过滤器。

例如这个可移植的过滤器表达式：

country in ['UK', 'NL'] && year >= 2020
sql

被转换为专有的 Typesense 过滤器格式：

country: ['UK', 'NL'] && year: >=2020
text
备注

如果你没有按预期顺序检索文档或搜索结果不符合预期，请检查你正在使用的嵌入模型。

嵌入模型对搜索结果有显著影响（例如，如果你的数据是西班牙语的，请确保使用西班牙语或多语言嵌入模型）。

访问 Native Client​

Typesense 向量存储实现通过 getNativeClient() 方法提供了对底层原生 Typesense 客户端（Client）的访问：

TypesenseVectorStore vectorStore = context.getBean(TypesenseVectorStore.class);
Optional<Client> nativeClient = vectorStore.getNativeClient();

if (nativeClient.isPresent()) {
    Client client = nativeClient.get();
    // Use the native client for Typesense-specific operations
}
java

原生客户端使您能够访问可能未通过 VectorStore 接口暴露的 Typesense 特定功能和操作。