Package org.springframework.ai.openai

Class OpenAiChatModel.ResponseFormat

java.lang.Object

org.springframework.ai.openai.OpenAiChatModel.ResponseFormat

Enclosing class:

OpenAiChatModel

public static class OpenAiChatModel.ResponseFormat
extends Object

Response format (text, json_object, json_schema) for OpenAiChatModel responses.

Author:

Julien Dubois, Mariusz Bernacki, Grogdunn, Thomas Vitale, John Blum, Mark Pollack, Josh Long, Jemin Huh, Ueibin Kim, Alexandros Pappas, luocongqiu, Hyunjoon Choi, Jonghoon Park, Sebastien Deleuze, Bishen Yu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiChatModel.ResponseFormat.Builder
static enum	OpenAiChatModel.ResponseFormat.Type

Constructor Summary

Constructors

Constructor	Description
ResponseFormat()

Method Summary

Modifier and Type	Method	Description
static OpenAiChatModel.ResponseFormat.Builder	builder()
boolean	equals(@Nullable Object o)
@Nullable String	getJsonSchema()
@Nullable Boolean	getStrict()	Whether to enable strict schema adherence for JSON schema response format.
OpenAiChatModel.ResponseFormat.Type	getType()
int	hashCode()
void	setJsonSchema(@Nullable String jsonSchema)
void	setStrict(@Nullable Boolean strict)
void	setType(OpenAiChatModel.ResponseFormat.Type type)

Methods inherited from class java.lang.Object

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

Constructor Details

ResponseFormat

public ResponseFormat()

Method Details

getType

public OpenAiChatModel.ResponseFormat.Type getType()

setType

public void setType(OpenAiChatModel.ResponseFormat.Type type)

getJsonSchema

public @Nullable String getJsonSchema()

setJsonSchema

public void setJsonSchema(@Nullable String jsonSchema)

getStrict

public @Nullable Boolean getStrict()

Whether to enable strict schema adherence for JSON schema response format. Defaults to true when unset.

This applies only to the JSON schema response format and is distinct from OpenAiChatOptions.AbstractBuilder.strict(Boolean), which controls strict mode for tool/function calling.

Returns:

the strict flag, or null if not configured

setStrict

public void setStrict(@Nullable Boolean strict)

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static OpenAiChatModel.ResponseFormat.Builder builder()