Package nl.dannyj.mistral.services

Class MistralService

java.lang.Object
nl.dannyj.mistral.services.MistralService
public class MistralService extends Object
The MistralService class provides methods to interact with the Mistral AI API. It uses the HttpService for making HTTP requests to the Mistral API and returns the responses as POJOs.

  • Constructor Details

    • MistralService

      public MistralService(@NonNull @NonNull MistralClient client, @NonNull @NonNull HttpService httpService)
      Constructor that initializes the MistralService with a provided MistralClient and HttpService.
      Parameters:
      client - The MistralClient to be used for interacting with the Mistral AI API
      httpService - The HttpService to be used for making HTTP requests

  • Method Details

    • createChatCompletion

      public ChatCompletionResponse createChatCompletion(@NonNull @NonNull ChatCompletionRequest request)
      Use the Mistral AI API to create a chat completion (an assistant reply to the conversation). This is a blocking method.
      Parameters:
      request - The request to create a chat completion. See ChatCompletionRequest.
      Returns:
      The response from the Mistral AI API containing the generated message. See ChatCompletionResponse.
      Throws:
      jakarta.validation.ConstraintViolationException - if the request does not pass validation
      UnexpectedResponseException - if an unexpected response is received from the Mistral AI API
      IllegalArgumentException - if the first message role is not 'user' or 'system'

    • createChatCompletionAsync

      public CompletableFuture<ChatCompletionResponse> createChatCompletionAsync(@NonNull @NonNull ChatCompletionRequest request)
      Use the Mistral AI API to create a chat completion (an assistant reply to the conversation). This is a non-blocking/asynchronous method.
      Parameters:
      request - The request to create a chat completion. See ChatCompletionRequest.
      Returns:
      A CompletableFuture that will complete with generated message from the Mistral AI API. See ChatCompletionResponse.

    • createChatCompletionStream

      public void createChatCompletionStream(@NonNull @NonNull ChatCompletionRequest request, @NonNull @NonNull ChatCompletionChunkCallback callback)

    • listModels

      public ListModelsResponse listModels()
      Lists all models available according to the Mistral AI API. This is a blocking method.
      Returns:
      The response from the Mistral AI API containing the list of models. See ListModelsResponse.
      Throws:
      UnexpectedResponseException - if an unexpected response is received from the Mistral AI API

    • listModelsAsync

      public CompletableFuture<ListModelsResponse> listModelsAsync()
      Lists all models available according to the Mistral AI API. This is a non-blocking/asynchronous method.
      Returns:
      A CompletableFuture that will complete with the list of models from the Mistral AI API. See ListModelsResponse.

    • createEmbedding

      public EmbeddingResponse createEmbedding(@NonNull @NonNull EmbeddingRequest request)
      This method is used to create an embedding using the Mistral AI API. The embeddings for the input strings. See the mistral documentation for more details on embeddings. This is a blocking method.
      Parameters:
      request - The request to create an embedding. See EmbeddingRequest.
      Returns:
      The response from the Mistral AI API containing the generated embedding. See EmbeddingResponse.
      Throws:
      jakarta.validation.ConstraintViolationException - if the request does not pass validation
      UnexpectedResponseException - if an unexpected response is received from the Mistral AI API

    • createEmbeddingAsync

      public CompletableFuture<EmbeddingResponse> createEmbeddingAsync(@NonNull @NonNull EmbeddingRequest request)
      This method is used to create an embedding using the Mistral AI API. The embeddings for the input strings. See the mistral documentation for more details on embeddings. This is a non-blocking/asynchronous method.
      Parameters:
      request - The request to create an embedding. See EmbeddingRequest.
      Returns:
      A CompletableFuture that will complete with the generated embedding from the Mistral AI API. See EmbeddingResponse.