🦜️ LangChain Java

LangChain 的 Java 版本，助力大数据领域的大型语言模型（LLM）应用。

它充当了大数据领域中 LLM 领域的桥梁，主要面向 Java 技术栈。

如果您感兴趣，可以加我微信：HamaWhite，或发送邮件至 我。

1. 这是什么？

这是 LangChain 的 Java 语言实现，旨在让开发基于 LLM 的应用尽可能简单。

以下示例位于 langchain-example 中。

• SQL 链
• API 链
• RAG Milvus
• RAG Pinecone
• 摘要生成
• Google 搜索代理
• Spark SQL 代理
• Flink SQL 代理

2. 集成

2.1 大型语言模型

• OpenAI [流式处理]
• Azure OpenAI
• ChatGLM2
• Ollama

2.2 向量存储

• Pinecone
• Milvus

3. 快速入门指南

API 文档可在以下链接获取：
https://hamawhitegg.github.io/langchain-java

3.1 Maven 仓库

构建前提条件：

• Java 17 或更高版本
• 类 Unix 环境（我们使用 Linux、Mac OS X）
• Maven（推荐版本 3.8.6，最低要求 3.5.4）

<dependency>
    <groupId>io.github.hamawhitegg</groupId>
    <artifactId>langchain-core</artifactId>
    <version>0.2.1</version>
</dependency>

3.2 环境设置

使用 LangChain 通常需要与一个或多个模型提供商、数据存储、API 等集成。 在本示例中，我们将使用 OpenAI 的 API。

接下来我们需要设置环境变量。

export OPENAI_API_KEY=xxx

# 如果需要代理，设置 OPENAI_PROXY 环境变量。
export OPENAI_PROXY=http://host:port

如果您想动态设置 API 密钥和代理，可以在初始化 OpenAI 类时使用 openaiApiKey 和 openaiProxy 参数。

var llm = OpenAI.builder()
        .openaiOrganization("xxx")
        .openaiApiKey("xxx")
        .openaiProxy("http://host:port")
        .requestTimeout(16)
        .build()
        .init();

3.3 大型语言模型

从语言模型获取预测结果。LangChain 的基本构建块是 LLM，它接收文本并生成更多文本。

OpenAI 示例

var llm = OpenAI.builder()
        .temperature(0.9f)
        .build()
        .init();

var result = llm.predict("一家生产彩色袜子的公司，起个好听的公司名会是什么？");
print(result);

现在我们可以传入文本并获取预测结果！

趣味十足

3.4 聊天模型

聊天模型是语言模型的一种变体。虽然聊天模型底层使用的是语言模型，但它们提供的接口略有不同：不是“输入文本，输出文本”的 API，而是以“聊天消息”作为输入和输出的接口。

OpenAI 聊天示例

var chat = ChatOpenAI.builder()
        .temperature(0)
        .build()
        .init();

var result = chat.predictMessages(List.of(new HumanMessage("将这句话从英语翻译成法语。我喜欢编程。")));
println(result);

AIMessage{content='J'adore la programmation.', additionalKwargs={}}

了解聊天模型与普通 LLM 的区别很有用，但很多时候直接把它们当作普通 LLM 来处理也很方便。LangChain 通过提供一个接口，让您能像操作普通 LLM 一样与聊天模型交互。您可以通过 predict 接口访问这一功能。

var output = chat.predict("将这句话从英语翻译成法语。我喜欢编程。");
println(output);

J'adore la programmation.

3.5 链

现在我们已经有了一个模型和一个提示模板，接下来就需要将两者结合起来。链为我们提供了一种将多个原语（如模型、提示和其他链）链接（或串联）起来的方式。

3.5.1 大语言模型

最简单也最常见的链类型是LLMChain，它会先将输入传递给PromptTemplate，然后再传递给大语言模型。我们可以用现有的模型和提示模板来构建一个LLMChain。

LLM Chain 示例

var prompt = PromptTemplate.fromTemplate("What is a good name for a company that makes {product}?");

var chain = new LLMChain(llm, prompt);
var result = chain.run("colorful socks");
println(result);

Feetful of Fun

3.5.2 聊天模型

LLMChain同样可以用于聊天模型：

LLM 聊天链 示例

var template = "You are a helpful assistant that translates {input_language} to {output_language}.";
var systemMessagePrompt = SystemMessagePromptTemplate.fromTemplate(template);
var humanMessagePrompt = HumanMessagePromptTemplate.fromTemplate("{text}");
var chatPrompt = ChatPromptTemplate.fromMessages(List.of(systemMessagePrompt, humanMessagePrompt));

var chain = new LLMChain(chat, chatPrompt);
var result = chain.run(Map.of("input_language", "English", "output_language", "French", "text", "I love programming."));
println(result);

J'adore la programmation.

3.5.1 SQL 链 示例

大语言模型使得我们能够通过自然语言与SQL数据库交互，LangChain提供了SQL链，以便根据自然语言提示构建并运行SQL查询。

SQL 链 示例

var database = SQLDatabase.fromUri("jdbc:mysql://127.0.0.1:3306/demo", "xxx", "xxx");

var chain = SQLDatabaseChain.fromLLM(llm, database);
var result = chain.run("How many students are there?");
println(result);

result = chain.run("Who got zero score? Show me her parent's contact information.");
println(result);

There are 6 students.

The parent of the student who got zero score is Tracy and their contact information is 088124.

可用的语言如下。

语言	值
英语（默认）	en_US
葡萄牙语（巴西）	pt_BR

如果你想选择其他语言而非英语，只需在你的主机上设置环境变量。如果没有设置，则默认为en-US。

export USE_LANGUAGE=pt_BR

3.6 智能体

我们第一个链执行的是预定义的步骤序列。为了处理复杂的工作流，我们需要能够根据输入动态地选择行动。

智能体正是这样做的：它们使用语言模型来决定采取哪些行动以及以什么顺序执行。智能体被赋予工具访问权限，它们会反复选择一个工具、运行该工具，并观察输出，直到得出最终答案。

设置合适的环境变量。

export SERPAPI_API_KEY=xxx

3.6.1 Google 搜索智能体示例

通过使用搜索和计算器工具，增强OpenAI超越2021年的知识储备和计算能力。

Google 搜索智能体示例

// 'llm-math' 工具使用大语言模型
var tools = loadTools(List.of("serpapi", "llm-math"), llm);

var agent = initializeAgent(tools, chat, AgentType.CHAT_ZERO_SHOT_REACT_DESCRIPTION);
var query = "How many countries and regions participated in the 2023 Hangzhou Asian Games?" +
        "What is that number raised to the .023 power?";

agent.run(query);

4. 从源码运行测试用例

git clone https://github.com/HamaWhiteGG/langchain-java.git
cd langchain-java

# export JAVA_HOME=JDK17_INSTALL_HOME && mvn clean test
mvn clean test

本项目使用Spotless来格式化代码。如果你做了任何修改，请记得使用以下命令格式化代码。

# export JAVA_HOME=JDK17_INSTALL_HOME && mvn spotless:apply
mvn spotless:apply

5. 支持

如有任何问题，请随时提问！

如果在langchain-java中发现了bug，请打开一个问题。

6. 打赏

如果这个项目对你有所帮助，你可以请我喝杯咖啡。

这是一个微信赞赏码。

LangChain Java 快速上手指南

环境准备

• Java 版本：JDK 17 或更高
• 操作系统：Linux / macOS（推荐 Unix-like 环境）
• 构建工具：Maven 3.5.4+（推荐 3.8.6）

如需使用 OpenAI 等外部服务，请确保网络可访问，或配置代理。

安装步骤

1. 添加 Maven 依赖（中央仓库）：

<dependency>
    <groupId>io.github.hamawhitegg</groupId>
    <artifactId>langchain-core</artifactId>
    <version>0.2.1</version>
</dependency>

2. 设置 OpenAI API 密钥（如使用 OpenAI）：

export OPENAI_API_KEY=xxx
# 可选：设置代理
export OPENAI_PROXY=http://host:port

3. 克隆示例项目（可选）：

git clone https://github.com/HamaWhiteGG/langchain-java.git
cd langchain-java
mvn clean test

如需代码格式化：mvn spotless:apply

基本使用

最简 LLM 调用示例

import com.hw.langchain.llms.OpenAI;

var llm = OpenAI.builder()
    .temperature(0.9f)
    .build()
    .init();

var result = llm.predict("What would be a good company name for a company that makes colorful socks?");
System.out.println(result);

输出示例：

Feetful of Fun

Chat 模型调用示例

import com.hw.langchain.chat.models.ChatOpenAI;
import com.hw.langchain.messages.HumanMessage;

var chat = ChatOpenAI.builder()
    .temperature(0)
    .build()
    .init();

var result = chat.predict("Translate this sentence from English to French. I love programming.");
System.out.println(result);

输出示例：

J'adore la programmation.

所有示例代码详见：langchain-examples