Package com.sap.ai.sdk.prompt.registry.model

Class ResponseFormatJsonObject

java.lang.Object

com.sap.ai.sdk.prompt.registry.model.ResponseFormatJsonObject

All Implemented Interfaces:

PromptTemplateSpecResponseFormat, TemplateResponseFormat

public class ResponseFormatJsonObject
extends Object
implements PromptTemplateSpecResponseFormat, TemplateResponseFormat

ResponseFormatJsonObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResponseFormatJsonObject.Builder	Builder helper class.
static enum	ResponseFormatJsonObject.TypeEnum	The type of response format being defined: `json_object`

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResponseFormatJsonObject()	Default constructor for ResponseFormatJsonObject.

Method Summary

Modifier and Type	Method	Description
static ResponseFormatJsonObject.Builder	create()	Create a type-safe, fluent-api builder object to construct a new ResponseFormatJsonObject instance with all required arguments.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ResponseFormatJsonObject.
ResponseFormatJsonObject.TypeEnum	getType()	The type of response format being defined: `json_object`
int	hashCode()
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ResponseFormatJsonObject instance.
void	setType(ResponseFormatJsonObject.TypeEnum type)	Set the type of this ResponseFormatJsonObject instance.
Map<String,Object>	toMap()	Get the value of all properties of this ResponseFormatJsonObject instance including unrecognized properties.
String	toString()
ResponseFormatJsonObject	type(ResponseFormatJsonObject.TypeEnum type)	Set the type of this ResponseFormatJsonObject instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

ResponseFormatJsonObject

protected ResponseFormatJsonObject()

Default constructor for ResponseFormatJsonObject.

Method Details

type

@Nonnull
public ResponseFormatJsonObject type(@Nonnull
 ResponseFormatJsonObject.TypeEnum type)

Set the type of this ResponseFormatJsonObject instance and return the same instance.

Parameters:

type - The type of response format being defined: `json_object`

Returns:

The same instance of this ResponseFormatJsonObject class

getType

@Nonnull
public ResponseFormatJsonObject.TypeEnum getType()

The type of response format being defined: `json_object`

Returns:

type The type of this ResponseFormatJsonObject instance.

setType

public void setType(@Nonnull
 ResponseFormatJsonObject.TypeEnum type)

Set the type of this ResponseFormatJsonObject instance.

Parameters:

type - The type of response format being defined: `json_object`

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ResponseFormatJsonObject.

Returns:

The set of properties names

getCustomField

@Nullable
@Deprecated
public Object getCustomField(@Nonnull
 String name)
                      throws NoSuchElementException

Deprecated.

Use toMap() instead.

Get the value of an unrecognizable property of this ResponseFormatJsonObject instance.

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

NoSuchElementException - If no property with the given name could be found.

toMap

@Nonnull
public Map<String,Object> toMap()

Get the value of all properties of this ResponseFormatJsonObject instance including unrecognized properties.

Returns:

The map of all properties

setCustomField

public void setCustomField(@Nonnull
 String customFieldName,
 @Nullable
 Object customFieldValue)

Set an unrecognizable property of this ResponseFormatJsonObject instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

customFieldName - The name of the property

customFieldValue - The value of the property

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

create

public static ResponseFormatJsonObject.Builder create()

Create a type-safe, fluent-api builder object to construct a new ResponseFormatJsonObject instance with all required arguments.