Typesense 字体

本节将指导您完成设置以存储文档嵌入并执行相似性搜索。TypesenseVectorStorespring-doc.cn

Typesense 字体Typesense 是一个开源的、容忍拼写错误的搜索引擎，它针对低于 50 毫秒的即时搜索进行了优化，同时提供直观的开发人员体验。spring-doc.cn

先决条件

  1. Typesense 实例spring-doc.cn

  2. EmbeddingModel实例来计算文档嵌入。有几个选项可用：spring-doc.cn

自动配置

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

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

或您的 Gradle 构建文件。build.gradlespring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-typesense-spring-boot-starter'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。
请参阅 Repositories 部分，将 Milestone 和/或 Snapshot Repositories 添加到您的构建文件中。

此外，您还需要一个已配置的 Bean。请参阅 EmbeddingModel 部分以了解更多信息。EmbeddingModelspring-doc.cn

以下是所需 bean 的示例：spring-doc.cn

@Bean
public EmbeddingModel embeddingModel() {
    // Can be any other EmbeddingModel implementation.
    return new OpenAiEmbeddingModel(new OpenAiApi(System.getenv("SPRING_AI_OPENAI_API_KEY")));
}

要连接到 Typesense，您需要提供实例的访问详细信息。 可以通过 Spring Boot 的 application.yml 提供简单的配置，spring-doc.cn

spring:
  ai:
    vectorstore:
      typesense:
          collectionName: "vector_store"
          embeddingDimension: 1536
          client:
              protocl: http
              host: localhost
              port: 8108
              apiKey: xyz

请查看 vector store 的配置参数列表，了解默认值和配置选项。spring-doc.cn

现在，您可以在应用程序中自动连接 Typesense Vector Store 并使用它spring-doc.cn

@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 = this.vectorStore.similaritySearch(SearchRequest.query("Spring").withTopK(5));

配置属性

您可以在 Spring Boot 配置中使用以下属性来自定义 Typesense 向量存储。spring-doc.cn

财产 描述 默认值

spring.ai.vectorstore.typesense.client.protocolspring-doc.cn

HTTP 协议spring-doc.cn

httpspring-doc.cn

spring.ai.vectorstore.typesense.client.hostspring-doc.cn

主机名spring-doc.cn

localhostspring-doc.cn

spring.ai.vectorstore.typesense.client.portspring-doc.cn

港口spring-doc.cn

8108spring-doc.cn

spring.ai.vectorstore.typesense.client.apiKeyspring-doc.cn

ApiKeyspring-doc.cn

xyzspring-doc.cn

spring.ai.vectorstore.typesense.initialize-schemaspring-doc.cn

是否初始化所需的 schemaspring-doc.cn

falsespring-doc.cn

spring.ai.vectorstore.typesense.collection-namespring-doc.cn

集合名称spring-doc.cn

vector_storespring-doc.cn

spring.ai.vectorstore.typesense.embedding-dimensionspring-doc.cn

嵌入维度spring-doc.cn

1536spring-doc.cn

元数据筛选

您也可以利用通用的可移植元数据过滤器。TypesenseVectorStorespring-doc.cn

例如，您可以使用文本表达式语言：spring-doc.cn

vectorStore.similaritySearch(
   SearchRequest
      .query("The World")
      .withTopK(TOP_K)
      .withSimilarityThreshold(SIMILARITY_THRESHOLD)
      .withFilterExpression("country in ['UK', 'NL'] && year >= 2020"));

或者以编程方式使用表达式 DSL：spring-doc.cn

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(
   SearchRequest
      .query("The World")
      .withTopK(TOP_K)
      .withSimilarityThreshold(SIMILARITY_THRESHOLD)
      .withFilterExpression(b.and(
         b.in("country", "UK", "NL"),
         b.gte("year", 2020)).build()));

可移植的筛选表达式会自动转换为 Typesense 搜索筛选。 例如，以下可移植筛选条件表达式：spring-doc.cn

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

转换为 Typesense 过滤器：spring-doc.cn

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

手动配置

如果您不想使用自动配置，则可以手动配置 Typesense Vector Store。 添加 Typesense Vector Store 和 Jedis 依赖项spring-doc.cn

<dependency>
  <groupId>org.springframework.ai</groupId>
  <artifactId>spring-ai-typesense</artifactId>
</dependency>
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

然后，在 Spring 配置中创建一个 bean：TypesenseVectorStorespring-doc.cn

@Bean
public VectorStore vectorStore(Client client, EmbeddingModel embeddingModel) {

    TypesenseVectorStoreConfig config = TypesenseVectorStoreConfig.builder()
        .withCollectionName("test_vector_store")
        .withEmbeddingDimension(embeddingModel.dimensions())
        .build();

    return new TypesenseVectorStore(client, embeddingModel, config);
}

@Bean
public Client typesenseClient() {
    List<Node> nodes = new ArrayList<>();
    nodes
        .add(new Node("http", typesenseContainer.getHost(), typesenseContainer.getMappedPort(8108).toString()));

    Configuration configuration = new Configuration(nodes, Duration.ofSeconds(5), "xyz");
    return new Client(configuration);
}

创建 as bean 更方便，也是首选。 但是，如果您决定手动创建它，则必须在设置属性之后和使用 Client 端之前调用 。TypesenseVectorStoreTypesenseVectorStore#afterPropertiesSet()spring-doc.cn

然后在主代码中，创建一些文档：spring-doc.cn

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

现在将文档添加到您的 vector 存储中：spring-doc.cn

vectorStore.add(documents);

最后，检索类似于查询的文档：spring-doc.cn

List<Document> results = vectorStore.similaritySearch(
   SearchRequest
      .query("Spring")
      .withTopK(5));

如果一切顺利，您应该检索包含文本 “Spring AI rocks！！” 的文档。spring-doc.cn

如果未按预期顺序检索文档或搜索结果与预期不符，请检查您正在使用的嵌入模型。spring-doc.cn

嵌入模型可能会对搜索结果产生重大影响（即，确保您的数据是西班牙语还是多语言嵌入模型）。spring-doc.cn