Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/showpune/spring-petclinic-langchain4j
It is a langchain4j LLM demo of petclinic
https://github.com/showpune/spring-petclinic-langchain4j
langchain4j llm openai petclinic springboot
Last synced: about 1 month ago
JSON representation
It is a langchain4j LLM demo of petclinic
- Host: GitHub
- URL: https://github.com/showpune/spring-petclinic-langchain4j
- Owner: showpune
- License: apache-2.0
- Created: 2024-05-11T01:49:30.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-09-11T00:39:01.000Z (2 months ago)
- Last Synced: 2024-09-11T05:03:09.788Z (2 months ago)
- Topics: langchain4j, llm, openai, petclinic, springboot
- Language: CSS
- Homepage:
- Size: 760 KB
- Stars: 9
- Watchers: 1
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Spring PetClinic Sample Application With OpenAI and Langchain4j
## Understanding the Spring Petclinic application with a few diagrams
This is the spring langchain4j version for spring petclinic, if you want to see a springai version, please refer to [spring-petclinic-springai](https://github.com/showpune/spring-petclinic-springai)
## Run Petclinic locally
Spring Petclinic is a [Spring Boot](https://spring.io/guides/gs/spring-boot) application built
using [Maven](https://spring.io/guides/gs/maven/). You can build a jar
file and run it from the command line (it should work just as well with Java 17 or newer), Before you build the application, you need to setup some openai properties in `src/main/resources/application.properties`:
```bash
git clone https://github.com/showpune/spring-petclinic-langchain4j.git
cd spring-petclinic-langchain4j
mv src/main/resources/application.properties.example src/main/resources/application.properties
```
edit the `src/main/resources/application.properties` file and add the following properties:
```properties
langchain4j.azure.open-ai.chat-model.endpoint=https://*****.openai.azure.com/
langchain4j.azure.open-ai.chat-model.deployment-name=gpt-4
langchain4j.azure.open-ai.chat-model.api-key=**
```
You can build the application by running the following command:
```bash
./mvnw package
java -jar target/*.jar
```
You can then access the Petclinic at
And the OpenAI chatbot at .
## The Sequence workflow of langchain4j
## Workthrough of the chat agent
You can talk with the agent, it can help to recommend the vet according to the symptoms of the pet. The agent can also help to book an appointment with the vet.
Go to the owner page, you can see you are registered as an owner with the help of the agent
## LLM Progamming
Normally a LLM application contains 5 parts: Prompt, Model, Memory, Native Functions( tools ）and RAG (content retriever)
### Prompt
The prompt is defined in [agent](https://github.com/showpune/spring-petclinic-langchain4j/blob/master/src/main/java/org/springframework/samples/petclinic/chat/Agent.java)
### Model
The model is is defined in [model](https://github.com/showpune/spring-petclinic-langchain4j/blob/3d2dcc1c303a7352f681892bb0871dbea1daaebd/src/main/java/org/springframework/samples/petclinic/chat/AgentConfig.java#L36), the model can be used for [chat](https://github.com/showpune/spring-petclinic-langchain4j/blob/3d2dcc1c303a7352f681892bb0871dbea1daaebd/src/main/java/org/springframework/samples/petclinic/chat/AgentConfig.java#L26), or can be used for [content augmentor](https://github.com/showpune/spring-petclinic-langchain4j/blob/3d2dcc1c303a7352f681892bb0871dbea1daaebd/src/main/java/org/springframework/samples/petclinic/chat/AgentConfig.java#L50)
### Memory
Memory Store: The demo still use the local memory defined in [memory store](https://github.com/showpune/spring-petclinic-langchain4j/blob/c95a598f4fdaf68a3f331b32ca42ef5ef95e5c17/src/main/java/org/springframework/samples/petclinic/chat/LocalConfig.java#L39), it means it can not share memory between instances, you can enhance it use memory on Redis
Memory ID: It use the username as memory id [Memory ID](https://github.com/showpune/spring-petclinic-langchain4j/blob/c95a598f4fdaf68a3f331b32ca42ef5ef95e5c17/src/main/java/org/springframework/samples/petclinic/chat/Agent.java#L13)
### Interact with natives functions
The Demo provided two local tools to interactive with native functions
1) [Vets and their specialist](https://github.com/showpune/spring-petclinic-langchain4j/blob/c95a598f4fdaf68a3f331b32ca42ef5ef95e5c17/src/main/java/org/springframework/samples/petclinic/chat/VetTools.java#L41): The agent will know the system can return list of Vets, include their specialist, it can be used to recommend a vet
2) [Owner and Pets](https://github.com/showpune/spring-petclinic-langchain4j/blob/master/src/main/java/org/springframework/samples/petclinic/chat/OwnerTools.java): he agent will know the system register new owner and their pets
### Content Retriever
It still use the local file as [content retriever](https://github.com/showpune/spring-petclinic-langchain4j/blob/c95a598f4fdaf68a3f331b32ca42ef5ef95e5c17/src/main/java/org/springframework/samples/petclinic/chat/LocalConfig.java#L51), it provided the guideline how the agent should work, which is in [Term of Use](https://github.com/showpune/spring-petclinic-langchain4j/blob/master/src/main/resources/petclinic-terms-of-use.txt), the content is ingest when the store in initialized [here](https://github.com/showpune/spring-petclinic-langchain4j/blob/d95e8c0bd9b5eb42da38b991ac50b854a61ad42e/src/main/java/org/springframework/samples/petclinic/chat/LocalConfig.java#L78). If you have lots of content, tried to use the [AI Search](https://github.com/langchain4j/langchain4j-spring/tree/main/langchain4j-azure-ai-search-spring-boot-starter) to create the RAG
### Talk with Other language
You can also talk with the agent with your own language, like Chinese
The problem is that your [Term of Use](https://github.com/showpune/spring-petclinic-langchain4j/blob/master/src/main/resources/petclinic-terms-of-use.txt) is in English, the traditional way is that provide a localized term of use for each language, but you can use openAI to make it easier
We can define a [Retrieval Augmentor](https://github.com/showpune/spring-petclinic-langchain4j/blob/c95a598f4fdaf68a3f331b32ca42ef5ef95e5c17/src/main/java/org/springframework/samples/petclinic/chat/AgentConfig.java#L47C21-L47C39), and translate your ask into English before you retrieve the content
## License
The Spring PetClinic sample application is released under version 2.0 of
the [Apache License](https://www.apache.org/licenses/LICENSE-2.0).