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

Class ResponseFormatJsonSchemaJsonSchema

java.lang.Object

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

public class ResponseFormatJsonSchemaJsonSchema
extends Object

ResponseFormatJsonSchemaJsonSchema

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResponseFormatJsonSchemaJsonSchema.Builder	Builder helper class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ResponseFormatJsonSchemaJsonSchema.Builder	create()	Create a type-safe, fluent-api builder object to construct a new ResponseFormatJsonSchemaJsonSchema instance with all required arguments.
ResponseFormatJsonSchemaJsonSchema	description(String description)	Set the description of this ResponseFormatJsonSchemaJsonSchema instance and return the same instance.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ResponseFormatJsonSchemaJsonSchema.
String	getDescription()	A description of what the response format is for, used by the model to determine how to respond in the format.
String	getName()	The name of the response format.
Map<String,Object>	getSchema()	The schema for the response format, described as a JSON Schema object.
int	hashCode()
Boolean	isStrict()	Whether to enable strict schema adherence when generating the output.
ResponseFormatJsonSchemaJsonSchema	name(String name)	Set the name of this ResponseFormatJsonSchemaJsonSchema instance and return the same instance.
ResponseFormatJsonSchemaJsonSchema	putschemaItem(String key, Object schemaItem)	Put one schema instance to this ResponseFormatJsonSchemaJsonSchema instance.
ResponseFormatJsonSchemaJsonSchema	schema(Map<String,Object> schema)	Set the schema of this ResponseFormatJsonSchemaJsonSchema instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ResponseFormatJsonSchemaJsonSchema instance.
void	setDescription(String description)	Set the description of this ResponseFormatJsonSchemaJsonSchema instance.
void	setName(String name)	Set the name of this ResponseFormatJsonSchemaJsonSchema instance.
void	setSchema(Map<String,Object> schema)	Set the schema of this ResponseFormatJsonSchemaJsonSchema instance.
void	setStrict(Boolean strict)	Set the strict of this ResponseFormatJsonSchemaJsonSchema instance.
ResponseFormatJsonSchemaJsonSchema	strict(Boolean strict)	Set the strict of this ResponseFormatJsonSchemaJsonSchema instance and return the same instance.
Map<String,Object>	toMap()	Get the value of all properties of this ResponseFormatJsonSchemaJsonSchema instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ResponseFormatJsonSchemaJsonSchema

protected ResponseFormatJsonSchemaJsonSchema()

Default constructor for ResponseFormatJsonSchemaJsonSchema.

Method Details

description

@Nonnull
public ResponseFormatJsonSchemaJsonSchema description(@Nullable
 String description)

Set the description of this ResponseFormatJsonSchemaJsonSchema instance and return the same instance.

Parameters:

description - A description of what the response format is for, used by the model to determine how to respond in the format.

Returns:

The same instance of this ResponseFormatJsonSchemaJsonSchema class

getDescription

@Nonnull
public String getDescription()

A description of what the response format is for, used by the model to determine how to respond in the format.

Returns:

description The description of this ResponseFormatJsonSchemaJsonSchema instance.

setDescription

public void setDescription(@Nullable
 String description)

Set the description of this ResponseFormatJsonSchemaJsonSchema instance.

Parameters:

description - A description of what the response format is for, used by the model to determine how to respond in the format.

name

@Nonnull
public ResponseFormatJsonSchemaJsonSchema name(@Nonnull
 String name)

Set the name of this ResponseFormatJsonSchemaJsonSchema instance and return the same instance.

Parameters:

name - The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Returns:

The same instance of this ResponseFormatJsonSchemaJsonSchema class

getName

@Nonnull
public String getName()

The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Returns:

name The name of this ResponseFormatJsonSchemaJsonSchema instance.

setName

public void setName(@Nonnull
 String name)

Set the name of this ResponseFormatJsonSchemaJsonSchema instance.

Parameters:

name - The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

schema

@Nonnull
public ResponseFormatJsonSchemaJsonSchema schema(@Nullable
 Map<String,Object> schema)

Set the schema of this ResponseFormatJsonSchemaJsonSchema instance and return the same instance.

Parameters:

schema - The schema for the response format, described as a JSON Schema object.

Returns:

The same instance of this ResponseFormatJsonSchemaJsonSchema class

putschemaItem

@Nonnull
public ResponseFormatJsonSchemaJsonSchema putschemaItem(@Nonnull
 String key,
 @Nullable
 Object schemaItem)

Put one schema instance to this ResponseFormatJsonSchemaJsonSchema instance.

Parameters:

key - The String key of this schema instance

schemaItem - The schema that should be added under the given key

Returns:

The same instance of type ResponseFormatJsonSchemaJsonSchema

getSchema

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

The schema for the response format, described as a JSON Schema object.

Returns:

schema The schema of this ResponseFormatJsonSchemaJsonSchema instance.

setSchema

public void setSchema(@Nullable
 Map<String,Object> schema)

Set the schema of this ResponseFormatJsonSchemaJsonSchema instance.

Parameters:

schema - The schema for the response format, described as a JSON Schema object.

strict

@Nonnull
public ResponseFormatJsonSchemaJsonSchema strict(@Nullable
 Boolean strict)

Set the strict of this ResponseFormatJsonSchemaJsonSchema instance and return the same instance.

Parameters:

strict - Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. To learn more, read the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).

Returns:

The same instance of this ResponseFormatJsonSchemaJsonSchema class

isStrict

@Nullable
public Boolean isStrict()

Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. To learn more, read the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).

Returns:

strict The strict of this ResponseFormatJsonSchemaJsonSchema instance.

setStrict

public void setStrict(@Nullable
 Boolean strict)

Set the strict of this ResponseFormatJsonSchemaJsonSchema instance.

Parameters:

strict - Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. To learn more, read the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ResponseFormatJsonSchemaJsonSchema.

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 ResponseFormatJsonSchemaJsonSchema 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 ResponseFormatJsonSchemaJsonSchema 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 ResponseFormatJsonSchemaJsonSchema 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 ResponseFormatJsonSchemaJsonSchema.Builder create()

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