This function creates a new llm_provider() that interacts with the Mistral API.
Usage
llm_provider_mistral(
parameters = list(model = "ministral-3b-latest", stream =
getOption("tidyprompt.stream", TRUE)),
verbose = getOption("tidyprompt.verbose", TRUE),
url = "https://api.mistral.ai/v1/chat/completions",
api_key = Sys.getenv("MISTRAL_API_KEY")
)Arguments
- parameters
A named list of parameters. Currently the following parameters are required:
model: The name of the model to use
stream: A logical indicating whether the API should stream responses
Additional parameters are appended to the request body; see the Mistral API documentation for more information: https://docs.mistral.ai/api/#tag/chat
- verbose
A logical indicating whether the interaction with the LLM provider should be printed to the consol
- url
The URL to the Mistral API endpoint for chat completion
- api_key
The API key to use for authentication with the Mistral API
Value
A new llm_provider() object for use of the Mistral API
See also
Other llm_provider:
llm_provider,
llm_provider_google_gemini(),
llm_provider_groq(),
llm_provider_ollama(),
llm_provider_openai(),
llm_provider_openrouter(),
llm_provider_xai()
Examples
# Various providers:
ollama <- llm_provider_ollama()
openai <- llm_provider_openai()
openrouter <- llm_provider_openrouter()
mistral <- llm_provider_mistral()
groq <- llm_provider_groq()
xai <- llm_provider_xai()
gemini <- llm_provider_google_gemini()
# Initialize with settings:
ollama <- llm_provider_ollama(
parameters = list(
model = "llama3.2:3b",
stream = TRUE
),
verbose = TRUE,
url = "http://localhost:11434/api/chat"
)
# Change settings:
ollama$verbose <- FALSE
ollama$parameters$stream <- FALSE
ollama$parameters$model <- "llama3.1:8b"
if (FALSE) { # \dontrun{
# Try a simple chat message with '$complete_chat()':
response <- ollama$complete_chat("Hi!")
response
# $role
# [1] "assistant"
#
# $content
# [1] "How's it going? Is there something I can help you with or would you like
# to chat?"
#
# $http
# Response [http://localhost:11434/api/chat]
# Date: 2024-11-18 14:21
# Status: 200
# Content-Type: application/json; charset=utf-8
# Size: 375 B
# Use with send_prompt():
"Hi" |>
send_prompt(ollama)
# [1] "How's your day going so far? Is there something I can help you with or
# would you like to chat?"
} # }