Pinecone

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

Pinecone 是一个流行的云原生向量数据库，它允许您高效地存储和搜索向量。

前提条件

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

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

  3. EmbeddingModel 实例，用于计算文档嵌入。有几种选项可用

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

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

  • Pinecone API 密钥

  • Pinecone 索引名称

  • Pinecone 命名空间

这些信息可在 Pinecone UI 门户中获取。Pinecone 免费套餐不支持命名空间。

自动配置

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

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

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-vector-store-pinecone'
}
请参阅依赖项管理部分，将 Spring AI BOM 添加到您的构建文件中。
请参阅仓库部分，将 Maven Central 和/或 Snapshot 仓库添加到您的构建文件中。

此外，您还需要一个配置好的 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.index-name=<your index name>

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

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

现在您可以在您的应用程序中自动注入 Pinecone Vector Store 并使用它

@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.builder().query("Spring").topK(5).build());

配置属性

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

属性 描述 默认值

spring.ai.vectorstore.pinecone.api-key

Pinecone API 密钥

-

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.builder()
    .query("The World")
    .topK(TOP_K)
    .similarityThreshold(SIMILARITY_THRESHOLD)
    .filterExpression("author in ['john', 'jill'] && article_type == 'blog'").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("author","john", "jill"),
        b.eq("article_type", "blog")).build()).build());
这些过滤器表达式将被转换为等效的 Pinecone 过滤器。

手动配置

如果您更喜欢手动配置 PineconeVectorStore，可以使用 PineconeVectorStore#Builder 进行。

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

  • OpenAI：计算嵌入所需。

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

  • Pinecone

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

示例代码

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

@Bean
public VectorStore pineconeVectorStore(EmbeddingModel embeddingModel) {
    return PineconeVectorStore.builder(embeddingModel)
            .apiKey(PINECONE_API_KEY)
            .indexName(PINECONE_INDEX_NAME)
            .namespace(PINECONE_NAMESPACE) // the free tier doesn't support namespaces.
            .contentFieldName(CUSTOM_CONTENT_FIELD_NAME) // optional field to store the original content. Defaults to `document_content`
            .build();
}

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

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").topK(5).build());

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

访问原生客户端

Pinecone Vector Store 实现通过 getNativeClient() 方法提供对底层原生 Pinecone 客户端（PineconeConnection）的访问

PineconeVectorStore vectorStore = context.getBean(PineconeVectorStore.class);
Optional<PineconeConnection> nativeClient = vectorStore.getNativeClient();

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

原生客户端允许您访问 Pinecone 特有的功能和操作，这些功能和操作可能不会通过 VectorStore 接口暴露。