Typesense

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

Typesense 是一个开源的容错搜索引擎，它经过优化，可实现低于 50 毫秒的即时搜索，同时提供直观的开发人员体验。它提供向量搜索功能，允许您将高维向量与常规搜索数据一起存储和查询。

先决条件

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

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

自动配置

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

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 添加到您的构建文件中。

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

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

向量存储实现可以为您初始化所需的架构，但您必须通过在 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

是否初始化所需的模式

假

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

手动配置

您可以手动配置 Typesense 向量存储，而不是使用 Spring Boot 自动配置。为此，您需要将 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 特有功能和操作。

© . This site is unofficial and not affiliated with VMware.