Package org.springframework.ai.openai.api

Class ResponseFormat

java.lang.Object

org.springframework.ai.openai.api.ResponseFormat

public class 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. Learn more in the Structured Outputs guide.
References: OpenAi API - ResponseFormat, JSON Mode, Structured Outputs vs JSON mode

Since:

1.0.0

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ResponseFormat()
ResponseFormat(ResponseFormat.Type type, String schema)

Method Summary

Modifier and Type	Method	Description
static ResponseFormat.Builder	builder()
boolean	equals(Object o)
ResponseFormat.JsonSchema	getJsonSchema()
String	getSchema()
ResponseFormat.Type	getType()
int	hashCode()
void	setJsonSchema(ResponseFormat.JsonSchema jsonSchema)
void	setSchema(String schema)
void	setType(ResponseFormat.Type type)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ResponseFormat

public ResponseFormat()

ResponseFormat

public ResponseFormat(ResponseFormat.Type type,
 String schema)

Method Details

getType

public ResponseFormat.Type getType()

setType

public void setType(ResponseFormat.Type type)

getJsonSchema

public ResponseFormat.JsonSchema getJsonSchema()

setJsonSchema

public void setJsonSchema(ResponseFormat.JsonSchema jsonSchema)

getSchema

public String getSchema()

setSchema

public void setSchema(String schema)

builder

public static ResponseFormat.Builder builder()

equals

public boolean equals(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