Add Example for Spring AI #114
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Important Auto Review SkippedDraft detected. Please check the settings in the CodeRabbit UI or the To trigger a single review, invoke the WalkthroughThis update enriches a Java-based AI project with Spring Boot, emphasizing AI interactions and historical data retrieval. It orchestrates the project environment, establishes dependencies for Spring AI and web development, and introduces classes for application execution and chat history management. Testing ensures the functionality of the application components, while configuration settings fine-tune the AI chat feature for an enhanced user experience. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (10)
- ai/.gitignore (1 hunks)
- ai/build.gradle (1 hunks)
- ai/settings.gradle (1 hunks)
- ai/src/main/java/zin/rashidi/boot/ai/AiApplication.java (1 hunks)
- ai/src/main/java/zin/rashidi/boot/ai/history/ChatHistoryRepository.java (1 hunks)
- ai/src/main/java/zin/rashidi/boot/ai/history/History.java (1 hunks)
- ai/src/main/java/zin/rashidi/boot/ai/history/HistoryRepository.java (1 hunks)
- ai/src/main/resources/application.properties (1 hunks)
- ai/src/test/java/zin/rashidi/boot/ai/AiApplicationTests.java (1 hunks)
- ai/src/test/java/zin/rashidi/boot/ai/history/HistoryRepositoryTests.java (1 hunks)
Files skipped from review due to trivial changes (3)
- ai/.gitignore
- ai/settings.gradle
- ai/src/main/java/zin/rashidi/boot/ai/AiApplication.java
Additional comments: 7
ai/src/main/java/zin/rashidi/boot/ai/history/History.java (1)
- 1-9: The
Historyrecord is well-defined and follows Java best practices for immutable data structures. It's a concise way to encapsulate historical event data.ai/src/main/resources/application.properties (1)
- 1-4: The configuration for the Spring AI OpenAI chat options is correctly set up, with sensible defaults for the model, temperature, top-p, and response format. This setup is crucial for tailoring the AI's behavior and response format.
ai/src/main/java/zin/rashidi/boot/ai/history/HistoryRepository.java (1)
- 1-12: The
HistoryRepositoryinterface is well-designed, with a clear and focused responsibility. The methodfindByCountryAndYearis appropriately named and usesjava.time.Year, which is a good choice for handling years.ai/src/test/java/zin/rashidi/boot/ai/AiApplicationTests.java (1)
- 1-13: The
AiApplicationTestsclass is correctly set up for Spring Boot testing, ensuring the application context loads successfully. This is a standard and essential test for Spring Boot applications.ai/build.gradle (1)
- 1-34: The
build.gradlefile is well-configured for a Spring Boot project, including the necessary plugins, repositories, and dependencies for Spring AI and OpenAI integration. However, consider verifying thesourceCompatibilityset to '21' with the development team to ensure compatibility with their environments.ai/src/test/java/zin/rashidi/boot/ai/history/HistoryRepositoryTests.java (1)
- 1-44: The
HistoryRepositoryTestsclass provides thorough and well-structured tests for theHistoryRepositoryfunctionality, using clear descriptions and appropriate assertions. These tests effectively validate the retrieval of historical information based on country and year.ai/src/main/java/zin/rashidi/boot/ai/history/ChatHistoryRepository.java (1)
- 1-60: The
ChatHistoryRepositoryclass is well-implemented, effectively using Spring AI'sChatClient,EmbeddingClient, and anObjectMapperto process historical chat data. The approach to constructing messages and parsing the AI's response is innovative and well-crafted. However, consider adding error handling for the external calls to AI services to ensure robustness.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- settings.gradle (1 hunks)
Additional comments: 1
settings.gradle (1)
- 17-17: The addition of the
aimodule to thesettings.gradlefile aligns with the PR's objectives to integrate AI capabilities into the Spring Boot application. Ensure that the module nameaialigns with any existing project naming conventions and does not conflict with other modules in the project.
This commit introduces a whole new AI application along with a 'history' feature. The AI application includes necessary initial files including '.gitignore', 'build.gradle', 'settings.gradle', and 'application.properties'. The 'history' feature has an implementation through 'HistoryRepository', 'ChatHistoryRepository' and tests under 'HistoryRepositoryTests'.
Removed the EmbeddingClient from ChatHistoryRepository. This involved removing the EmbeddingClient field, its use in the constructor, and its use in creating a response. This change simplified the ChatHistoryRepository class by decoupling it from direct use of the EmbeddingClient.
New environment variable SPRING_AI_OPENAI_API_KEY is added in Github gradle workflow file to support running the Spring AI model. It is set with the same secret as LANGCHAIN4J_CHAT_MODEL_OPENAI_API_KEY for now.
The Spring Boot version in the build.gradle file has been updated from 3.2.2 to 3.2.3. This update keeps the build configuration synchronized with the latest stable version of the framework.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit