Package org.springframework.ai.mistralai.api

Class MistralAiApi.ChatCompletionRequest.ResponseFormat

java.lang.Object

org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ResponseFormat

Enclosing class:

MistralAiApi.ChatCompletionRequest

public static class MistralAiApi.ChatCompletionRequest.ResponseFormat
extends Object

An object specifying the format that the model must output.

Setting the type to JSON_SCHEMA enables Structured Outputs which ensures the model will match your supplied JSON schema.

See Also:

• Mistral AI Structured Output

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MistralAiApi.ChatCompletionRequest.ResponseFormat.Builder
static class	MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema	JSON schema object that describes the format of the JSON object.
static enum	MistralAiApi.ChatCompletionRequest.ResponseFormat.Type

Constructor Summary

Constructors

Constructor	Description
ResponseFormat()
ResponseFormat(String type)	Deprecated. Use builder() or factory methods instead.
ResponseFormat(String type, @Nullable Map<String,Object> jsonSchema)	Deprecated. Use builder() or factory methods instead.
ResponseFormat(MistralAiApi.ChatCompletionRequest.ResponseFormat.Type type, @Nullable String schema)

Method Summary

Modifier and Type	Method	Description
static MistralAiApi.ChatCompletionRequest.ResponseFormat.Builder	builder()
boolean	equals(@Nullable Object o)
@Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema	getJsonSchema()
@Nullable String	getSchema()
MistralAiApi.ChatCompletionRequest.ResponseFormat.Type	getType()
int	hashCode()
static MistralAiApi.ChatCompletionRequest.ResponseFormat	jsonObject()	Creates a ResponseFormat for JSON object output (JSON mode).
static MistralAiApi.ChatCompletionRequest.ResponseFormat	jsonSchema(Class<?> clazz)	Creates a ResponseFormat for JSON schema output with automatic schema generation from a class.
static MistralAiApi.ChatCompletionRequest.ResponseFormat	jsonSchema(String schema)	Creates a ResponseFormat for JSON schema output with a JSON schema string.
static MistralAiApi.ChatCompletionRequest.ResponseFormat	jsonSchema(Map<String,Object> schema)	Creates a ResponseFormat for JSON schema output with a JSON schema map.
void	setJsonSchema(MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema jsonSchema)
void	setSchema(@Nullable String schema)
void	setType(MistralAiApi.ChatCompletionRequest.ResponseFormat.Type type)
static MistralAiApi.ChatCompletionRequest.ResponseFormat	text()	Creates a ResponseFormat for text output.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ResponseFormat

public ResponseFormat()

ResponseFormat

@Deprecated
public ResponseFormat(String type)

Deprecated.

Use builder() or factory methods instead.

ResponseFormat

@Deprecated
public ResponseFormat(String type,
 @Nullable Map<String,Object> jsonSchema)

Deprecated.

Use builder() or factory methods instead.

ResponseFormat

public ResponseFormat(MistralAiApi.ChatCompletionRequest.ResponseFormat.Type type,
 @Nullable String schema)

Method Details

getType

public MistralAiApi.ChatCompletionRequest.ResponseFormat.Type getType()

setType

public void setType(MistralAiApi.ChatCompletionRequest.ResponseFormat.Type type)

getJsonSchema

public @Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema getJsonSchema()

setJsonSchema

public void setJsonSchema(MistralAiApi.ChatCompletionRequest.ResponseFormat.JsonSchema jsonSchema)

getSchema

public @Nullable String getSchema()

setSchema

public void setSchema(@Nullable String schema)

text

public static MistralAiApi.ChatCompletionRequest.ResponseFormat text()

Creates a ResponseFormat for text output.

Returns:

ResponseFormat configured for text output

jsonObject

public static MistralAiApi.ChatCompletionRequest.ResponseFormat jsonObject()

Creates a ResponseFormat for JSON object output (JSON mode).

Returns:

ResponseFormat configured for JSON object output

jsonSchema

public static MistralAiApi.ChatCompletionRequest.ResponseFormat jsonSchema(Class<?> clazz)

Creates a ResponseFormat for JSON schema output with automatic schema generation from a class.

Parameters:

clazz - the class to generate the JSON schema from

Returns:

ResponseFormat configured with the generated JSON schema

jsonSchema

public static MistralAiApi.ChatCompletionRequest.ResponseFormat jsonSchema(String schema)

Creates a ResponseFormat for JSON schema output with a JSON schema string.

Parameters:

schema - the JSON schema as a string

Returns:

ResponseFormat configured with the provided JSON schema

jsonSchema

public static MistralAiApi.ChatCompletionRequest.ResponseFormat jsonSchema(Map<String,Object> schema)

Creates a ResponseFormat for JSON schema output with a JSON schema map.

Parameters:

schema - the JSON schema as a map

Returns:

ResponseFormat configured with the provided JSON schema

builder

public static MistralAiApi.ChatCompletionRequest.ResponseFormat.Builder builder()

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object