Package org.springframework.ai.mistralai

Class MistralAiChatOptions.AbstractBuilder<B extends MistralAiChatOptions.AbstractBuilder<B>>

java.lang.Object

org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder<B>

org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder<B>

org.springframework.ai.mistralai.MistralAiChatOptions.AbstractBuilder<B>

All Implemented Interfaces:

ChatOptions.Builder<B>, StructuredOutputChatOptions.Builder<B>, ToolCallingChatOptions.Builder<B>

Direct Known Subclasses:

MistralAiChatOptions.Builder

Enclosing class:

MistralAiChatOptions

protected abstract static class MistralAiChatOptions.AbstractBuilder<B extends MistralAiChatOptions.AbstractBuilder<B>>
extends DefaultToolCallingChatOptions.Builder<B>
implements StructuredOutputChatOptions.Builder<B>

Field Summary

Fields inherited from class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

internalToolExecutionEnabled, toolCallbacks, toolContext, toolNames

Fields inherited from class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

frequencyPenalty, maxTokens, model, presencePenalty, stopSequences, temperature, topK, topP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
MistralAiChatOptions	build()	Build the ChatOptions.
B	combineWith(ChatOptions.Builder<?> other)	Mutate this builder by taking all other's values that are non-null, retaining this other values.
B	model(@Nullable MistralAiApi.ChatModel chatModel)
B	n(@Nullable Integer n)
B	outputSchema(@Nullable String outputSchema)
B	randomSeed(@Nullable Integer randomSeed)
B	responseFormat(@Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat responseFormat)
B	safePrompt(@Nullable Boolean safePrompt)
B	stop(@Nullable List<String> stop)
B	toolChoice(@Nullable MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice)
B	tools(@Nullable List<MistralAiApi.FunctionTool> tools)

Methods inherited from class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

internalToolExecutionEnabled, toolCallbacks, toolCallbacks, toolContext, toolContext, toolNames, toolNames

Methods inherited from class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

frequencyPenalty, maxTokens, model, presencePenalty, self, stopSequences, temperature, topK, topP

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

frequencyPenalty, maxTokens, model, presencePenalty, stopSequences, temperature, topK, topP

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Method Details

model

public B model(@Nullable MistralAiApi.ChatModel chatModel)

safePrompt

public B safePrompt(@Nullable Boolean safePrompt)

randomSeed

public B randomSeed(@Nullable Integer randomSeed)

stop

public B stop(@Nullable List<String> stop)

responseFormat

public B responseFormat(@Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat responseFormat)

n

public B n(@Nullable Integer n)

tools

public B tools(@Nullable List<MistralAiApi.FunctionTool> tools)

toolChoice

public B toolChoice(@Nullable MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice)

outputSchema

public B outputSchema(@Nullable String outputSchema)

Specified by:

outputSchema in interface StructuredOutputChatOptions.Builder<B extends MistralAiChatOptions.AbstractBuilder<B>>

combineWith

public B combineWith(ChatOptions.Builder<?> other)

Description copied from interface: ChatOptions.Builder

Mutate this builder by taking all other's values that are non-null, retaining this other values.

Specified by:

combineWith in interface ChatOptions.Builder<B extends MistralAiChatOptions.AbstractBuilder<B>>

Overrides:

combineWith in class DefaultToolCallingChatOptions.Builder<B extends MistralAiChatOptions.AbstractBuilder<B>>

build

public MistralAiChatOptions build()

Description copied from interface: ChatOptions.Builder

Build the ChatOptions.

Specified by:

build in interface ChatOptions.Builder<B extends MistralAiChatOptions.AbstractBuilder<B>>

Specified by:

build in interface ToolCallingChatOptions.Builder<B extends MistralAiChatOptions.AbstractBuilder<B>>

Overrides:

build in class DefaultToolCallingChatOptions.Builder<B extends MistralAiChatOptions.AbstractBuilder<B>>

Returns:

the Chat options.