Pinecone

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

Pinecone 是一种流行的基于云的矢量数据库，可让您有效地存储和搜索矢量。spring-doc.cn

先决条件

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

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

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

要设置 ，请从您的 Pinecone 帐户中收集以下详细信息：PineconeVectorStorespring-doc.cn

此信息可在 Pinecone UI 门户中获得。spring-doc.cn

自动配置

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

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

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

dependencies {
    implementation 'org.springframework.ai:spring-ai-pinecone-store-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")));
}

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

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>

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

现在，您可以在应用程序中自动连接 Pinecone 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
vectorStore.add(documents);

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

配置属性

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

财产 描述 默认值

spring.ai.vectorstore.pinecone.api-keyspring-doc.cn

Pinecone API 密钥spring-doc.cn

-spring-doc.cn

spring.ai.vectorstore.pinecone.environmentspring-doc.cn

Pinecone环境spring-doc.cn

gcp-starterspring-doc.cn

spring.ai.vectorstore.pinecone.project-idspring-doc.cn

Pinecone 项目 IDspring-doc.cn

-spring-doc.cn

spring.ai.vectorstore.pinecone.index-namespring-doc.cn

Pinecone指数名称spring-doc.cn

-spring-doc.cn

spring.ai.vectorstore.pinecone.namespacespring-doc.cn

Pinecone 命名空间spring-doc.cn

-spring-doc.cn

spring.ai.vectorstore.pinecone.content-field-namespring-doc.cn

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

document_contentspring-doc.cn

spring.ai.vectorstore.pinecone.distance-metadata-field-namespring-doc.cn

用于存储计算距离的 Pinecone 元数据字段名称。spring-doc.cn

distancespring-doc.cn

spring.ai.vectorstore.pinecone.server-side-timeoutspring-doc.cn

20 秒spring-doc.cn

元数据筛选

您可以将通用的可移植元数据过滤器与 Pinecone 商店结合使用。spring-doc.cn

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

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

或使用 DSL 以编程方式：Filter.Expressionspring-doc.cn

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 筛选条件。

手动配置

如果您更喜欢手动配置，可以通过创建一个 bean 来实现 并将其传递给构造函数。PineconeVectorStorePineconeVectorStoreConfigPineconeVectorStorespring-doc.cn

将这些依赖项添加到您的项目中：spring-doc.cn

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

示例代码

要在应用程序中配置 Pinecone，您可以使用以下设置：spring-doc.cn

@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 Starters添加到您的项目，与 OpenAI 的嵌入集成。 这为您提供了 Embeddings 客户端的实现：spring-doc.cn

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

在您的主代码中，创建一些文档：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("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：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