Pinecone

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

Pinecone 是一款流行的基于云的向量数据库，允许您高效地存储和搜索向量。

先决条件

  1. Pinecone 账户：在开始之前，请注册一个 Pinecone 账户。

  2. Pinecone 项目：注册后，创建一个新项目、一个索引并生成 API 密钥。您需要这些详细信息进行配置。

  3. EmbeddingModel 实例来计算文档嵌入。有多种选项可用

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

要设置 PineconeVectorStore，请从您的 Pinecone 账户收集以下详细信息

  • Pinecone API 密钥

  • Pinecone 环境

  • Pinecone 项目 ID

  • Pinecone 索引名称

  • Pinecone 命名空间

此信息可在 Pinecone UI 门户中找到。

自动配置

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

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-pinecone-store-spring-boot-starter'
}
请参阅 依赖项管理 部分，以将 Spring AI BOM 添加到您的构建文件中。
请参阅 存储库 部分，以将里程碑和/或快照存储库添加到您的构建文件中。

此外，您将需要一个已配置的 EmbeddingModel bean。请参阅 EmbeddingModel 部分以获取更多信息。

这是一个所需 bean 的示例

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

要连接到 Pinecone，您需要提供实例的访问详细信息。可以通过 Spring Boot 的 application.properties 提供简单的配置，

spring.ai.vectorstore.pinecone.apiKey=<your api key>
spring.ai.vectorstore.pinecone.environment=<your environment>
spring.ai.vectorstore.pinecone.projectId=<your project id>
spring.ai.vectorstore.pinecone.index-name=<your index name>

# API key if needed, e.g. OpenAI
spring.ai.openai.api.key=<api-key>

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

现在您可以在应用程序中自动装配 Pinecone 向量存储并使用它

@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
vectorStore.add(documents);

// Retrieve documents similar to a query
List<Document> results = this.vectorStore.similaritySearch(SearchRequest.query("Spring").withTopK(5));

配置属性

您可以在 Spring Boot 配置中使用以下属性来自定义 Pinecone 向量存储。

属性 描述 默认值

spring.ai.vectorstore.pinecone.api-key

Pinecone API 密钥

-

spring.ai.vectorstore.pinecone.environment

Pinecone 环境

gcp-starter

spring.ai.vectorstore.pinecone.project-id

Pinecone 项目 ID

-

spring.ai.vectorstore.pinecone.index-name

Pinecone 索引名称

-

spring.ai.vectorstore.pinecone.namespace

Pinecone 命名空间

-

spring.ai.vectorstore.pinecone.content-field-name

用于存储原始文本内容的 Pinecone 元数据字段名称。

document_content

spring.ai.vectorstore.pinecone.distance-metadata-field-name

用于存储计算距离的 Pinecone 元数据字段名称。

distance

spring.ai.vectorstore.pinecone.server-side-timeout

20 秒。

元数据过滤

您可以使用通用的、可移植的 元数据过滤器 与 Pinecone 存储。

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

vectorStore.similaritySearch(
    SearchRequest.defaults()
    .withQuery("The World")
    .withTopK(TOP_K)
    .withSimilarityThreshold(SIMILARITY_THRESHOLD)
    .withFilterExpression("author in ['john', 'jill'] && article_type == 'blog'"));

或使用 Filter.Expression DSL 以编程方式

FilterExpressionBuilder b = new FilterExpressionBuilder();

vectorStore.similaritySearch(SearchRequest.defaults()
    .withQuery("The World")
    .withTopK(TOP_K)
    .withSimilarityThreshold(SIMILARITY_THRESHOLD)
    .withFilterExpression(b.and(
        b.in("author","john", "jill"),
        b.eq("article_type", "blog")).build()));
这些过滤器表达式将转换为等效的 Pinecone 过滤器。

手动配置

如果您希望手动配置 PineconeVectorStore，可以通过创建一个 PineconeVectorStoreConfig bean 并将其传递给 PineconeVectorStore 构造函数来实现。

将这些依赖项添加到您的项目中

  • OpenAI：计算嵌入所需。

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

  • Pinecone

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-pinecone-store</artifactId>
</dependency>
请参阅 依赖项管理 部分，以将 Spring AI BOM 添加到您的构建文件中。

示例代码

要配置应用程序中的 Pinecone，您可以使用以下设置

@Bean
public PineconeVectorStoreConfig pineconeVectorStoreConfig() {

    return PineconeVectorStoreConfig.builder()
        .withApiKey(<PINECONE_API_KEY>)
        .withEnvironment("gcp-starter")
        .withProjectId("89309e6")
        .withIndexName("spring-ai-test-index")
        .withNamespace("") // the free tier doesn't support namespaces.
        .withContentFieldName("my_content") // optional field to store the original content. Defaults to `document_content`
        .build();
}

通过将 Spring Boot OpenAI 启动器添加到您的项目中来集成 OpenAI 的嵌入。这为您提供了嵌入客户端的实现。

@Bean
public VectorStore vectorStore(PineconeVectorStoreConfig config, EmbeddingModel embeddingModel) {
    return new PineconeVectorStore(config, embeddingModel);
}

在您的主代码中，创建一些文档

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")));

将文档添加到 Pinecone

vectorStore.add(documents);

最后，检索与查询类似的文档

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

如果一切顺利，您应该检索包含文本“Spring AI rocks!!”的文档。