Package org.springframework.ai.openai

Class OpenAiChatModel.ResponseFormat.Builder

java.lang.Object

org.springframework.ai.openai.OpenAiChatModel.ResponseFormat.Builder

Enclosing class:

OpenAiChatModel.ResponseFormat

public static final class OpenAiChatModel.ResponseFormat.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
OpenAiChatModel.ResponseFormat	build()
OpenAiChatModel.ResponseFormat.Builder	jsonSchema(String jsonSchema)
OpenAiChatModel.ResponseFormat.Builder	strict(@Nullable Boolean strict)	Whether to enable strict schema adherence for JSON schema response format.
OpenAiChatModel.ResponseFormat.Builder	type(OpenAiChatModel.ResponseFormat.Type type)

Methods inherited from class java.lang.Object

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

Method Details

type

public OpenAiChatModel.ResponseFormat.Builder type(OpenAiChatModel.ResponseFormat.Type type)

jsonSchema

public OpenAiChatModel.ResponseFormat.Builder jsonSchema(String jsonSchema)

strict

public OpenAiChatModel.ResponseFormat.Builder strict(@Nullable Boolean strict)

Whether to enable strict schema adherence for JSON schema response format.

Not to be confused with OpenAiChatOptions.AbstractBuilder.strict(Boolean), which applies to tool/function calling rather than response format.

Parameters:

strict - the strict flag

Returns:

this builder

build

public OpenAiChatModel.ResponseFormat build()