LgChuin4j 統合を使い始める

新しいJavaアプリケーションを作成します。

1. IDE を開き、新しいJavaプロジェクトを作成し、次の構成を設定します。

   • 名前: LgChuin4jSampleApp

   • 言語: Java

   • ビルド システム: Maven

   • JDK: 8 より大きいバージョン

   サンプルコードを含めるオプションが表示される場合があります。このオプションを選択すると、環境が動作することをテストし、次の手順で編集するアプリケーションファイルを見つけることができます。

依存関係を追加します。

1. プロジェクトの pom.xmlファイル内の dependencies 配列に次の依存関係を追加します。これらの依存関係により、Lgachein4j、Lgachein4j 用の Vyage AI API 、およびMongoDB Java Sync ドライバー ライブラリがアプリケーションに追加されます。

   pom.xml

   <dependency>
       <groupId>dev.langchain4j</groupId>
       <artifactId>langchain4j-mongodb-atlas</artifactId>
       <version>1.0.0-beta1</version>
   </dependency>
   <dependency>
       <groupId>dev.langchain4j</groupId>
       <artifactId>langchain4j-voyage-ai</artifactId>
       <version>1.0.0-beta1</version>
   </dependency>
   <dependency>
       <groupId>org.mongodb</groupId>
       <artifactId>mongodb-driver-sync</artifactId>
       <version>5.4.0</version>
   </dependency>

2. 次に、LgChuin4j のアイテム請求書（BOM）の依存関係リストの下に dependencyManagement エントリを追加します。

   pom.xml

   <dependencyManagement>
       <dependencies>
           <dependency>
               <groupId>dev.langchain4j</groupId>
               <artifactId>langchain4j-bom</artifactId>
               <version>1.0.0-beta1</version>
               <type>pom</type>
               <scope>import</scope>
           </dependency>
       </dependencies>
   </dependencyManagement>

   4Lg以前、4

   pom.xmlファイルの編集が終了したら、プロジェクトを再読み込みして、依存関係がインストールされていることを確認します。

クラスとメソッドをインポートします。

プロジェクトでメインのアプリケーションファイルMain.java を見つけます。既存のインポートを次のインポートのリストに置き換えます。

import com.mongodb.client.MongoClient;
import com.mongodb.client.MongoClients;
import dev.langchain4j.data.document.Metadata;
import dev.langchain4j.data.embedding.Embedding;
import dev.langchain4j.data.segment.TextSegment;
import dev.langchain4j.model.embedding.EmbeddingModel;
import dev.langchain4j.model.voyageai.VoyageAiEmbeddingModel;
import dev.langchain4j.store.embedding.EmbeddingMatch;
import dev.langchain4j.store.embedding.EmbeddingSearchRequest;
import dev.langchain4j.store.embedding.EmbeddingSearchResult;
import dev.langchain4j.store.embedding.filter.comparison.*;
import dev.langchain4j.store.embedding.mongodb.IndexMapping;
import dev.langchain4j.store.embedding.mongodb.MongoDbEmbeddingStore;
import org.bson.Document;
import java.io.*;
import java.util.*;

このチュートリアルの後半では、これらのクラスとメソッドを使用してベクトル埋め込みとクエリ データを作成します。

環境変数を設定します。

IDE によっては、アプリケーションが取得できる環境変数を設定する方法が複数ある場合があります。 IntelliJ で環境変数を設定するには、アプリケーションの実行構成を作成する必要があります。詳細については、IntelliJ ドキュメントの「 実行/デバッグ構成: アプリケーション 」ページの「 オペレーティング システム 」セクションを参照してください。

次の環境変数を設定します。

• MONGODB_URI: Atlas接続文字列に設定します。

• VOYAGE_AI_KEY: 投票AI APIキーに設定します。

mongodb+srv://<db_username>:<db_password>@<clusterName>.<hostname>.mongodb.net/?<settings>

環境変数を取得します。

環境変数を取得するには、アプリケーションの Main.javaファイルのメイン メソッド内に次のコードを追加します。

String embeddingApiKey = System.getenv("VOYAGE_AI_KEY");
String uri = System.getenv("MONGODB_URI");

セマンティック検索を実行します。

このコードでは、"Where do penguins live?" というフレーズのセマンティック検索クエリーが実行され、最も関連性の高い結果が 3 つ返されます。また、各結果がクエリにどの程度一致するかを取得するスコアも出力します。

次のコードを Main.javaファイルに追加します。

String query = "Where do penguins live?";
Embedding queryEmbedding = embeddingModel.embed(query).content();
EmbeddingSearchRequest searchRequest = EmbeddingSearchRequest.builder()
        .queryEmbedding(queryEmbedding)
        .maxResults(3)
        .build();
System.out.println("Performing the query...");
EmbeddingSearchResult<TextSegment> searchResult = embeddingStore.search(searchRequest);
List<EmbeddingMatch<TextSegment>> matches = searchResult.matches();
for (EmbeddingMatch<TextSegment> embeddingMatch : matches) {
    System.out.println("Response: " + embeddingMatch.embedded().text());
    System.out.println("Author: " + embeddingMatch.embedded().metadata().getString("author"));
    System.out.println("Score: " + embeddingMatch.score());
}

Response: Penguins are flightless seabirds that live almost exclusively below the equator. Some island-dwellers can be found in warmer climates.
Author: C
Score: 0.829620897769928
Response: Patagonia is home to five penguin species - Magellanic, Humboldt, Gentoo, Southern Rockhopper and King.
Author: B
Score: 0.7459062337875366
Response: Emperor penguins are the tallest and heaviest of all penguin species, standing up to 4 feet.
Author: D
Score: 0.6908764839172363

（任意）メタデータ フィルタリングを使用してセマンティック検索を実行します。

メタデータフィルタリングを使用して検索を実行するには、dev.langchain4j.store.embedding.filter.comparisonパッケージのクラスを使用できます。これらの クラスを使用すると、メタデータ値を指定された値と比較するフィルターを作成して、検索によって返される結果を絞り込むことができます。

この例では、authorフィールドの値が "B" または "C" のいずれであるドキュメントをフィルタリングします。次に、"Where do penguins live?" というフレーズのセマンティック検索クエリーを実行します。

前の手順の EmbeddingSearchRequestインスタンスをインスタンス化するコードを次のコードで置き換えます。

EmbeddingSearchRequest searchRequest = EmbeddingSearchRequest.builder()
        .queryEmbedding(queryEmbedding)
        .filter(new IsIn("author", List.of("B", "C")))
        .maxResults(3)
        .build();

Response: Penguins are flightless seabirds that live almost exclusively below the equator. Some island-dwellers can be found in warmer climates.
Author: C
Score: 0.8520907163619995
Response: Patagonia is home to five penguin species - Magellanic, Humboldt, Gentoo, Southern Rockhopper and King.
Author: B
Score: 0.7666836977005005

メタデータの事前フィルタリングの詳細については、「 Atlas Vector Search の事前フィルター 」を参照してください。

RaG のプロジェクトを設定する。

1. dependenciesプロジェクトのpom.xml ファイル内の 配列に次の依存関係を追加しますが、すでに追加した依存関係は削除しません。これらの依存関係により、LlangCharin4 j AIサービスと Lgachein4 j ライブラリ用の OpenAI APIがアプリケーションに追加されます。

   pom.xml

   <dependency>
       <groupId>dev.langchain4j</groupId>
       <artifactId>langchain4j-open-ai</artifactId>
       <version>1.0.0-beta1</version>
   </dependency>
   <dependency>
       <groupId>dev.langchain4j</groupId>
       <artifactId>langchain4j</artifactId>
       <version>1.0.0-beta1</version>
   </dependency>

   pom.xmlファイルの編集が終了したら、プロジェクトを再読み込みして、依存関係がインストールされていることを確認します。

2. 次のインポートを Main.javaファイルのインポート リストに追加します。

   import com.fasterxml.jackson.core.type.TypeReference;
   import com.fasterxml.jackson.databind.ObjectMapper;
   import dev.langchain4j.service.AiServices;
   import dev.langchain4j.model.chat.ChatLanguageModel;
   import dev.langchain4j.model.openai.OpenAiChatModel;
   import dev.langchain4j.rag.content.retriever.ContentRetriever;
   import dev.langchain4j.rag.content.retriever.EmbeddingStoreContentRetriever;

3. OPENAI_KEY 環境変数を OpenAI APIキー に設定します。このキーを使用して、クエリに対する応答を生成するチャットモデルを作成します。

サンプル データをロードします。

この手順では、外部ソースから Atlas にデータを取り込みます。 MongoDB リポジトリから Rails.jsonサンプルデータファイルをダウンロードします。このファイルのドキュメントには、夏時間の植物、移動、気象に関する情報が含まれています。docs-code-examples

このファイルをプロジェクト内の resourcesディレクトリにアップロードします。このディレクトリは、アプリケーションファイルを含む javaディレクトリと同じレベルにあります。

から埋め込みを作成し、Atlas に永続化できる形式にデータを処理する必要があります。このコードでは、次のアクションを実行する loadJsonDocuments() メソッドを定義します。

• ClassLoaderクラスを使用して、resourcesディレクトリからサンプルデータを取得します

• ObjectMapperクラスを使用して、 JSONドキュメントをMongoDB Document インスタンスの List に解析します

次のコードを メイン メソッドの外部 の Main.javaファイルに追加します。

private static List<Document> loadJsonDocuments(String resourcePath) throws IOException {
    // Loads file from resources directory using the ClassLoader
    InputStream inputStream = Main.class.getClassLoader().getResourceAsStream(resourcePath);
    if (inputStream == null) {
        throw new FileNotFoundException("Resource not found: " + resourcePath);
    }
    // Parses JSON file to List of MongoDB Documents
    ObjectMapper objectMapper = new ObjectMapper();
    List<Document> documents = objectMapper.readValue(inputStream, new TypeReference<>() {});
    return documents;
}

次に、メイン メソッド本体に次のコードを追加して、loadJsonDocuments() メソッドを呼び出してドキュメントをロードします。

System.out.println("Loading documents from file...");
String resourcePath = "rainforest-docs.json";
List<Document> documents = loadJsonDocuments(resourcePath);

Atlas にベクトル埋め込みを保存します。

この手順では、サンプルドキュメントからベクトル埋め込みを作成し、それを Atlas に永続化します。

このコードは、サンプルドキュメント内の text フィールドの内容を埋め込みに変換し、データを Atlas に永続化します。コードにはベクトル変換に必要な時間に対応するための遅延が含まれています。

次のコードを Main.javaファイルに追加します。

System.out.println("Persisting document embeddings...");
for (Document doc : documents) {
    TextSegment segment = TextSegment.from(
            doc.getString("text"),
            new Metadata(doc.get("metadata", Map.class)));
    Embedding embedding = embeddingModel.embed(segment).content();
    embeddingStore.add(embedding, segment);
}
try {
    Thread.sleep(5000);
} catch (InterruptedException e) {
    throw new RuntimeException(e);
}

チャット モデルをインスタンス化し、コンテンツ検索を指定します。

この手順では、OpenAI からチャット モデルをインスタンス化して、データに基づいて質問に回答できるようにします。また、関連ドキュメントを表示して、チャット モデルによって作成された応答に通知するコンテンツ検索も指定します。

このコードは、次のアクションを実行します。

• OpenAI APIキーを使用して、チャットモデルをインスタンス化します

• 次の仕様でコンテンツリゾルバを作成します。

  • 最大で 3 の関連ドキュメントを検索

  • 関連性スコアが 0.75 以上のドキュメントを取得します

次のコードを メソッド本体の Main.javaファイルに追加します。

String chatApiKey = System.getenv("OPENAI_KEY");
ChatLanguageModel chatModel = OpenAiChatModel.builder()
        .apiKey(chatApiKey)
        .modelName("gpt-4")
        .build();
ContentRetriever contentRetriever = EmbeddingStoreContentRetriever.builder()
        .embeddingStore(embeddingStore)
        .embeddingModel(embeddingModel)
        .maxResults(3)
        .minScore(0.75)
        .build();

チャット 支援を作成します。

アプリケーションにAIサービスAPIを実装する単純な Assistant インターフェースを作成します。 Main.javaファイルと同じレベルに Assistant.java というインターフェースファイルを作成します。

Assistant インターフェースを定義します。

package org.example;
public interface Assistant {
    String answer(String question);
}

Main.javaファイルで、Assistant をインスタンス化します。

Assistant assistant = AiServices.builder(Assistant.class)
        .chatLanguageModel(chatModel)
        .contentRetriever(contentRetriever)
        .build();

データに対してクエリを実行します。

最後に、サンプルデータに対してクエリを実行します。クエリを実行して出力を印刷するには、Main.javaファイルに次のコードを追加します。

String ragQuery = "What types of insects live in the rainforest?";
String output = assistant.answer(ragQuery);
System.out.println("Response:\n" + output);

Response:
In the rainforest, there are numerous species of insects
such as beetles, butterflies, moths, wasps, bees, flies, and
ants. Of the many insects that live in the rainforest, ants
are particularly important as they play a crucial role in
nutrient recycling and aeration of the soil. Moreover, many
of these insects are involved in the processes of
pollination and decomposition. The adaptations these insects
have developed enable their survival in the rainforest's
specific conditions, characterized by heavy rainfall.