From d12c54de5ef5f3c1b4eb2db39129bc85f5163bcb Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:46:25 +0000 Subject: [PATCH] docs: preserve upstream English README --- README.en.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..d38c72d --- /dev/null +++ b/README.en.md @@ -0,0 +1,85 @@ +# LangChain4j: idiomatic, open-source Java library for building LLM-powered applications on the JVM + +[![Build Status](https://img.shields.io/github/actions/workflow/status/langchain4j/langchain4j/main.yaml?branch=main&style=for-the-badge&label=CI%20BUILD&logo=github)](https://github.com/langchain4j/langchain4j/actions/workflows/main.yaml) +[![Nightly Build](https://img.shields.io/github/actions/workflow/status/langchain4j/langchain4j/nightly_jdk17.yaml?branch=main&style=for-the-badge&label=NIGHTLY%20BUILD&logo=github)](https://github.com/langchain4j/langchain4j/actions/workflows/nightly_jdk17.yaml) +[![CODACY](https://img.shields.io/badge/Codacy-Dashboard-blue?style=for-the-badge&logo=codacy)](https://app.codacy.com/gh/langchain4j/langchain4j/dashboard) + +[![Discord](https://img.shields.io/discord/1156626270772269217?logo=discord&style=for-the-badge)](https://discord.gg/JzTFvyjG6R) +[![BlueSky](https://img.shields.io/badge/@langchain4j-follow-blue?logo=bluesky&style=for-the-badge)](https://bsky.app/profile/langchain4j.dev) +[![X](https://img.shields.io/badge/@langchain4j-follow-blue?logo=x&style=for-the-badge)](https://x.com/langchain4j) +[![Maven Version](https://img.shields.io/maven-central/v/dev.langchain4j/langchain4j?logo=apachemaven&style=for-the-badge)](https://search.maven.org/#search|gav|1|g:"dev.langchain4j"%20AND%20a:"langchain4j") + + +## Introduction + +Welcome! + +The goal of LangChain4j is to simplify integrating LLMs into Java applications. + +Here's how: +1. **Unified APIs:** + LLM providers (like OpenAI or Google Vertex AI) and embedding (vector) stores (such as Pinecone or Milvus) + use proprietary APIs. LangChain4j offers a unified API to avoid the need for learning and implementing specific APIs for each of them. + To experiment with different LLMs or embedding stores, you can easily switch between them without the need to rewrite your code. + LangChain4j currently supports [20+ popular LLM providers](https://docs.langchain4j.dev/integrations/language-models/) + and [30+ embedding stores](https://docs.langchain4j.dev/integrations/embedding-stores/). +2. **Comprehensive Toolbox:** + Since early 2023, the community has been building numerous LLM-powered applications, + identifying common abstractions, patterns, and techniques. LangChain4j has refined these into practical code. + Our toolbox includes tools ranging from low-level prompt templating, chat memory management, and function calling + to high-level patterns like Agents and RAG. + For each abstraction, we provide an interface along with multiple ready-to-use implementations based on common techniques. + Whether you're building a chatbot or developing a RAG with a complete pipeline from data ingestion to retrieval, + LangChain4j offers a wide variety of options. +3. **Numerous Examples:** + These [examples](https://github.com/langchain4j/langchain4j-examples) showcase how to begin creating various LLM-powered applications, + providing inspiration and enabling you to start building quickly. + +LangChain4j began development in early 2023 amid the ChatGPT hype. +We noticed a lack of Java counterparts to the numerous Python and JavaScript LLM libraries and frameworks, +and we had to fix that! + +**Despite the name, LangChain4j is not a Java port of LangChain (Python) — it is built for Java, not ported to it.** +It is an idiomatic Java library designed from the ground up around Java conventions: +type safety, POJOs, annotations, interfaces, dependency injection, fluent APIs, and first-class integrations with Quarkus, Spring Boot, Helidon, and Micronaut. +Its API, internals, and release cycle are independent of the Python LangChain project. + +We actively monitor community developments, aiming to quickly incorporate new techniques and integrations, +ensuring you stay up-to-date. +The library is under active development. While some features are still being worked on, +the core functionality is in place, allowing you to start building LLM-powered apps now! + + +## Documentation +Documentation can be found [here](https://docs.langchain4j.dev). + +The documentation chatbot (experimental) can be found [here](https://chat.langchain4j.dev/). + + +## Getting Started +Getting started guide can be found [here](https://docs.langchain4j.dev/get-started). + + +## Code Examples +Please see examples of how LangChain4j can be used in [langchain4j-examples](https://github.com/langchain4j/langchain4j-examples) repo: +- [Examples in plain Java](https://github.com/langchain4j/langchain4j-examples/tree/main/other-examples/src/main/java) +- [Examples with Quarkus](https://github.com/quarkiverse/quarkus-langchain4j/tree/main/samples) (uses [quarkus-langchain4j](https://github.com/quarkiverse/quarkus-langchain4j) dependency) +- [Example with Spring Boot](https://github.com/langchain4j/langchain4j-examples/tree/main/spring-boot-example/src/main/java/dev/langchain4j/example) +- [Examples with Helidon](https://github.com/helidon-io/helidon-examples/tree/helidon-4.x/examples/integrations/langchain4j) (uses [io.helidon.integrations.langchain4j](https://mvnrepository.com/artifact/io.helidon.integrations.langchain4j) dependency) +- [Examples with Micronaut](https://github.com/micronaut-projects/micronaut-langchain4j/tree/0.3.x/doc-examples/example-openai-java) (uses [micronaut-langchain4j](https://micronaut-projects.github.io/micronaut-langchain4j/latest/guide/) dependency) + +## Useful Materials +Useful materials can be found [here](https://docs.langchain4j.dev/useful-materials). + + +## Get Help +Please use [Discord](https://discord.gg/JzTFvyjG6R) or [GitHub discussions](https://github.com/langchain4j/langchain4j/discussions) +to get help. + + +## Request Features +Please let us know what features you need by [opening an issue](https://github.com/langchain4j/langchain4j/issues/new/choose). + + +## Contribute +Contribution guidelines can be found [here](https://github.com/langchain4j/langchain4j/blob/main/CONTRIBUTING.md).