Pinecone

このセクションでは、ドキュメントの埋め込みを保存し、類似性検索を実行するための Pinecone VectorStore のセットアップについて説明します。

Pinecone (英語) は人気のあるクラウドベースのベクトルデータベースで、ベクトルを効率的に保存および検索できます。

前提条件

  1. Pinecone アカウント: 始める前に、Pinecone アカウント (英語) にサインアップしてください。

  2. Pinecone プロジェクト: 登録したら、API キーを生成し、インデックスを作成します。設定にはこれらの詳細が必要になります。

  3. EmbeddingModel インスタンスを使用してドキュメントの埋め込みを計算します。いくつかのオプションが利用可能です:

    • 必要に応じて、EmbeddingModel が PineconeVectorStore によって保存される埋め込みを生成するための API キー。

PineconeVectorStore を設定するには、Pinecone アカウントから次の詳細を収集します。

  • Pinecone API キー

  • Pinecone インデックス名

  • Pinecone ネームスペース

この情報は、Pinecone UI ポータルで入手できます。名前空間のサポートは、Pinecone のフリーレベルでは利用できません。

自動構成

Spring AI 自動構成、スターターモジュールのアーティファクト名に大きな変更がありました。詳細については、アップグレードノートを参照してください。

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 Central リポジトリやスナップショットリポジトリを追加します。

さらに、設定済みの 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 ベクトルストアをアプリケーションに自動接続して使用できるようになりました。

@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 ベクトルストアの実装は、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
}

ネイティブクライアントを使用すると、VectorStore インターフェースでは公開されない可能性のある Pinecone 固有の機能や操作にアクセスできます。