spring petclinic langchain4j

Genai Spring Petclinic Probenanwendungsbau mit Langchain4J

Verständnis der Spring Petclinic Langchain4J -Anwendung

Ein Chatbot, der generative KI mit der berühmten Spring Petclinic -Anwendung verwendet hat. Diese Version verwendet das Langchain4J -Projekt und unterstützt derzeit Openai oder Azure's Openai als LLM -Anbieter . Dies ist eine Gabel aus dem Spring-Petclinic-AI, der auf der Frühlings-KI basiert.

Diese Stichprobe zeigt, wie AI/LLM -Funktionen einfach in eine Java -Anwendung mit Langchain4J integriert werden können. Dies kann dank:

• Eine einheitliche Abstraktionsschicht, mit der Ihr Code aus bestimmten Implementierungen wie LLM oder Einbettungsanbietern entworfen wurde, wodurch ein einfacher Tausch für Komponenten ermöglicht wird. Nur die Anwendungen.
• Der Speicher bietet einen Kontext für die LLM sowohl für Ihre aktuellen als auch für frühere Konversationen, wobei mehrere Benutzer unterstützt werden. Siehe die Verwendung der MessageWindowChatMemory -Klasse in AssistantConfiguration und der @MemoryId -Annotation in der Assistant -Schnittstelle.
• AI -Dienste ermöglicht deklarative Definitionen komplexer KI -Verhaltensweisen durch eine einfache Java -API. Siehe die Verwendung der @AiService -Annotation in der Assistant -Schnittstelle.
• Systemaufforderungen spielen eine wichtige Rolle bei LLMs, da sie die Interpretation und Reaktion von Benutzernfragen in LLMs formen. Schauen Sie sich die @SystemMessage Annotation -Nutzung in der Assistant -Schnittstelle an.
• Streaming- Reaktions-Token-by-Token Bei Verwendung des TokenStream Rückgabetyps und der Spring Server-Sent-Ereignisse . Schauen Sie sich den AssistantController -REST -Controller an
• Funktionsaufruf oder Tools ermöglichen es dem LLM, bei Bedarf eine oder mehrere Java -Methoden aufzurufen. Die AssistantTool -Komponente deklariert Funktionen mit der @Tool Annotation von Langchain4J.
• Strukturierte Ausgänge ermöglichen es, LLM -Antworten in einem bestimmten Format als Java -Pojos zu empfangen. AssistantTool verwendet Java -Aufzeichnungen als LLM/ Eingangs-/ Ausgangsdatenstruktur.
• Ermöglicht es einer LLM, auf der relieval-Augmented-Generation (RAG) auf der Grundlage spezifischer Daten-wie bei Daten aus der PETClinic-Datenbank-durch die Einnahme und Referenzierung während der Interaktionen einzubeziehen und zu reagieren. Die AssistantConfiguration erklärt das EmbeddingModel , InMemoryEmbeddingStore und EmbeddingStoreContentRetriever -Bohnen, während die Einbettungstoreinit -Klasse die Datenaufnahme von Tierärzten beim Start -up übernimmt. Der VetQueryRouter zeigt, wie das Abruf bedingt überspringt, wobei die Entscheidungsfindung von einem LLM angetrieben wird.

Spring Petclinic integriert einen Chatbot, mit dem Sie mit der Anwendung in einer natürlichen Sprache interagieren können. Hier sind einige Beispiele für das, was Sie fragen könnten:

1. Bitte listen Sie die Eigentümer auf, die in die Klinik kommen.
2. Wie viele Veterinärkardiologen gibt es?
3. Gibt es einen Besitzer namens Betty? Was ist ihr LastName?
4. Welche Besitzer haben Hunde?
5. Fügen Sie einen Hund für Betty hinzu. Sein Name ist Moopsie. Sein Geburtstag ist am 2. Oktober 2024.
6. Fügen Sie den heutigen Besuch in Moopsie hinzu.

Spring Petclinic unterstützt derzeit Openai oder Azure's Openai als LLM -Anbieter. Um spring-petlinic-langchain4j zu starten, führen Sie die folgenden Schritte aus:

1. Entscheiden Sie, welchen Anbieter Sie verwenden möchten. Standardmäßig ist die Abhängigkeit langchain4j-open-ai-spring-boot-starter aktiviert. Sie können es in langchain4j-azure-open-ai-spring-boot-starter in pom.xml oder in build.gradle abhängig von Ihrem Build-Tool Ihrer Wahl ändern.
2. Erstellen Sie einen OpenAI -API -Schlüssel oder eine Azure OpenAI -Ressource in Ihrem Azure -Portal. Weitere Informationen zur Erlangung dieser Informationen finden Sie in der Dokumentation von OpenAIs QuickStart oder Azure. Sie müssen nur den von Ihnen verwendeten Anbieter bevölkern - entweder Openai oder Azure -Openai. Wenn Sie nicht Ihren eigenen OpenAI -API -Schlüssel haben, machen Sie sich keine Sorgen! Sie können den demo -Key, den OpenAI für Demonstrationszwecke kostenlos bietet, vorübergehend verwenden. Dieser demo -Schlüssel hat eine Quote, ist auf das GPT-4O-Mini-Modell beschränkt und ist ausschließlich für die Verwendung von Demonstrationen gedacht.
3. Exportieren Sie Ihre API -Schlüssel und Ihre Endpunkt als Umgebungsvariablen:
   • entweder OpenAI:

    export OPENAI_API_KEY= " your_api_key_here "

   • oder Azure Openai:

    export AZURE_OPENAI_ENDPOINT= " https://your_resource.openai.azure.com "
   export AZURE_OPENAI_KEY= " your_api_key_here "

4. Befolgen

Petclinic lokal laufen

Spring Petclinic ist eine Federschuhanwendung, die mit Maven oder Gradle erstellt wurde. Sie können eine JAR -Datei erstellen und aus der Befehlszeile ausführen (sie sollte genauso gut mit Java 17 oder neuer funktionieren):

git clone https://github.com/spring-petclinic/spring-petclinic-langchain4j.git
cd spring-petclinic
./mvnw package
java -jar target/ * .jar

Sie können dann auf das PetClinic unter http: // localhost: 8080/zugreifen.

Oder Sie können es mit dem Spring Boot Maven -Plugin direkt von Maven ausführen. Wenn Sie dies tun, werden Änderungen abgenommen, die Sie im Projekt sofort vornehmen (Änderungen an Java -Quelldateien erfordern auch ein Kompilieren - die meisten Menschen verwenden dafür eine IDE):

./mvnw spring-boot:run

HINWEIS: Wenn Sie es vorziehen, Gradle zu verwenden, können Sie die App mit ./gradlew build erstellen und nach der JAR -Datei in build/libs suchen.

Einen Behälter bauen

In diesem Projekt gibt es keine Dockerfile . Sie können ein Containerbild (wenn Sie einen Docker -Daemon haben) mit dem Spring Start -Build -Plugin erstellen:

./mvnw spring-boot:build-image

Falls Sie einen Fehler/eine vorgeschlagene Verbesserung für Spring Petclinic finden

Unser Ausgabe -Tracker ist hier verfügbar.

Datenbankkonfiguration

In seiner Standardkonfiguration verwendet PetClinic eine In-Memory-Datenbank (H2), die beim Start mit Daten besiedelt wird. Die H2-Konsole ist unter http://localhost:8080/h2-console freigelegt, und es ist möglich, den Inhalt der Datenbank mithilfe der jdbc:h2:mem:<uuid> -RUR zu überprüfen. Die UUID wird beim Start in die Konsole gedruckt.

Ein ähnliches Setup wird für MySQL und PostgreSQL bereitgestellt, wenn eine persistente Datenbankkonfiguration erforderlich ist. Beachten Sie, dass die App mit einem anderen Profil ausgeführt wird, wenn sich der Datenbanktyp ändert, mit einem anderen Profil ausgeführt werden: spring.profiles.active=mysql für MySQL oder spring.profiles.active=postgres für PostgreSQL. Weitere Informationen zum Einstellen des aktiven Profils finden Sie in der Spring -Boot -Dokumentation.

Sie können MySQL oder PostgreSQL lokal mit dem für Ihr Betriebssystem bearbeitenden Installateur starten oder Docker verwenden:

docker run -e MYSQL_USER=petclinic -e MYSQL_PASSWORD=petclinic -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:8.4

oder

docker run -e POSTGRES_USER=petclinic -e POSTGRES_PASSWORD=petclinic -e POSTGRES_DB=petclinic -p 5432:5432 postgres:16.3

Weitere Dokumentationen für MySQL und Postgresql.

Anstelle von Vanilla docker können Sie auch die bereitgestellte Datei docker-compose.yml verwenden, um die Datenbankcontainer zu starten. Jeder hat ein Profil wie das Frühlingsprofil:

docker-compose --profile mysql up

oder

docker-compose --profile postgres up

Testanwendungen

Zum Entwicklungszeit empfehlen wir, die als main() -Methoden in PetClinicIntegrationTests eingerichteten Testanwendungen (mithilfe der Standard -H2 -Datenbank und Hinzufügen von Spring -Boot -Devtools), MySqlTestApplication und PostgresIntegrationTests zu verwenden. Diese sind so eingerichtet, dass Sie die Apps in Ihrer IDE ausführen können, um schnelles Feedback zu erhalten, und dieselben Klassen wie Integrationstests gegen die jeweilige Datenbank ausführen. Die MySQL -Integrationstests verwenden TestContainer, um die Datenbank in einem Docker -Container zu starten, und die Postgres -Tests verwenden Docker Compose, um dasselbe zu tun.

Das CSS zusammenstellen

Es gibt einen petclinic.css in src/main/resources/static/resources/css . Es wurde aus der Quelle von petclinic.scss erzeugt, kombiniert mit der Bootstrap -Bibliothek. Wenn Sie Änderungen an den scss vornehmen oder Bootstrap aktualisieren, müssen Sie die CSS -Ressourcen mit dem Maven -Profil "CSS", dh ./mvnw package -P css , neu kompilieren. Es gibt kein Build -Profil, damit Gradle das CSS zusammenstellt.

Arbeiten mit Petclinic in Ihrer Ideen

Voraussetzungen

Die folgenden Elemente sollten in Ihrem System installiert werden:

• Java 17 oder neuer (volles JDK, kein JRE)
• GIT -Befehlszeilenwerkzeug
• Ihre bevorzugte IDE
  • Eclipse mit dem M2E -Plugin. Hinweis: Wenn M2E verfügbar ist, befindet sich ein M2 -Symbol in Help -> About den Dialog. Wenn M2E nicht vorhanden ist, befolgen Sie den Installationsprozess hier
  • Feder Tools Suite (STS)
  • Intellij Idee
  • Vs Code

Schritte

1. Auf dem Befehlszeilenlauf:

   git clone https://github.com/spring-petclinic/spring-petclinic-langchain4j.git

2. Innerhalb Sonnenfinsternis oder STS:

   Öffnen Sie das Projekt über File -> Import -> Maven -> Existing Maven project und wählen Sie dann das Stammverzeichnis des geklonten Repo aus.

   Erstellen Sie dann entweder auf der Befehlszeile ./mvnw generate-resources oder verwenden Sie den Eclipse-Launcher (klicken Sie mit der rechten Maustaste auf das Projekt und Run As -> Maven install ), um die CSS zu generieren. Führen Sie die Hauptmethode der Anwendung aus, indem Sie mit der rechten Maustaste darauf klicken und Run As -> Java Application auswählen.

3. Intellij Idee:

   Wählen Sie im Hauptmenü File -> Open und wählen Sie den Petclinic pom.xml. Klicken Sie auf die Schaltfläche Open .

   • CSS -Dateien werden aus dem Maven -Build generiert. Sie können sie in der Befehlszeile erstellen ./mvnw generate-resources oder klicken Sie mit der rechten Maustaste auf das spring-petclinic -Projekt, dann Maven -> Generates sources and Update Folders .

   • Eine Run -Konfiguration mit dem Namen PetClinicApplication sollte für Sie erstellt werden, wenn Sie eine aktuelle ultimative Version verwenden. Führen Sie die Anwendung ansonsten durch, indem Sie mit der rechten Maustaste auf die Hauptklasse PetClinicApplication klicken und Run 'PetClinicApplication' auswählen.

4. Navigieren Sie zum Petclinic

   Besuchen Sie http: // localhost: 8080 in Ihrem Browser.

Auf der Suche nach etwas Besonderem?

Feder -Boot -Konfiguration	Klassen- oder Java -Eigenschaftsdateien
Die Hauptklasse	Petclinicapplication
Eigenschaftendateien	application.Properties
Ausschnitt	CacheConfiguration

Interessante Frühlingspetclinic -Zweige und Gabeln

Der Spring Petclinic "Haupt" -Ast in den Spring-Projects Github Org ist die "kanonische" Implementierung basierend auf Spring Boot und Thymeleaf. Es gibt einige Gabeln im GitHub Org-Feder-Petclinic. Wenn Sie daran interessiert sind, einen anderen Technologie -Stack zur Implementierung der PET -Klinik zu verwenden, treten Sie dort in der Community bei.

Interaktion mit anderen Open-Source-Projekten

Einer der besten Teile an der Arbeit an der Spring Petclinic -Anwendung ist, dass wir die Möglichkeit haben, in direktem Kontakt mit vielen Open -Source -Projekten zu arbeiten. Wir fanden Fehler/vorgeschlagene Verbesserungen zu verschiedenen Themen wie Frühling, Frühlingsdaten, Bean -Validierung und sogar Sonnenfinsternis! In vielen Fällen wurden sie in nur wenigen Tagen behoben/implementiert. Hier ist eine Liste von ihnen:

Name	Ausgabe
Spring JDBC: Vereinfachen Sie die Verwendung von namerparameterjdbctemplate	SPR-10256 und SPR-10257
Bean -Validierung / Hibernate -Validator: Vereinfachen Sie die Abhängigkeiten der Maven -Abhängigkeiten und Rückwärtskompatibilität	HV-790 und HV-792
Federdaten: Bieten Sie mehr Flexibilität bei der Arbeit mit JPQL -Abfragen	DataJPA-292

Beitragen

Der Problem Tracker ist der bevorzugte Kanal für Fehlerberichte, Feature -Anfragen und Senden von Pull -Anfragen.

Für Pull -Anfragen sind die Editor -Einstellungen in der Editor -Konfiguration verfügbar, um sie bei gemeinsamen Texteditoren einfach zu verwenden. Lesen Sie mehr und laden Sie Plugins unter https://editorconfig.org herunter. Wenn Sie dies zuvor nicht getan haben, füllen Sie bitte die Lizenzvereinbarung aus und senden Sie dies ein.

Lizenz

Die Spring Petclinic -Probenanwendung wird unter Version 2.0 der Apache -Lizenz veröffentlicht.