Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Introduce SPI for creating Mistral AI Client #744

Merged
merged 1 commit into from Mar 13, 2024
Merged

Introduce SPI for creating Mistral AI Client #744

merged 1 commit into from Mar 13, 2024

Conversation

geoand
Copy link
Contributor

@geoand geoand commented Mar 13, 2024 •
edited by coderabbitai bot

This is very similar to what is done for OpenAI and it will directly enable this

cc @langchain4j

Summary by CodeRabbit

  • New Features
    • Introduced a new client for interacting with Mistral AI services, enabling chat completions, streaming chat completions, embeddings, and model listings.
  • Refactor
    • Updated MistralAiClient to an abstract class with enhanced functionality and a new builder method for configuration.
  • Chores
    • Changed access modifiers of several classes and methods from package-private to public, improving their usability across the codebase.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Mar 13, 2024 •
edited

Walkthrough

The update introduces a new client class for interacting with Mistral AI services, making significant accessibility adjustments across various classes by changing access modifiers from package-private or default to public. It transforms MistralAiClient into an abstract class, enriching it with a new abstract builder method and enhancing its functionality. Additionally, a new interface for the client builder factory is introduced, signaling a structured approach to client instantiation and configuration.

Changes

File Path Change Summary
.../mistralai/DefaultMistralAiClient.java Introduces a client for Mistral AI services.
.../mistralai/MistralAiChatCompletionRequest.java,
.../MistralAiChatCompletionResponse.java,
.../mistralai/MistralAiEmbeddingRequest.java,
.../mistralai/MistralAiEmbeddingResponse.java,
.../mistralai/MistralAiModelResponse.java,
.../mistralai/MistralAiRole.java		 Changed access modifiers to public.
.../mistralai/MistralAiClient.java Modified to an abstract class with method changes.
.../mistralai/MistralAiClientBuilderFactory.java Introduces an interface for client builder factory.

🐇✨

In the realm of code, where changes abound,
A rabbit hopped in, with updates profound.
"To Mistral AI, a path we pave,
With public classes, bold and brave.
A builder's touch, a factory's grace,
Together, we set the interface."
🌟🎉

  • CodeRabbit 🐇💻

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai[bot]
coderabbitai bot reviewed Mar 13, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3aafa79 and 2763836.
Files selected for processing (9)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/DefaultMistralAiClient.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionRequest.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionResponse.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiClient.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiClientBuilderFactory.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiEmbeddingRequest.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiEmbeddingResponse.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiModelResponse.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiRole.java (1 hunks)
Check Runs (1)
compliance completed (1)
Files skipped from review due to trivial changes (1)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiClientBuilderFactory.java
Additional comments: 9
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiRole.java (1)
  • 7-7: The change in access modifier from package-private to public for MistralAiRole is approved. This enhances the enum's accessibility across the codebase, aligning with the PR's objectives to improve module usability.
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiModelResponse.java (1)
  • 14-14: Changing the access level of MistralAiModelResponse from package-private to public is approved. This adjustment facilitates broader access and integration, aligning with the PR's objectives.
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiEmbeddingRequest.java (1)
  • 14-14: The modification of the access level for MistralAiEmbeddingRequest to public is approved. This change supports broader usage and integration within the project, consistent with the PR's goals.
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiEmbeddingResponse.java (1)
  • 14-14: Approving the change in access level for MistralAiEmbeddingResponse to public. This facilitates broader access and integration, aligning with the objectives of enhancing the module's functionality.
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionResponse.java (1)
  • 14-14: The change in access modifier for MistralAiChatCompletionResponse to public is approved. This adjustment supports broader usage and integration, consistent with the PR's goals of enhancing module functionality.
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionRequest.java (1)
  • 14-14: Approving the change in access modifier for MistralAiChatCompletionRequest to public. This facilitates broader access and integration within the project, consistent with the PR's objectives.
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiClient.java (2)
  • 8-8: Transforming MistralAiClient into an abstract class and introducing abstract methods significantly enhances its flexibility and configurability. This aligns with modern Java practices and the PR's objectives.
  • 27-82: The introduction of the Builder pattern within MistralAiClient is a commendable design choice. It facilitates customizable client configuration, aligning with best practices and the PR's objectives of enhancing module functionality.
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/DefaultMistralAiClient.java (1)
  • 29-219: The implementation of DefaultMistralAiClient is comprehensive and well-designed. It correctly implements the abstract methods from MistralAiClient and utilizes Retrofit and OkHttp effectively for API communication, including streaming responses. The builder pattern is appropriately used, enhancing the client's configurability.

coderabbitai[bot]
coderabbitai bot reviewed Mar 13, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3aafa79 and 9f74abb.
Files selected for processing (10)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/DefaultMistralAiClient.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionChoice.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionRequest.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionResponse.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiClient.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiClientBuilderFactory.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiEmbeddingRequest.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiEmbeddingResponse.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiModelResponse.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiRole.java (1 hunks)
Check Runs (1)
compliance completed (1)
Files skipped from review as they are similar to previous changes (8)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/DefaultMistralAiClient.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionRequest.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionResponse.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiClientBuilderFactory.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiEmbeddingRequest.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiEmbeddingResponse.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiModelResponse.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiRole.java
Additional comments: 4
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionChoice.java (1)
  • 12-12: Changing the MistralAiChatCompletionChoice class to public enhances its accessibility, aligning with the PR objectives. Ensure that this change does not inadvertently expose any sensitive data or violate encapsulation principles.
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiClient.java (3)
  • 8-8: Making MistralAiClient abstract supports the introduction of a flexible and configurable client interface. Ensure that existing implementations are updated or refactored accordingly to align with this change.
  • 10-16: The updated and new methods in MistralAiClient align with the PR objectives to enhance interaction with Mistral AI services. Consider adding documentation for these methods to improve maintainability and ease of use.
  • 27-82: The introduction of the Builder class follows the builder pattern, which is a good practice for creating complex objects. Ensure that the builder class is well-documented, including examples of its usage, to facilitate ease of use and maintainability.

coderabbitai[bot]
coderabbitai bot reviewed Mar 13, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3aafa79 and 6dd695b.
Files selected for processing (14)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/DefaultMistralAiClient.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/DefaultMistralAiHelper.java (3 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionChoice.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionRequest.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionResponse.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatMessage.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiClient.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiClientBuilderFactory.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiDeltaMessage.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiEmbeddingRequest.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiEmbeddingResponse.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiModelResponse.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiRole.java (1 hunks)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiUsage.java (1 hunks)
Check Runs (1)
compliance completed (1)
Files skipped from review as they are similar to previous changes (10)
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/DefaultMistralAiClient.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionChoice.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionRequest.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatCompletionResponse.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiClient.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiClientBuilderFactory.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiEmbeddingRequest.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiEmbeddingResponse.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiModelResponse.java
  • langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiRole.java
Additional comments: 6
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiChatMessage.java (1)
  • 12-12: Making the MistralAiChatMessage class public increases its visibility, allowing it to be accessed from outside its package. This change aligns with the PR's objective to enhance accessibility for Mistral AI services integration. Ensure that this increased visibility is intentional and reviewed for security implications.
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiDeltaMessage.java (1)
  • 12-12: Changing the access level of MistralAiDeltaMessage to public is consistent with the PR's goal of enhancing module accessibility for broader integration. As with any visibility change, confirm that this adjustment is deliberate and consider any potential security or design implications.
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/MistralAiUsage.java (1)
  • 12-12: The visibility change of MistralAiUsage to public supports the PR's objective of facilitating easier integration with Mistral AI services. As with previous visibility changes, ensure this modification is intentional and consider any potential security or design implications.
langchain4j-mistral-ai/src/main/java/dev/langchain4j/model/mistralai/DefaultMistralAiHelper.java (3)
  • 18-18: Making DefaultMistralAiHelper public increases its accessibility, aligning with the PR's goal of enhancing the module's integration capabilities. Confirm that exposing these helper methods publicly is intended and review for any potential security implications.
  • 67-67: The tokenUsageFrom method is now public, allowing external conversion from MistralAiUsage to TokenUsage. Ensure this method's public visibility is necessary for the intended use cases and review its implementation for correctness and efficiency.
  • 78-78: The finishReasonFrom method's public visibility facilitates external mapping from Mistral AI's finish reasons to the application's FinishReason enum. Verify the necessity of this method's public access and assess its implementation for correctness, especially the default case handling.

@geoand geoand mentioned this pull request Mar 13, 2024
Merged
langchain4j
langchain4j approved these changes Mar 13, 2024
View reviewed changes
Copy link
Owner

@langchain4j langchain4j left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@geoand thanks!

@langchain4j langchain4j merged commit 5c16bbb into langchain4j:main Mar 13, 2024
6 checks passed
@geoand
Copy link
Contributor Author

geoand commented Mar 13, 2024

🙏🏼

@geoand geoand deleted the mistral-factory branch March 14, 2024 08:43
@geoand
Copy link
Contributor Author

geoand commented Mar 14, 2024

@langchain4j do you have any plans for doing a 0.28.1 which would include this?

Thanks

@langchain4j
Copy link
Owner

@geoand I was planning to do 0.29.0 on monday. If this is urgent, I can do 0.28.1 today evening or tomorrow morning

@geoand
Copy link
Contributor Author

geoand commented Mar 14, 2024

Not urgent at all, just asking :)

@edeandrea edeandrea mentioned this pull request Mar 26, 2024
Merged
langchain4j pushed a commit that referenced this pull request Mar 27, 2024
@edeandrea
Introduce SPI for creating Anthropic client (#834)
6fd8fbc 
<!-- Thank you so much for your contribution! -->

## Context
This is very similar to what is done for Mistral (#744) and OpenAI. It
will directly enable quarkiverse/quarkus-langchain4j#413.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai left review comments

@langchain4j langchain4j langchain4j approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@geoand @langchain4j