LangChain4j 통합 시작하기

새 Java 애플리케이션을 생성합니다.

1. IDE를 열고 새 Java 프로젝트를 생성한 후 다음 구성을 설정합니다.

   • 이름: LangChain4jSampleApp

   • 언어: Java

   • 빌드 시스템: Maven

   • JDK: 다음 이상의 버전 8

   샘플 코드를 포함할 수 있는 옵션이 표시될 수 있습니다. 이 옵션을 선택하면 환경이 제대로 작동하는지 테스트하고, 다음 단계에서 편집할 애플리케이션 파일을 찾는 데 도움이 될 수 있습니다.

종속성을 추가합니다.

1. 프로젝트의 pom.xml 파일에 있는 dependencies 배열에 다음 종속성을 추가합니다. 이러한 종속성은 LangChain4j, LangChain4j용 Voyage AI API 및 MongoDB Java Sync Driver 라이브러리를 애플리케이션에 추가합니다.

   pom.xml

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

2. 다음으로, LangChain4j BOM(Bill of Materials)에 대한 종속성 목록 아래에 dependencyManagement 항목을 추가합니다.

   pom.xml

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

   LangChain4j BOM에 대해 자세히 알아보려면 LangChain4j 문서의 시작하기 페이지를 참조하세요.

   pom.xml 파일 편집을 완료한 후 프로젝트를 다시 로드하여 종속성이 설치되었는지 확인합니다.

클래스 및 메서드를 가져옵니다.

프로젝트에서 메인 애플리케이션 파일 Main.java를 찾으세요. 기존의 import 문이 있다면 아래 목록으로 교체하세요.

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: MongoDB 연결 문자열 로 설정합니다.

• VOYAGE_AI_KEY: Voyage 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?" 구문에 대한 시맨틱 검색 쿼리를 수행하고 가장 관련성이 높은 결과 세 개를 반환합니다. 또한 각 결과가 쿼리와 얼마나 잘 일치하는지를 나타내는 점수를 출력합니다.

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

메타데이터 사전 필터링에 대해 자세히 학습하려면 MongoDB 벡터 검색 사전 필터를 참조하세요.

RAG 프로젝트를 설정합니다.

1. 프로젝트의 pom.xml 파일에 있는 dependencies 배열에 다음 종속성을 추가하되 이미 추가한 종속성은 제거하지 마세요. 이러한 종속성은 LangChain4j AI 서비스 및 LangChain4j 라이브러리의 OpenAI API를 애플리케이션에 추가합니다.

   pom.xml

   <dependency>
       <groupId>dev.langchain4j</groupId>
       <artifactId>langchain4j-open-ai</artifactId>
       <version>1.1.0</version>
   </dependency>
   <dependency>
       <groupId>dev.langchain4j</groupId>
       <artifactId>langchain4j</artifactId>
       <version>1.1.0</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로 데이터를 수집합니다. docs-code-examples GitHub 리포지토리에서 rainforest-docs.json 샘플 데이터 파일을 다운로드하세요. 이 파일의 문서에는 열대 우림의 식물, 동물 및 날씨에 대한 정보가 포함되어 있습니다.

이 파일을 프로젝트의 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 Services 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.