|
此版本仍在开发中，尚未被视为稳定版。如需最新的快照版本，请使用 Spring AI 1.1.3！ |
Pinecone
本节将指导您设置 Pinecone VectorStore 以存储文档嵌入并执行相似性搜索。
Pinecone 是一个流行的基于云的向量数据库，它允许您高效地存储和搜索向量。
前置条件
-
Pinecone 账户：在开始之前，请注册一个 Pinecone 账户。
-
Pinecone 项目：注册后，生成一个 API 密钥并创建一个索引。您需要这些详细信息进行配置。
-
EmbeddingModel实例用于计算文档嵌入。有几种选项可供选择：-
如果需要，为EmbeddingModel提供一个API密钥，用于生成由
PineconeVectorStore存储的嵌入向量。
-
要设置 PineconeVectorStore，请从您的 Pinecone 账户中收集以下详细信息：
-
Pinecone API 密钥
-
Pinecone 索引名称
-
Pinecone 命名空间
|
您可以在 Pinecone UI 门户中获取此信息。 Pinecone 免费版不支持命名空间功能。 |
Auto-configuration
|
Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。 |
Spring AI 为 Pinecone 向量存储提供了 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 中央仓库和/或快照仓库添加到您的构建文件中。 |
此外，您还需要一个已配置的 EmbeddingModel bean。有关更多信息，请参阅 EmbeddingModel 部分。
这是所需 bean 的示例：
@Bean
public EmbeddingModel embeddingModel() {
// Can be any other EmbeddingModel implementation.
return new OpenAiEmbeddingModel(new OpenAiApi(System.getenv("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 向量存储并使用它
@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 向量存储。
| <property> </property> | <description> </description> | 默认值 |
|---|---|---|
|
Pinecone API 密钥 |
- |
|
Pinecone 索引名称 |
- |
|
Pinecone 命名空间 |
- |
|
用于存储原始文本内容的 Pinecone 元数据字段名称。 |
|
|
用于存储计算距离的 Pinecone 元数据字段名称。 |
|
|
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 向量存储实现通过 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 接口暴露。