Index
All Classes and Interfaces|All Packages|Serialized Form
A
- ANY - Enum constant in enum class nl.dannyj.mistral.models.completion.tool.ToolChoiceEnum
-
The model is forced to call at least one tool.
- assistant(List<ToolCall>) - Method in class nl.dannyj.mistral.builders.MessageListBuilder
-
Adds an assistant message with tool calls to the list.
- assistant(String) - Method in class nl.dannyj.mistral.builders.MessageListBuilder
-
Adds an assistant message with text content to the list.
- ASSISTANT - Enum constant in enum class nl.dannyj.mistral.models.completion.message.MessageRole
- AssistantMessage - Class in nl.dannyj.mistral.models.completion.message
-
Represents a message with the 'assistant' role in a chat conversation.
- AssistantMessage() - Constructor for class nl.dannyj.mistral.models.completion.message.AssistantMessage
- AssistantMessage(List<ToolCall>) - Constructor for class nl.dannyj.mistral.models.completion.message.AssistantMessage
-
Constructs an AssistantMessage with tool calls.
- AssistantMessage(String) - Constructor for class nl.dannyj.mistral.models.completion.message.AssistantMessage
-
Constructs an AssistantMessage with text content.
- AssistantMessage(List<ContentChunk>, List<ToolCall>) - Constructor for class nl.dannyj.mistral.models.completion.message.AssistantMessage
-
Constructs an AssistantMessage with both text content and tool calls.
- AUTO - Enum constant in enum class nl.dannyj.mistral.models.completion.tool.ToolChoiceEnum
-
The model can choose to call a tool or not.
B
- build() - Method in class nl.dannyj.mistral.builders.MessageListBuilder
-
Returns the list of ChatMessage objects that have been added.
- build() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
- build() - Method in class nl.dannyj.mistral.models.completion.Prediction.PredictionBuilder
- build() - Method in class nl.dannyj.mistral.models.completion.tool.Function.FunctionBuilder
- build() - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema.JsonSchemaBuilder
- build() - Method in class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice.SpecificToolChoiceBuilder
- build() - Method in class nl.dannyj.mistral.models.completion.tool.Tool.ToolBuilder
- build() - Method in class nl.dannyj.mistral.models.embedding.EmbeddingRequest.EmbeddingRequestBuilder
- builder() - Static method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
- builder() - Static method in class nl.dannyj.mistral.models.completion.Prediction
- builder() - Static method in class nl.dannyj.mistral.models.completion.tool.Function
- builder() - Static method in class nl.dannyj.mistral.models.completion.tool.JsonSchema
- builder() - Static method in class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice
- builder() - Static method in class nl.dannyj.mistral.models.completion.tool.Tool
- builder() - Static method in class nl.dannyj.mistral.models.embedding.EmbeddingRequest
C
- canEqual(Object) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
- canEqual(Object) - Method in class nl.dannyj.mistral.models.completion.content.ImageURL
- canEqual(Object) - Method in class nl.dannyj.mistral.models.completion.message.AssistantMessage
- canEqual(Object) - Method in class nl.dannyj.mistral.models.completion.message.SystemMessage
- canEqual(Object) - Method in class nl.dannyj.mistral.models.completion.message.ToolMessage
- canEqual(Object) - Method in class nl.dannyj.mistral.models.completion.message.UserMessage
- canEqual(Object) - Method in class nl.dannyj.mistral.models.completion.Prediction
- canEqual(Object) - Method in class nl.dannyj.mistral.models.completion.tool.Function
- canEqual(Object) - Method in class nl.dannyj.mistral.models.completion.tool.FunctionCall
- canEqual(Object) - Method in class nl.dannyj.mistral.models.completion.tool.FunctionName
- canEqual(Object) - Method in class nl.dannyj.mistral.models.completion.tool.Tool
- canEqual(Object) - Method in class nl.dannyj.mistral.models.completion.tool.ToolCall
- canEqual(Object) - Method in class nl.dannyj.mistral.models.embedding.EmbeddingRequest
- ChatCompletionChunkCallback - Interface in nl.dannyj.mistral.net
-
Interface for handling streaming chat completion requests.
- ChatCompletionRequest - Class in nl.dannyj.mistral.models.completion
-
The ChatCompletionRequest class represents a request to create a chat completion (an assistant reply to the conversation).
- ChatCompletionRequest() - Constructor for class nl.dannyj.mistral.models.completion.ChatCompletionRequest
- ChatCompletionRequest(String, Double, Double, Integer, Boolean, List<String>, Long, List<ChatMessage>, ResponseFormat, boolean, List<Tool>, ToolChoiceOption, Double, Double, Integer, Prediction, Boolean) - Constructor for class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Creates a new
ChatCompletionRequest
instance. - ChatCompletionRequest.ChatCompletionRequestBuilder - Class in nl.dannyj.mistral.models.completion
- ChatCompletionResponse - Class in nl.dannyj.mistral.models.completion
-
The ChatCompletionResponse class represents a response from the Mistral API when creating a chat completion.
- ChatCompletionResponse() - Constructor for class nl.dannyj.mistral.models.completion.ChatCompletionResponse
- ChatCompletionResponse(String, String, long, String, List<Choice>, Usage) - Constructor for class nl.dannyj.mistral.models.completion.ChatCompletionResponse
-
Creates a new
ChatCompletionResponse
instance. - ChatMessage - Class in nl.dannyj.mistral.models.completion.message
-
Represents a single message in a chat conversation, serving as the base for different message types (system, user, assistant, tool).
- ChatMessage() - Constructor for class nl.dannyj.mistral.models.completion.message.ChatMessage
- Choice - Class in nl.dannyj.mistral.models.completion
-
Represents a choice in a chat completion response.
- Choice() - Constructor for class nl.dannyj.mistral.models.completion.Choice
- Choice(int, AssistantMessage, FinishReason) - Constructor for class nl.dannyj.mistral.models.completion.Choice
-
Creates a new
Choice
instance. - content - Variable in class nl.dannyj.mistral.models.completion.message.ChatMessage
-
The content of the message.
- content(String) - Method in class nl.dannyj.mistral.models.completion.Prediction.PredictionBuilder
-
The predicted content.
- ContentChunk - Interface in nl.dannyj.mistral.models.completion.content
-
Represents a part of the message content.
- ContentChunkListDeserializer - Class in nl.dannyj.mistral.serialization
- ContentChunkListDeserializer() - Constructor for class nl.dannyj.mistral.serialization.ContentChunkListDeserializer
- ContentChunkListDeserializer(Class<?>) - Constructor for class nl.dannyj.mistral.serialization.ContentChunkListDeserializer
- createChatCompletion(ChatCompletionRequest) - Method in class nl.dannyj.mistral.MistralClient
-
Use the Mistral AI API to create a chat completion (an assistant reply to the conversation).
- createChatCompletion(ChatCompletionRequest) - Method in class nl.dannyj.mistral.services.MistralService
-
Use the Mistral AI API to create a chat completion (an assistant reply to the conversation).
- createChatCompletionAsync(ChatCompletionRequest) - Method in class nl.dannyj.mistral.MistralClient
-
Use the Mistral AI API to create a chat completion (an assistant reply to the conversation).
- createChatCompletionAsync(ChatCompletionRequest) - Method in class nl.dannyj.mistral.services.MistralService
-
Use the Mistral AI API to create a chat completion (an assistant reply to the conversation).
- createChatCompletionStream(ChatCompletionRequest, ChatCompletionChunkCallback) - Method in class nl.dannyj.mistral.MistralClient
- createChatCompletionStream(ChatCompletionRequest, ChatCompletionChunkCallback) - Method in class nl.dannyj.mistral.services.MistralService
- createContextual(DeserializationContext, BeanProperty) - Method in class nl.dannyj.mistral.serialization.ContentChunkListDeserializer
- createEmbedding(EmbeddingRequest) - Method in class nl.dannyj.mistral.MistralClient
-
This method is used to create an embedding using the Mistral AI API.
- createEmbedding(EmbeddingRequest) - Method in class nl.dannyj.mistral.services.MistralService
-
This method is used to create an embedding using the Mistral AI API.
- createEmbeddingAsync(EmbeddingRequest) - Method in class nl.dannyj.mistral.MistralClient
-
This method is used to create an embedding using the Mistral AI API.
- createEmbeddingAsync(EmbeddingRequest) - Method in class nl.dannyj.mistral.services.MistralService
-
This method is used to create an embedding using the Mistral AI API.
D
- DeltaChoice - Class in nl.dannyj.mistral.models.completion
-
Represents a delta update within a choice during a streamed chat completion.
- DeltaChoice() - Constructor for class nl.dannyj.mistral.models.completion.DeltaChoice
- DeltaChoice(int, DeltaMessage, FinishReason) - Constructor for class nl.dannyj.mistral.models.completion.DeltaChoice
-
Creates a new
DeltaChoice
instance. - DeltaMessage - Class in nl.dannyj.mistral.models.completion.message
-
Represents the delta content within a streamed chat completion choice.
- DeltaMessage() - Constructor for class nl.dannyj.mistral.models.completion.message.DeltaMessage
- DeltaMessage(MessageRole, List<ContentChunk>, List<ToolCall>) - Constructor for class nl.dannyj.mistral.models.completion.message.DeltaMessage
-
Creates a new
DeltaMessage
instance. - description(String) - Method in class nl.dannyj.mistral.models.completion.tool.Function.FunctionBuilder
-
A description of what the function does, used by the model to choose when and how to call the function.
- description(String) - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema.JsonSchemaBuilder
-
An optional description of the schema.
- deserialize(JsonParser, DeserializationContext) - Method in class nl.dannyj.mistral.serialization.ContentChunkListDeserializer
- deserialize(JsonParser, DeserializationContext) - Method in class nl.dannyj.mistral.serialization.ToolChoiceOptionDeserializer
- DocumentURLChunk - Class in nl.dannyj.mistral.models.completion.content
-
Represents a document URL part of the message content.
- DocumentURLChunk() - Constructor for class nl.dannyj.mistral.models.completion.content.DocumentURLChunk
- DocumentURLChunk(URI, String) - Constructor for class nl.dannyj.mistral.models.completion.content.DocumentURLChunk
-
Creates a new
DocumentURLChunk
instance.
E
- EmbeddingRequest - Class in nl.dannyj.mistral.models.embedding
-
The EmbeddingRequest class represents a request to create embedding for a list of strings.
- EmbeddingRequest() - Constructor for class nl.dannyj.mistral.models.embedding.EmbeddingRequest
- EmbeddingRequest(String, List<String>) - Constructor for class nl.dannyj.mistral.models.embedding.EmbeddingRequest
-
Creates a new
EmbeddingRequest
instance. - EmbeddingRequest.EmbeddingRequestBuilder - Class in nl.dannyj.mistral.models.embedding
- EmbeddingResponse - Class in nl.dannyj.mistral.models.embedding
-
The EmbeddingResponse class represents a response from the Mistral API when creating embeddings.
- EmbeddingResponse() - Constructor for class nl.dannyj.mistral.models.embedding.EmbeddingResponse
- EmbeddingResponse(String, String, List<FloatEmbedding>, String, Usage) - Constructor for class nl.dannyj.mistral.models.embedding.EmbeddingResponse
-
Creates a new
EmbeddingResponse
instance. - equals(Object) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
- equals(Object) - Method in class nl.dannyj.mistral.models.completion.content.ImageURL
- equals(Object) - Method in class nl.dannyj.mistral.models.completion.message.AssistantMessage
- equals(Object) - Method in class nl.dannyj.mistral.models.completion.message.SystemMessage
- equals(Object) - Method in class nl.dannyj.mistral.models.completion.message.ToolMessage
- equals(Object) - Method in class nl.dannyj.mistral.models.completion.message.UserMessage
- equals(Object) - Method in class nl.dannyj.mistral.models.completion.Prediction
- equals(Object) - Method in class nl.dannyj.mistral.models.completion.tool.Function
- equals(Object) - Method in class nl.dannyj.mistral.models.completion.tool.FunctionCall
- equals(Object) - Method in class nl.dannyj.mistral.models.completion.tool.FunctionName
- equals(Object) - Method in class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice
- equals(Object) - Method in class nl.dannyj.mistral.models.completion.tool.Tool
- equals(Object) - Method in class nl.dannyj.mistral.models.completion.tool.ToolCall
- equals(Object) - Method in class nl.dannyj.mistral.models.embedding.EmbeddingRequest
- ERROR - Enum constant in enum class nl.dannyj.mistral.models.completion.FinishReason
-
The generation stopped due to an error.
F
- FinishReason - Enum Class in nl.dannyj.mistral.models.completion
-
Represents the reason why a chat completion generation finished.
- FloatEmbedding - Class in nl.dannyj.mistral.models.embedding
- FloatEmbedding() - Constructor for class nl.dannyj.mistral.models.embedding.FloatEmbedding
- FloatEmbedding(String, List<Float>, int) - Constructor for class nl.dannyj.mistral.models.embedding.FloatEmbedding
-
Creates a new
FloatEmbedding
instance. - frequencyPenalty(Double) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
Number between -2.0 and 2.0.
- function(Function) - Method in class nl.dannyj.mistral.models.completion.tool.Tool.ToolBuilder
-
The function definition.
- function(FunctionName) - Method in class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice.SpecificToolChoiceBuilder
-
The details of the function to be called.
- Function - Class in nl.dannyj.mistral.models.completion.tool
-
Represents the definition of a function that can be called by the model.
- Function() - Constructor for class nl.dannyj.mistral.models.completion.tool.Function
- Function(String, String, String, boolean) - Constructor for class nl.dannyj.mistral.models.completion.tool.Function
-
Creates a new
Function
instance. - FUNCTION - Enum constant in enum class nl.dannyj.mistral.models.completion.tool.ToolType
-
Represents a function tool.
- Function.FunctionBuilder - Class in nl.dannyj.mistral.models.completion.tool
- FunctionCall - Class in nl.dannyj.mistral.models.completion.tool
-
Represents the function call requested by the model, including the function name and its arguments as a JSON string.
- FunctionCall() - Constructor for class nl.dannyj.mistral.models.completion.tool.FunctionCall
- FunctionCall(String, String) - Constructor for class nl.dannyj.mistral.models.completion.tool.FunctionCall
-
Creates a new
FunctionCall
instance. - FunctionName - Class in nl.dannyj.mistral.models.completion.tool
-
Represents the name of a function, used when specifying a particular function for tool_choice.
- FunctionName() - Constructor for class nl.dannyj.mistral.models.completion.tool.FunctionName
- FunctionName(String) - Constructor for class nl.dannyj.mistral.models.completion.tool.FunctionName
-
Creates a new
FunctionName
instance.
G
- get(String) - Method in class nl.dannyj.mistral.services.HttpService
-
Makes a GET request to the specified URL path.
- getAliases() - Method in class nl.dannyj.mistral.models.model.Model
-
A list of aliases for the model.
- getApiKey() - Method in class nl.dannyj.mistral.MistralClient
- getArchived() - Method in class nl.dannyj.mistral.models.model.Model
-
Indicates if the fine-tuned model is archived.
- getArguments() - Method in class nl.dannyj.mistral.models.completion.tool.FunctionCall
-
The arguments to call the function with, represented as a JSON string.
- getCapabilities() - Method in class nl.dannyj.mistral.models.model.Model
-
The capabilities of the model.
- getChoices() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionResponse
-
The generated completions.
- getChoices() - Method in class nl.dannyj.mistral.models.completion.message.MessageChunk
-
The generated delta completions.
- getCompletionTokens() - Method in class nl.dannyj.mistral.models.usage.Usage
-
The number of tokens used for the completion ("output tokens").
- getContent() - Method in class nl.dannyj.mistral.models.completion.message.ChatMessage
-
The content of the message.
- getContent() - Method in class nl.dannyj.mistral.models.completion.message.DeltaMessage
-
A part of the message content.
- getContent() - Method in class nl.dannyj.mistral.models.completion.Prediction
-
The predicted content.
- getCreated() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionResponse
-
The time the chat completion was created in seconds since the epoch.
- getCreated() - Method in class nl.dannyj.mistral.models.completion.message.MessageChunk
-
The time the message chunk was created.
- getCreated() - Method in class nl.dannyj.mistral.models.model.Model
-
Creation time of the model in seconds since the Unix epoch.
- getData() - Method in class nl.dannyj.mistral.models.embedding.EmbeddingResponse
-
The embeddings that were created for the list of input strings.
- getDefaultModelTemperature() - Method in class nl.dannyj.mistral.models.model.Model
-
The default sampling temperature for the model.
- getDelta() - Method in class nl.dannyj.mistral.models.completion.DeltaChoice
-
The delta containing partial message updates.
- getDeprecation() - Method in class nl.dannyj.mistral.models.model.Model
-
The deprecation date and time for the model.
- getDescription() - Method in class nl.dannyj.mistral.models.completion.tool.Function
-
A description of what the function does, used by the model to choose when and how to call the function.
- getDescription() - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema
-
An optional description of the schema.
- getDescription() - Method in class nl.dannyj.mistral.models.model.Model
-
The description of the model.
- getDetail() - Method in class nl.dannyj.mistral.models.completion.content.ImageURL
-
Specifies the detail level of the image.
- getDocumentName() - Method in class nl.dannyj.mistral.models.completion.content.DocumentURLChunk
-
The optional filename of the document.
- getDocumentUrl() - Method in class nl.dannyj.mistral.models.completion.content.DocumentURLChunk
-
The URI of the document.
- getEmbedding() - Method in class nl.dannyj.mistral.models.embedding.FloatEmbedding
-
The embeddings for the input strings.
- getFinishReason() - Method in class nl.dannyj.mistral.models.completion.Choice
-
Reason for the completion to finish.
- getFinishReason() - Method in class nl.dannyj.mistral.models.completion.DeltaChoice
-
Reason for the completion to finish.
- getFormat() - Method in enum class nl.dannyj.mistral.models.completion.ResponseFormats
-
Returns a lowercase string representation of the format.
- getFrequencyPenalty() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Number between -2.0 and 2.0.
- getFunction() - Method in class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice
-
The details of the function to be called.
- getFunction() - Method in class nl.dannyj.mistral.models.completion.tool.Tool
-
The function definition.
- getFunction() - Method in class nl.dannyj.mistral.models.completion.tool.ToolCall
-
The details of the function to be called.
- getHttpClient() - Method in class nl.dannyj.mistral.MistralClient
- getId() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionResponse
-
Unique identifier for this response.
- getId() - Method in class nl.dannyj.mistral.models.completion.message.MessageChunk
-
The ID of the message chunk.
- getId() - Method in class nl.dannyj.mistral.models.completion.tool.ToolCall
-
The unique identifier for this specific tool call.
- getId() - Method in class nl.dannyj.mistral.models.embedding.EmbeddingResponse
-
Unique identifier for this response.
- getId() - Method in class nl.dannyj.mistral.models.model.Model
-
The ID of the model.
- getImageUrl() - Method in class nl.dannyj.mistral.models.completion.content.ImageURLChunk
-
The image URL details.
- getIndex() - Method in class nl.dannyj.mistral.models.completion.Choice
-
The index of the choice.
- getIndex() - Method in class nl.dannyj.mistral.models.completion.DeltaChoice
-
The index of the choice.
- getIndex() - Method in class nl.dannyj.mistral.models.completion.tool.ToolCall
-
The index of the tool call in the list, if multiple calls are made.
- getIndex() - Method in class nl.dannyj.mistral.models.embedding.FloatEmbedding
-
The index of the input string in the input list.
- getInput() - Method in class nl.dannyj.mistral.models.embedding.EmbeddingRequest
-
The list of strings to embed.
- getJob() - Method in class nl.dannyj.mistral.models.model.Model
-
The ID of the fine-tuning job that created this model.
- getJsonSchema() - Method in class nl.dannyj.mistral.models.completion.ResponseFormat
-
The JSON schema definition to use when type is JSON_SCHEMA.
- getMaxContextLength() - Method in class nl.dannyj.mistral.models.model.Model
-
The maximum context length supported by the model.
- getMaxTokens() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
The maximum number of tokens to generate in the completion.
- getMessage() - Method in class nl.dannyj.mistral.models.completion.Choice
-
The message that was generated.
- getMessages() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
The prompt(s) to generate completions for, encoded as a list of dict with role and content.
- getMistralService() - Method in class nl.dannyj.mistral.MistralClient
- getModel() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
ID of the model to use.
- getModel() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionResponse
-
The model used to generate the completion.
- getModel() - Method in class nl.dannyj.mistral.models.completion.message.MessageChunk
-
The model used to generate the completions.
- getModel() - Method in class nl.dannyj.mistral.models.embedding.EmbeddingRequest
-
The ID of the model to use for this request.
- getModel() - Method in class nl.dannyj.mistral.models.embedding.EmbeddingResponse
-
The model used to create the embeddings.
- getModels() - Method in class nl.dannyj.mistral.models.model.ListModelsResponse
-
The list of available models.
- getN() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
How many chat completion choices to generate for each input message.
- getName() - Method in class nl.dannyj.mistral.models.completion.message.ToolMessage
-
The name associated with the tool call.
- getName() - Method in class nl.dannyj.mistral.models.completion.tool.Function
-
The name of the function to be called.
- getName() - Method in class nl.dannyj.mistral.models.completion.tool.FunctionCall
-
The name of the function to call.
- getName() - Method in class nl.dannyj.mistral.models.completion.tool.FunctionName
-
The name of the function.
- getName() - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema
-
The name of the schema.
- getName() - Method in class nl.dannyj.mistral.models.model.Model
-
The name of the model.
- getObject() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionResponse
-
Undocumented, seems to be the type of the response.
- getObject() - Method in class nl.dannyj.mistral.models.completion.message.MessageChunk
-
Always chat.completion.chunk
- getObject() - Method in class nl.dannyj.mistral.models.embedding.EmbeddingResponse
-
Undocumented, seems to be the type of the response.
- getObject() - Method in class nl.dannyj.mistral.models.embedding.FloatEmbedding
-
Undocumented, seems to be the type of the response.
- getObject() - Method in class nl.dannyj.mistral.models.model.ListModelsResponse
-
Undocumented, seems to be the type of the response.
- getObject() - Method in class nl.dannyj.mistral.models.model.Model
-
The object type, which is always "model".
- getObjectMapper() - Method in class nl.dannyj.mistral.MistralClient
- getOwnedBy() - Method in class nl.dannyj.mistral.models.model.Model
-
Owner of the model.
- getParallelToolCalls() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Whether to allow parallel function calls.
- getParameters() - Method in class nl.dannyj.mistral.models.completion.tool.Function
-
The parameters the function accepts, described as a JSON Schema object.
- getPrediction() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Provides predicted output to optimize response time.
- getPresencePenalty() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Number between -2.0 and 2.0.
- getPromptTokens() - Method in class nl.dannyj.mistral.models.usage.Usage
-
The number of tokens used for the prompt ("input tokens").
- getRandomSeed() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
The seed to use for random sampling.
- getReason() - Method in enum class nl.dannyj.mistral.models.completion.FinishReason
-
Gets the string representation of the finish reason.
- getReferenceIds() - Method in class nl.dannyj.mistral.models.completion.content.ReferenceChunk
-
A list of integer identifiers referencing related documents or sources.
- getResponseFormat() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
An object specifying the format that the model must output.
- getRole() - Method in class nl.dannyj.mistral.models.completion.message.AssistantMessage
-
Gets the role of this message.
- getRole() - Method in class nl.dannyj.mistral.models.completion.message.ChatMessage
-
Gets the role of the message sender (e.g., system, user, assistant).
- getRole() - Method in class nl.dannyj.mistral.models.completion.message.DeltaMessage
-
The role of the message sender (e.g., assistant).
- getRole() - Method in enum class nl.dannyj.mistral.models.completion.message.MessageRole
-
Returns a lowercase string representation of the role.
- getRole() - Method in class nl.dannyj.mistral.models.completion.message.SystemMessage
-
Gets the role of this message.
- getRole() - Method in class nl.dannyj.mistral.models.completion.message.ToolMessage
-
Gets the role of this message.
- getRole() - Method in class nl.dannyj.mistral.models.completion.message.UserMessage
-
Gets the role of this message.
- getRoot() - Method in class nl.dannyj.mistral.models.model.Model
-
The root model ID from which this fine-tuned model was derived.
- getSchema() - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema
-
The JSON schema definition, represented as a String.
- getStop() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Stop generation if this token is detected.
- getStream() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Whether to stream back partial progress.
- getTemperature() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
What sampling temperature to use, Mistral recommends this to be between 0.0 and 0.7.
- getText() - Method in class nl.dannyj.mistral.models.completion.content.TextChunk
-
The actual text content of this chunk.
- getTextContent() - Method in class nl.dannyj.mistral.models.completion.DeltaChoice
-
Gets the text content of the delta.
- getTextContent() - Method in class nl.dannyj.mistral.models.completion.message.ChatMessage
-
Gets the text content of the message.
- getTextContent() - Method in class nl.dannyj.mistral.models.completion.message.DeltaMessage
-
Gets the text content of the delta message.
- getToolCallId() - Method in class nl.dannyj.mistral.models.completion.message.ToolMessage
-
The ID of the tool call that this message is a response to.
- getToolCalls() - Method in class nl.dannyj.mistral.models.completion.message.AssistantMessage
-
A list of tool calls requested by the model.
- getToolCalls() - Method in class nl.dannyj.mistral.models.completion.message.DeltaMessage
-
A partial list of tool calls requested by the model.
- getToolChoice() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Controls which function call(s) are made, if any.
- getTools() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
A list of tools the model may call.
- getTopP() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- getTotalTokens() - Method in class nl.dannyj.mistral.models.usage.Usage
-
The total number of tokens used (prompt tokens + completion tokens).
- getType() - Method in interface nl.dannyj.mistral.models.completion.content.ContentChunk
-
Gets the type identifier for this content chunk.
- getType() - Method in class nl.dannyj.mistral.models.completion.content.DocumentURLChunk
-
Gets the type identifier for this content chunk.
- getType() - Method in class nl.dannyj.mistral.models.completion.content.ImageURLChunk
-
Gets the type identifier for this content chunk.
- getType() - Method in class nl.dannyj.mistral.models.completion.content.ReferenceChunk
-
Gets the type identifier for this content chunk.
- getType() - Method in class nl.dannyj.mistral.models.completion.content.TextChunk
-
Gets the type identifier for this content chunk.
- getType() - Method in class nl.dannyj.mistral.models.completion.Prediction
-
The type of the prediction.
- getType() - Method in class nl.dannyj.mistral.models.completion.ResponseFormat
-
The type of the response format.
- getType() - Method in class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice
-
The type of the tool to be called.
- getType() - Method in class nl.dannyj.mistral.models.completion.tool.Tool
-
The type of the tool.
- getType() - Method in class nl.dannyj.mistral.models.completion.tool.ToolCall
-
The type of the tool being called.
- getType() - Method in enum class nl.dannyj.mistral.models.completion.tool.ToolType
-
Gets the string representation of the tool type.
- getType() - Method in class nl.dannyj.mistral.models.model.Model
-
The type of the model, e.g., "base" or "fine-tuned".
- getUrl() - Method in class nl.dannyj.mistral.models.completion.content.ImageURL
-
The URI of the image.
- getUsage() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionResponse
-
The tokens used to generate the completion.
- getUsage() - Method in class nl.dannyj.mistral.models.completion.message.MessageChunk
-
The tokens used to generate the completion.
- getUsage() - Method in class nl.dannyj.mistral.models.embedding.EmbeddingResponse
-
The token usage of the request.
- getValue() - Method in enum class nl.dannyj.mistral.models.completion.tool.ToolChoiceEnum
-
Gets the string representation of the tool choice option.
H
- hashCode() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
- hashCode() - Method in class nl.dannyj.mistral.models.completion.content.ImageURL
- hashCode() - Method in class nl.dannyj.mistral.models.completion.message.AssistantMessage
- hashCode() - Method in class nl.dannyj.mistral.models.completion.message.SystemMessage
- hashCode() - Method in class nl.dannyj.mistral.models.completion.message.ToolMessage
- hashCode() - Method in class nl.dannyj.mistral.models.completion.message.UserMessage
- hashCode() - Method in class nl.dannyj.mistral.models.completion.Prediction
- hashCode() - Method in class nl.dannyj.mistral.models.completion.tool.Function
- hashCode() - Method in class nl.dannyj.mistral.models.completion.tool.FunctionCall
- hashCode() - Method in class nl.dannyj.mistral.models.completion.tool.FunctionName
- hashCode() - Method in class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice
- hashCode() - Method in class nl.dannyj.mistral.models.completion.tool.Tool
- hashCode() - Method in class nl.dannyj.mistral.models.completion.tool.ToolCall
- hashCode() - Method in class nl.dannyj.mistral.models.embedding.EmbeddingRequest
- HttpService - Class in nl.dannyj.mistral.services
-
The HttpService class is responsible for making HTTP requests to the Mistral AI API.
- HttpService(OkHttpClient) - Constructor for class nl.dannyj.mistral.services.HttpService
-
Constructor that initializes the HttpService with a provided OkHttpClient.
I
- ImageURL - Class in nl.dannyj.mistral.models.completion.content
-
Represents the URL and optional detail level for an image within a message content chunk.
- ImageURL() - Constructor for class nl.dannyj.mistral.models.completion.content.ImageURL
- ImageURL(URI, String) - Constructor for class nl.dannyj.mistral.models.completion.content.ImageURL
-
Creates a new
ImageURL
instance. - ImageURLChunk - Class in nl.dannyj.mistral.models.completion.content
-
Represents an image URL part of the message content.
- ImageURLChunk() - Constructor for class nl.dannyj.mistral.models.completion.content.ImageURLChunk
- ImageURLChunk(ImageURL) - Constructor for class nl.dannyj.mistral.models.completion.content.ImageURLChunk
-
Creates a new
ImageURLChunk
instance. - input(List<String>) - Method in class nl.dannyj.mistral.models.embedding.EmbeddingRequest.EmbeddingRequestBuilder
-
The list of strings to embed.
- intercept(Interceptor.Chain) - Method in class nl.dannyj.mistral.interceptors.MistralHeaderInterceptor
- InvalidJsonException - Exception in nl.dannyj.mistral.exceptions
- InvalidJsonException() - Constructor for exception nl.dannyj.mistral.exceptions.InvalidJsonException
- InvalidJsonException(String) - Constructor for exception nl.dannyj.mistral.exceptions.InvalidJsonException
- InvalidJsonException(String, Throwable) - Constructor for exception nl.dannyj.mistral.exceptions.InvalidJsonException
- InvalidJsonException(Throwable) - Constructor for exception nl.dannyj.mistral.exceptions.InvalidJsonException
- isPrefix() - Method in class nl.dannyj.mistral.models.completion.message.AssistantMessage
-
Indicates if this assistant message acts as a prefix to guide the model's subsequent response.
- isSafePrompt() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Whether to inject a safety prompt before all conversations.
- isStrict() - Method in class nl.dannyj.mistral.models.completion.tool.Function
-
Whether to enable strict schema adherence for the function parameters.
- isStrict() - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema
-
Whether the schema should be strictly adhered to.
J
- JSON_OBJECT - Enum constant in enum class nl.dannyj.mistral.models.completion.ResponseFormats
- JSON_SCHEMA - Enum constant in enum class nl.dannyj.mistral.models.completion.ResponseFormats
- JsonSchema - Class in nl.dannyj.mistral.models.completion.tool
-
Represents the JSON schema definition used within ResponseFormat when type is json_schema.
- JsonSchema() - Constructor for class nl.dannyj.mistral.models.completion.tool.JsonSchema
- JsonSchema(String, String, String, boolean) - Constructor for class nl.dannyj.mistral.models.completion.tool.JsonSchema
-
Creates a new
JsonSchema
instance. - JsonSchema.JsonSchemaBuilder - Class in nl.dannyj.mistral.models.completion.tool
L
- LENGTH - Enum constant in enum class nl.dannyj.mistral.models.completion.FinishReason
-
The maximum number of tokens specified in the request was reached.
- listModels() - Method in class nl.dannyj.mistral.MistralClient
-
Lists all models available according to the Mistral AI API.
- listModels() - Method in class nl.dannyj.mistral.services.MistralService
-
Lists all models available according to the Mistral AI API.
- listModelsAsync() - Method in class nl.dannyj.mistral.MistralClient
-
Lists all models available according to the Mistral AI API.
- listModelsAsync() - Method in class nl.dannyj.mistral.services.MistralService
-
Lists all models available according to the Mistral AI API.
- ListModelsResponse - Class in nl.dannyj.mistral.models.model
-
The ListModelsResponse contains a list of all available models according to the Mistral AI API.
- ListModelsResponse() - Constructor for class nl.dannyj.mistral.models.model.ListModelsResponse
- ListModelsResponse(String, List<Model>) - Constructor for class nl.dannyj.mistral.models.model.ListModelsResponse
-
Creates a new
ListModelsResponse
instance.
M
- maxTokens(Integer) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
The maximum number of tokens to generate in the completion.
- message(ChatMessage) - Method in class nl.dannyj.mistral.builders.MessageListBuilder
-
Adds a pre-constructed ChatMessage object to the list.
- MessageChunk - Class in nl.dannyj.mistral.models.completion.message
-
A chunk of a message in a conversation.
- MessageChunk() - Constructor for class nl.dannyj.mistral.models.completion.message.MessageChunk
- MessageChunk(String, String, long, String, List<DeltaChoice>, Usage) - Constructor for class nl.dannyj.mistral.models.completion.message.MessageChunk
-
Creates a new
MessageChunk
instance. - MessageListBuilder - Class in nl.dannyj.mistral.builders
-
A builder class for creating a list of
ChatMessage
objects for a chat completion request. - MessageListBuilder() - Constructor for class nl.dannyj.mistral.builders.MessageListBuilder
-
Default constructor that initializes an empty list of ChatMessage objects.
- MessageListBuilder(List<ChatMessage>) - Constructor for class nl.dannyj.mistral.builders.MessageListBuilder
-
Constructor that initializes the list of ChatMessage objects with a provided list.
- MessageRole - Enum Class in nl.dannyj.mistral.models.completion.message
-
The role of the message.
- messages(List<ChatMessage>) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
The prompt(s) to generate completions for, encoded as a list of dict with role and content.
- MistralAPIException - Exception in nl.dannyj.mistral.exceptions
- MistralAPIException() - Constructor for exception nl.dannyj.mistral.exceptions.MistralAPIException
- MistralAPIException(String) - Constructor for exception nl.dannyj.mistral.exceptions.MistralAPIException
- MistralAPIException(String, Throwable) - Constructor for exception nl.dannyj.mistral.exceptions.MistralAPIException
- MistralAPIException(Throwable) - Constructor for exception nl.dannyj.mistral.exceptions.MistralAPIException
- MistralClient - Class in nl.dannyj.mistral
-
The MistralClient is the main class that interacts with all components of this library.
- MistralClient() - Constructor for class nl.dannyj.mistral.MistralClient
-
Default constructor that initializes the MistralClient with the API key from the environment variable "MISTRAL_API_KEY".
- MistralClient(int, int, int) - Constructor for class nl.dannyj.mistral.MistralClient
-
Default constructor that initializes the MistralClient with the API key from the environment variable "MISTRAL_API_KEY" and custom timeouts.
- MistralClient(String) - Constructor for class nl.dannyj.mistral.MistralClient
-
Constructor that initializes the MistralClient with a provided API key.
- MistralClient(String, int, int, int) - Constructor for class nl.dannyj.mistral.MistralClient
-
Constructor that initializes the MistralClient with a provided API key and custom timeouts.
- MistralClient(String, ObjectMapper) - Constructor for class nl.dannyj.mistral.MistralClient
-
Constructor that initializes the MistralClient with a provided API key and object mapper.
- MistralClient(String, ObjectMapper, int, int, int) - Constructor for class nl.dannyj.mistral.MistralClient
-
Constructor that initializes the MistralClient with a provided API key, object mapper, and custom timeouts.
- MistralClient(String, OkHttpClient) - Constructor for class nl.dannyj.mistral.MistralClient
-
Constructor that initializes the MistralClient with a provided API key and HTTP client.
- MistralClient(String, OkHttpClient, ObjectMapper) - Constructor for class nl.dannyj.mistral.MistralClient
-
Constructor that initializes the MistralClient with a provided API key, HTTP client, and object mapper.
- MistralHeaderInterceptor - Class in nl.dannyj.mistral.interceptors
- MistralHeaderInterceptor(String) - Constructor for class nl.dannyj.mistral.interceptors.MistralHeaderInterceptor
- MistralService - Class in nl.dannyj.mistral.services
-
The MistralService class provides methods to interact with the Mistral AI API.
- MistralService(HttpService, ObjectMapper) - Constructor for class nl.dannyj.mistral.services.MistralService
-
Constructor that initializes the MistralService with a provided HttpService and ObjectMapper.
- model(String) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
ID of the model to use.
- model(String) - Method in class nl.dannyj.mistral.models.embedding.EmbeddingRequest.EmbeddingRequestBuilder
-
The ID of the model to use for this request.
- Model - Class in nl.dannyj.mistral.models.model
-
Represents a model available in the Mistral AI API.
- Model() - Constructor for class nl.dannyj.mistral.models.model.Model
- Model(String, String, long, String, ModelCapabilities, String, String, Integer, List<String>, OffsetDateTime, Double, String, String, String, Boolean) - Constructor for class nl.dannyj.mistral.models.model.Model
-
Creates a new
Model
instance. - MODEL_LENGTH - Enum constant in enum class nl.dannyj.mistral.models.completion.FinishReason
-
The context length of the model was exceeded.
- ModelCapabilities - Class in nl.dannyj.mistral.models.model
-
Represents the capabilities of a Mistral AI model.
- ModelCapabilities() - Constructor for class nl.dannyj.mistral.models.model.ModelCapabilities
- ModelCapabilities(Boolean, Boolean, Boolean, Boolean, Boolean, Boolean) - Constructor for class nl.dannyj.mistral.models.model.ModelCapabilities
-
Creates a new
ModelCapabilities
instance.
N
- n(Integer) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
How many chat completion choices to generate for each input message.
- name(String) - Method in class nl.dannyj.mistral.models.completion.tool.Function.FunctionBuilder
-
The name of the function to be called.
- name(String) - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema.JsonSchemaBuilder
-
The name of the schema.
- nl.dannyj.mistral - package nl.dannyj.mistral
- nl.dannyj.mistral.builders - package nl.dannyj.mistral.builders
- nl.dannyj.mistral.exceptions - package nl.dannyj.mistral.exceptions
- nl.dannyj.mistral.interceptors - package nl.dannyj.mistral.interceptors
- nl.dannyj.mistral.models - package nl.dannyj.mistral.models
- nl.dannyj.mistral.models.completion - package nl.dannyj.mistral.models.completion
- nl.dannyj.mistral.models.completion.content - package nl.dannyj.mistral.models.completion.content
- nl.dannyj.mistral.models.completion.message - package nl.dannyj.mistral.models.completion.message
- nl.dannyj.mistral.models.completion.tool - package nl.dannyj.mistral.models.completion.tool
- nl.dannyj.mistral.models.embedding - package nl.dannyj.mistral.models.embedding
- nl.dannyj.mistral.models.model - package nl.dannyj.mistral.models.model
- nl.dannyj.mistral.models.usage - package nl.dannyj.mistral.models.usage
- nl.dannyj.mistral.net - package nl.dannyj.mistral.net
- nl.dannyj.mistral.serialization - package nl.dannyj.mistral.serialization
- nl.dannyj.mistral.services - package nl.dannyj.mistral.services
- NONE - Enum constant in enum class nl.dannyj.mistral.models.completion.tool.ToolChoiceEnum
-
The model will not call any tools.
O
- onChunkReceived(MessageChunk) - Method in interface nl.dannyj.mistral.net.ChatCompletionChunkCallback
-
Called when a new message chunk of the response is received.
- onComplete() - Method in interface nl.dannyj.mistral.net.ChatCompletionChunkCallback
-
Called when the entire response is received.
- onError(Exception) - Method in interface nl.dannyj.mistral.net.ChatCompletionChunkCallback
-
Called when an error occurs during the streaming request.
P
- parallelToolCalls(Boolean) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
Whether to allow parallel function calls.
- parameters(String) - Method in class nl.dannyj.mistral.models.completion.tool.Function.FunctionBuilder
-
The parameters the function accepts, described as a JSON Schema object.
- post(String, String) - Method in class nl.dannyj.mistral.services.HttpService
-
Makes a POST request to the specified URL path with the provided body.
- prediction(Prediction) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
Provides predicted output to optimize response time.
- Prediction - Class in nl.dannyj.mistral.models.completion
-
Represents the predicted output to optimize response time for ChatCompletionRequest.
- Prediction() - Constructor for class nl.dannyj.mistral.models.completion.Prediction
- Prediction(String, String) - Constructor for class nl.dannyj.mistral.models.completion.Prediction
-
Creates a new
Prediction
instance. - Prediction.PredictionBuilder - Class in nl.dannyj.mistral.models.completion
- presencePenalty(Double) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
Number between -2.0 and 2.0.
R
- randomSeed(Long) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
The seed to use for random sampling.
- ReferenceChunk - Class in nl.dannyj.mistral.models.completion.content
-
Represents a reference part of the message content, linking to specific source materials or documents.
- ReferenceChunk() - Constructor for class nl.dannyj.mistral.models.completion.content.ReferenceChunk
- ReferenceChunk(List<Integer>) - Constructor for class nl.dannyj.mistral.models.completion.content.ReferenceChunk
-
Creates a new
ReferenceChunk
instance. - Request - Interface in nl.dannyj.mistral.models
- REQUIRED - Enum constant in enum class nl.dannyj.mistral.models.completion.tool.ToolChoiceEnum
-
The model is forced to call a specific tool (not directly represented by this enum, but this value indicates a tool must be called, potentially specified by an object).
- Response - Interface in nl.dannyj.mistral.models
- responseFormat(ResponseFormat) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
An object specifying the format that the model must output.
- ResponseFormat - Class in nl.dannyj.mistral.models.completion
-
The response format of a completion request.
- ResponseFormat() - Constructor for class nl.dannyj.mistral.models.completion.ResponseFormat
- ResponseFormat(ResponseFormats) - Constructor for class nl.dannyj.mistral.models.completion.ResponseFormat
-
Constructor for creating a ResponseFormat object with a specified type.
- ResponseFormat(ResponseFormats, JsonSchema) - Constructor for class nl.dannyj.mistral.models.completion.ResponseFormat
-
Creates a new
ResponseFormat
instance. - ResponseFormats - Enum Class in nl.dannyj.mistral.models.completion
-
The response formats supported by mistral.
S
- safePrompt(boolean) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
Whether to inject a safety prompt before all conversations.
- schema(String) - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema.JsonSchemaBuilder
-
The JSON schema definition, represented as a String.
- setApiKey(String) - Method in class nl.dannyj.mistral.MistralClient
- setArguments(String) - Method in class nl.dannyj.mistral.models.completion.tool.FunctionCall
-
The arguments to call the function with, represented as a JSON string.
- setContent(String) - Method in class nl.dannyj.mistral.models.completion.Prediction
-
The predicted content.
- setDescription(String) - Method in class nl.dannyj.mistral.models.completion.tool.Function
-
A description of what the function does, used by the model to choose when and how to call the function.
- setDescription(String) - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema
-
An optional description of the schema.
- setDetail(String) - Method in class nl.dannyj.mistral.models.completion.content.ImageURL
-
Specifies the detail level of the image.
- setFrequencyPenalty(Double) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Number between -2.0 and 2.0.
- setFunction(Function) - Method in class nl.dannyj.mistral.models.completion.tool.Tool
-
The function definition.
- setFunction(FunctionCall) - Method in class nl.dannyj.mistral.models.completion.tool.ToolCall
-
The details of the function to be called.
- setFunction(FunctionName) - Method in class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice
-
The details of the function to be called.
- setHttpClient(OkHttpClient) - Method in class nl.dannyj.mistral.MistralClient
- setId(String) - Method in class nl.dannyj.mistral.models.completion.tool.ToolCall
-
The unique identifier for this specific tool call.
- setIndex(int) - Method in class nl.dannyj.mistral.models.completion.tool.ToolCall
-
The index of the tool call in the list, if multiple calls are made.
- setInput(List<String>) - Method in class nl.dannyj.mistral.models.embedding.EmbeddingRequest
-
The list of strings to embed.
- setJsonSchema(JsonSchema) - Method in class nl.dannyj.mistral.models.completion.ResponseFormat
-
The JSON schema definition to use when type is JSON_SCHEMA.
- setMaxTokens(Integer) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
The maximum number of tokens to generate in the completion.
- setMessages(List<ChatMessage>) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
The prompt(s) to generate completions for, encoded as a list of dict with role and content.
- setMistralService(MistralService) - Method in class nl.dannyj.mistral.MistralClient
- setModel(String) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
ID of the model to use.
- setModel(String) - Method in class nl.dannyj.mistral.models.embedding.EmbeddingRequest
-
The ID of the model to use for this request.
- setN(Integer) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
How many chat completion choices to generate for each input message.
- setName(String) - Method in class nl.dannyj.mistral.models.completion.message.ToolMessage
-
The name associated with the tool call.
- setName(String) - Method in class nl.dannyj.mistral.models.completion.tool.Function
-
The name of the function to be called.
- setName(String) - Method in class nl.dannyj.mistral.models.completion.tool.FunctionCall
-
The name of the function to call.
- setName(String) - Method in class nl.dannyj.mistral.models.completion.tool.FunctionName
-
The name of the function.
- setName(String) - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema
-
The name of the schema.
- setObjectMapper(ObjectMapper) - Method in class nl.dannyj.mistral.MistralClient
- setParallelToolCalls(Boolean) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Whether to allow parallel function calls.
- setParameters(String) - Method in class nl.dannyj.mistral.models.completion.tool.Function
-
The parameters the function accepts, described as a JSON Schema object.
- setPrediction(Prediction) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Provides predicted output to optimize response time.
- setPrefix(boolean) - Method in class nl.dannyj.mistral.models.completion.message.AssistantMessage
-
Indicates if this assistant message acts as a prefix to guide the model's subsequent response.
- setPresencePenalty(Double) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Number between -2.0 and 2.0.
- setRandomSeed(Long) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
The seed to use for random sampling.
- setResponseFormat(ResponseFormat) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
An object specifying the format that the model must output.
- setSafePrompt(boolean) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Whether to inject a safety prompt before all conversations.
- setSchema(String) - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema
-
The JSON schema definition, represented as a String.
- setStop(List<String>) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Stop generation if this token is detected.
- setStream(Boolean) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Whether to stream back partial progress.
- setStrict(boolean) - Method in class nl.dannyj.mistral.models.completion.tool.Function
-
Whether to enable strict schema adherence for the function parameters.
- setStrict(boolean) - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema
-
Whether the schema should be strictly adhered to.
- setTemperature(Double) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
What sampling temperature to use, Mistral recommends this to be between 0.0 and 0.7.
- setToolCallId(String) - Method in class nl.dannyj.mistral.models.completion.message.ToolMessage
-
The ID of the tool call that this message is a response to.
- setToolCalls(List<ToolCall>) - Method in class nl.dannyj.mistral.models.completion.message.AssistantMessage
-
A list of tool calls requested by the model.
- setToolChoice(ToolChoiceOption) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Controls which function call(s) are made, if any.
- setTools(List<Tool>) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
A list of tools the model may call.
- setTopP(Double) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
-
Nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- setType(String) - Method in class nl.dannyj.mistral.models.completion.Prediction
-
The type of the prediction.
- setType(ResponseFormats) - Method in class nl.dannyj.mistral.models.completion.ResponseFormat
-
The type of the response format.
- setType(ToolType) - Method in class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice
-
The type of the tool to be called.
- setType(ToolType) - Method in class nl.dannyj.mistral.models.completion.tool.Tool
-
The type of the tool.
- setType(ToolType) - Method in class nl.dannyj.mistral.models.completion.tool.ToolCall
-
The type of the tool being called.
- setUrl(URI) - Method in class nl.dannyj.mistral.models.completion.content.ImageURL
-
The URI of the image.
- SpecificToolChoice - Class in nl.dannyj.mistral.models.completion.tool
-
Represents the object variant for the 'tool_choice' parameter in a ChatCompletionRequest.
- SpecificToolChoice() - Constructor for class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice
- SpecificToolChoice(ToolType, FunctionName) - Constructor for class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice
-
Creates a new
SpecificToolChoice
instance. - SpecificToolChoice.SpecificToolChoiceBuilder - Class in nl.dannyj.mistral.models.completion.tool
- stop(List<String>) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
Stop generation if this token is detected.
- STOP - Enum constant in enum class nl.dannyj.mistral.models.completion.FinishReason
-
The model hit a natural stop point or a provided stop sequence.
- stream(Boolean) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
Whether to stream back partial progress.
- streamPost(String, String, Callback) - Method in class nl.dannyj.mistral.services.HttpService
-
Makes a streaming POST request to the specified URL path with the provided body.
- strict(boolean) - Method in class nl.dannyj.mistral.models.completion.tool.Function.FunctionBuilder
-
Whether to enable strict schema adherence for the function parameters.
- strict(boolean) - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema.JsonSchemaBuilder
-
Whether the schema should be strictly adhered to.
- supportsChatCompletion() - Method in class nl.dannyj.mistral.models.model.ModelCapabilities
- supportsClassification() - Method in class nl.dannyj.mistral.models.model.ModelCapabilities
- supportsFimCompletion() - Method in class nl.dannyj.mistral.models.model.ModelCapabilities
- supportsFineTuning() - Method in class nl.dannyj.mistral.models.model.ModelCapabilities
- supportsFunctionCalling() - Method in class nl.dannyj.mistral.models.model.ModelCapabilities
- supportsVision() - Method in class nl.dannyj.mistral.models.model.ModelCapabilities
- system(String) - Method in class nl.dannyj.mistral.builders.MessageListBuilder
-
Adds a system message to the list with the provided content.
- SYSTEM - Enum constant in enum class nl.dannyj.mistral.models.completion.message.MessageRole
- SystemMessage - Class in nl.dannyj.mistral.models.completion.message
-
Represents a message with the 'system' role in a chat conversation.
- SystemMessage() - Constructor for class nl.dannyj.mistral.models.completion.message.SystemMessage
- SystemMessage(String) - Constructor for class nl.dannyj.mistral.models.completion.message.SystemMessage
T
- temperature(Double) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
What sampling temperature to use, Mistral recommends this to be between 0.0 and 0.7.
- TEXT - Enum constant in enum class nl.dannyj.mistral.models.completion.ResponseFormats
- TextChunk - Class in nl.dannyj.mistral.models.completion.content
-
Represents a text part of the message content.
- TextChunk() - Constructor for class nl.dannyj.mistral.models.completion.content.TextChunk
- TextChunk(String) - Constructor for class nl.dannyj.mistral.models.completion.content.TextChunk
-
Creates a new
TextChunk
instance. - tool(String, String) - Method in class nl.dannyj.mistral.builders.MessageListBuilder
-
Adds a tool message with text content to the list.
- Tool - Class in nl.dannyj.mistral.models.completion.tool
-
Represents a tool that the model can call.
- Tool() - Constructor for class nl.dannyj.mistral.models.completion.tool.Tool
- Tool(ToolType, Function) - Constructor for class nl.dannyj.mistral.models.completion.tool.Tool
-
Creates a new
Tool
instance. - TOOL - Enum constant in enum class nl.dannyj.mistral.models.completion.message.MessageRole
- TOOL_CALLS - Enum constant in enum class nl.dannyj.mistral.models.completion.FinishReason
-
The model decided to call one or more tools.
- Tool.ToolBuilder - Class in nl.dannyj.mistral.models.completion.tool
- ToolCall - Class in nl.dannyj.mistral.models.completion.tool
-
Represents a tool call requested by the model as part of an Assistant message.
- ToolCall() - Constructor for class nl.dannyj.mistral.models.completion.tool.ToolCall
- ToolCall(String, ToolType, FunctionCall, int) - Constructor for class nl.dannyj.mistral.models.completion.tool.ToolCall
-
Creates a new
ToolCall
instance. - toolChoice(ToolChoiceOption) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
Controls which function call(s) are made, if any.
- ToolChoiceEnum - Enum Class in nl.dannyj.mistral.models.completion.tool
-
Defines the possible string values for the 'tool_choice' parameter in a ChatCompletionRequest.
- ToolChoiceOption - Interface in nl.dannyj.mistral.models.completion.tool
-
Represents the possible options for the 'tool_choice' parameter in a ChatCompletionRequest.
- ToolChoiceOptionDeserializer - Class in nl.dannyj.mistral.serialization
-
Custom deserializer for the ToolChoiceOption sealed interface.
- ToolChoiceOptionDeserializer() - Constructor for class nl.dannyj.mistral.serialization.ToolChoiceOptionDeserializer
- ToolMessage - Class in nl.dannyj.mistral.models.completion.message
-
Represents a message with the 'tool' role in a chat conversation.
- ToolMessage() - Constructor for class nl.dannyj.mistral.models.completion.message.ToolMessage
- ToolMessage(List<ContentChunk>, String) - Constructor for class nl.dannyj.mistral.models.completion.message.ToolMessage
-
Constructs a ToolMessage with potentially complex content and the corresponding tool call ID.
- ToolMessage(String, String) - Constructor for class nl.dannyj.mistral.models.completion.message.ToolMessage
-
Constructs a ToolMessage with simple text content and the corresponding tool call ID.
- tools(List<Tool>) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
A list of tools the model may call.
- ToolType - Enum Class in nl.dannyj.mistral.models.completion.tool
-
Defines the type of a tool.
- topP(Double) - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
-
Nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- toString() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
- toString() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionRequest
- toString() - Method in class nl.dannyj.mistral.models.completion.ChatCompletionResponse
- toString() - Method in class nl.dannyj.mistral.models.completion.Choice
- toString() - Method in class nl.dannyj.mistral.models.completion.content.ImageURL
- toString() - Method in class nl.dannyj.mistral.models.completion.DeltaChoice
- toString() - Method in class nl.dannyj.mistral.models.completion.message.DeltaMessage
- toString() - Method in class nl.dannyj.mistral.models.completion.Prediction.PredictionBuilder
- toString() - Method in class nl.dannyj.mistral.models.completion.Prediction
- toString() - Method in class nl.dannyj.mistral.models.completion.ResponseFormat
- toString() - Method in class nl.dannyj.mistral.models.completion.tool.Function.FunctionBuilder
- toString() - Method in class nl.dannyj.mistral.models.completion.tool.Function
- toString() - Method in class nl.dannyj.mistral.models.completion.tool.FunctionCall
- toString() - Method in class nl.dannyj.mistral.models.completion.tool.FunctionName
- toString() - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema.JsonSchemaBuilder
- toString() - Method in class nl.dannyj.mistral.models.completion.tool.JsonSchema
- toString() - Method in class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice.SpecificToolChoiceBuilder
- toString() - Method in class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice
- toString() - Method in class nl.dannyj.mistral.models.completion.tool.Tool.ToolBuilder
- toString() - Method in class nl.dannyj.mistral.models.completion.tool.Tool
- toString() - Method in class nl.dannyj.mistral.models.completion.tool.ToolCall
- toString() - Method in class nl.dannyj.mistral.models.embedding.EmbeddingRequest.EmbeddingRequestBuilder
- toString() - Method in class nl.dannyj.mistral.models.embedding.EmbeddingRequest
- toString() - Method in class nl.dannyj.mistral.models.embedding.EmbeddingResponse
- toString() - Method in class nl.dannyj.mistral.models.embedding.FloatEmbedding
- toString() - Method in class nl.dannyj.mistral.models.model.ListModelsResponse
- toString() - Method in class nl.dannyj.mistral.models.model.Model
- toString() - Method in class nl.dannyj.mistral.models.model.ModelCapabilities
- toString() - Method in class nl.dannyj.mistral.models.usage.Usage
- type(String) - Method in class nl.dannyj.mistral.models.completion.Prediction.PredictionBuilder
-
The type of the prediction.
- type(ToolType) - Method in class nl.dannyj.mistral.models.completion.tool.SpecificToolChoice.SpecificToolChoiceBuilder
-
The type of the tool to be called.
- type(ToolType) - Method in class nl.dannyj.mistral.models.completion.tool.Tool.ToolBuilder
-
The type of the tool.
U
- UnexpectedResponseEndException - Exception in nl.dannyj.mistral.exceptions
- UnexpectedResponseEndException() - Constructor for exception nl.dannyj.mistral.exceptions.UnexpectedResponseEndException
- UnexpectedResponseEndException(String) - Constructor for exception nl.dannyj.mistral.exceptions.UnexpectedResponseEndException
- UnexpectedResponseEndException(String, Throwable) - Constructor for exception nl.dannyj.mistral.exceptions.UnexpectedResponseEndException
- UnexpectedResponseEndException(Throwable) - Constructor for exception nl.dannyj.mistral.exceptions.UnexpectedResponseEndException
- UnexpectedResponseException - Exception in nl.dannyj.mistral.exceptions
- UnexpectedResponseException() - Constructor for exception nl.dannyj.mistral.exceptions.UnexpectedResponseException
- UnexpectedResponseException(String) - Constructor for exception nl.dannyj.mistral.exceptions.UnexpectedResponseException
- UnexpectedResponseException(String, Throwable) - Constructor for exception nl.dannyj.mistral.exceptions.UnexpectedResponseException
- UnexpectedResponseException(Throwable) - Constructor for exception nl.dannyj.mistral.exceptions.UnexpectedResponseException
- Usage - Class in nl.dannyj.mistral.models.usage
- Usage() - Constructor for class nl.dannyj.mistral.models.usage.Usage
- Usage(int, int, int) - Constructor for class nl.dannyj.mistral.models.usage.Usage
-
Creates a new
Usage
instance. - user(String) - Method in class nl.dannyj.mistral.builders.MessageListBuilder
-
Adds a user message with text content to the list.
- USER - Enum constant in enum class nl.dannyj.mistral.models.completion.message.MessageRole
- UserMessage - Class in nl.dannyj.mistral.models.completion.message
-
Represents a message with the 'user' role in a chat conversation.
- UserMessage() - Constructor for class nl.dannyj.mistral.models.completion.message.UserMessage
- UserMessage(List<ContentChunk>) - Constructor for class nl.dannyj.mistral.models.completion.message.UserMessage
-
Constructs a new UserMessage with a list of content chunks (for multi-modal input).
- UserMessage(String) - Constructor for class nl.dannyj.mistral.models.completion.message.UserMessage
-
Constructs a new UserMessage with simple text content.
V
- valueOf(String) - Static method in enum class nl.dannyj.mistral.models.completion.FinishReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nl.dannyj.mistral.models.completion.message.MessageRole
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nl.dannyj.mistral.models.completion.ResponseFormats
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nl.dannyj.mistral.models.completion.tool.ToolChoiceEnum
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class nl.dannyj.mistral.models.completion.tool.ToolType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class nl.dannyj.mistral.models.completion.FinishReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nl.dannyj.mistral.models.completion.message.MessageRole
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nl.dannyj.mistral.models.completion.ResponseFormats
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nl.dannyj.mistral.models.completion.tool.ToolChoiceEnum
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class nl.dannyj.mistral.models.completion.tool.ToolType
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages|Serialized Form