Typesense

本节将引导你设置 TypesenseVectorStore 来存储文档嵌入并执行相似性搜索。 Typesense 是一个开源的容错搜索引擎，它针对低于 50 毫秒的即时搜索进行了优化，同时提供了直观的开发体验。它提供了向量搜索功能，允许你存储和查询高维向量以及常规搜索数据。

先决条件

  • 运行中的 Typesense 实例。以下选项可用：

  • 如果需要，EmbeddingModel 的 API 密钥，用于生成 TypesenseVectorStore 存储的嵌入。

自动配置

Spring AI 自动配置、启动器模块的 artifact 名称发生了重大变化。 请参阅 升级说明 以获取更多信息。

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

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-vector-store-typesense'
}

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

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

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

向量存储实现可以为你初始化所需的 schema，但你必须通过在 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());

配置属性

要连接到 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

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

属性 描述 默认值

spring.ai.vectorstore.typesense.initialize-schema

是否初始化所需的 schema

false

spring.ai.vectorstore.typesense.collection-name

存储向量的集合名称

vector_store

spring.ai.vectorstore.typesense.embedding-dimension

向量的维度数量

1536

spring.ai.vectorstore.typesense.client.protocol

HTTP 协议

http

spring.ai.vectorstore.typesense.client.host

主机名

localhost

spring.ai.vectorstore.typesense.client.port

端口

8108

spring.ai.vectorstore.typesense.client.api-key

API 密钥

xyz

手动配置

除了使用 Spring Boot 自动配置，你还可以手动配置 Typesense 向量存储。为此，你需要将 spring-ai-typesense-store 添加到你的项目中：

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

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

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

请参阅 依赖管理 部分，将 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);
}

然后使用构建器模式创建 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")));
}

元数据过滤

你也可以在 Typesense 存储中利用通用的可移植 元数据过滤器。

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

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

或者通过 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());

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

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

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

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

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

如果你检索的文档顺序不符合预期，或者搜索结果不符合预期，请检查你正在使用的嵌入模型。 嵌入模型可能对搜索结果产生显著影响（例如，确保如果你的数据是西班牙语，则使用西班牙语或多语言嵌入模型）。

访问原生客户端

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
}

原生客户端使你能够访问 VectorStore 接口可能未公开的 Typesense 特定功能和操作。