Package nl.dannyj.mistral

Class MistralClient

java.lang.Object
nl.dannyj.mistral.MistralClient
public class MistralClient extends Object
The MistralClient is the main class that interacts with all components of this library. It initializes all the necessary components and provides methods to interact with the Mistral AI API.

  • Constructor Details

    • MistralClient

      public MistralClient(@NonNull @NonNull String apiKey)
      Constructor that initializes the MistralClient with a provided API key.
      Parameters:
      apiKey - The API key to be used for the Mistral AI API

    • MistralClient

      public MistralClient()
      Default constructor that initializes the MistralClient with the API key from the environment variable "MISTRAL_API_KEY".

    • MistralClient

      public MistralClient(@NonNull @NonNull String apiKey, @NonNull @NonNull okhttp3.OkHttpClient httpClient, @NonNull @NonNull com.fasterxml.jackson.databind.ObjectMapper objectMapper)
      Constructor that initializes the MistralClient with a provided API key, HTTP client, and object mapper.
      Parameters:
      apiKey - The API key to be used for the Mistral AI API
      httpClient - The OkHttpClient to be used for making requests to the Mistral AI API
      objectMapper - The Jackson ObjectMapper to be used for serializing and deserializing JSON

    • MistralClient

      public MistralClient(@NonNull @NonNull String apiKey, @NonNull @NonNull okhttp3.OkHttpClient httpClient)
      Constructor that initializes the MistralClient with a provided API key and HTTP client.
      Parameters:
      apiKey - The API key to be used for the Mistral AI API
      httpClient - The OkHttpClient to be used for making requests to the Mistral AI API

    • MistralClient

      public MistralClient(@NonNull @NonNull String apiKey, @NonNull @NonNull com.fasterxml.jackson.databind.ObjectMapper objectMapper)
      Constructor that initializes the MistralClient with a provided API key and object mapper.
      Parameters:
      apiKey - The API key to be used for the Mistral AI API
      objectMapper - The Jackson ObjectMapper to be used for serializing and deserializing JSON

  • 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.
      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'

    • 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.
      Throws:
      jakarta.validation.ConstraintViolationException - if the request does not pass validation
      UnexpectedResponseException - if an unexpected response is received from the Mistral AI API

    • 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.
      Throws:
      UnexpectedResponseException - if an unexpected response is received from the Mistral AI API

    • createChatCompletionStream

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

    • setApiKey

      public void setApiKey(String apiKey)

    • setHttpClient

      public void setHttpClient(okhttp3.OkHttpClient httpClient)

    • setObjectMapper

      public void setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

    • setMistralService

      public void setMistralService(MistralService mistralService)

    • getApiKey

      public String getApiKey()

    • getHttpClient

      public okhttp3.OkHttpClient getHttpClient()

    • getObjectMapper

      public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

    • getMistralService

      public MistralService getMistralService()