Package org.springframework.ai.azure.openai

Class AzureOpenAiResponseFormat

java.lang.Object

org.springframework.ai.azure.openai.AzureOpenAiResponseFormat

public class AzureOpenAiResponseFormat
extends Object

Utility enumeration for representing the response format that may be requested from the Azure OpenAI model. Please check OpenAI API documentation for more details.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

AzureOpenAiResponseFormat

public AzureOpenAiResponseFormat()

AzureOpenAiResponseFormat

public AzureOpenAiResponseFormat(AzureOpenAiResponseFormat.Type type,
 String schema)

Method Details

getType

public AzureOpenAiResponseFormat.Type getType()

setType

public void setType(AzureOpenAiResponseFormat.Type type)

getJsonSchema

public AzureOpenAiResponseFormat.JsonSchema getJsonSchema()

setJsonSchema

public void setJsonSchema(AzureOpenAiResponseFormat.JsonSchema jsonSchema)

getSchema

public String getSchema()

setSchema

public void setSchema(String schema)

builder

public static AzureOpenAiResponseFormat.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