Class ResponseFormatJsonSchema
java.lang.Object
com.sap.ai.sdk.prompt.registry.model.ResponseFormatJsonSchema
- All Implemented Interfaces:
PromptTemplateSpecResponseFormat,TemplateResponseFormat
public class ResponseFormatJsonSchema
extends Object
implements PromptTemplateSpecResponseFormat, TemplateResponseFormat
ResponseFormatJsonSchema
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceBuilder helper class.static interfaceBuilder helper class.static enumThe type of response format being defined: `json_schema` -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDefault constructor for ResponseFormatJsonSchema. -
Method Summary
Modifier and TypeMethodDescriptioncreate()Create a type-safe, fluent-api builder object to construct a newResponseFormatJsonSchemainstance with all required arguments.booleangetCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theResponseFormatJsonSchema.Get jsonSchemagetType()The type of response format being defined: `json_schema`inthashCode()jsonSchema(ResponseFormatJsonSchemaJsonSchema jsonSchema) Set the jsonSchema of thisResponseFormatJsonSchemainstance and return the same instance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisResponseFormatJsonSchemainstance.voidsetJsonSchema(ResponseFormatJsonSchemaJsonSchema jsonSchema) Set the jsonSchema of thisResponseFormatJsonSchemainstance.voidSet the type of thisResponseFormatJsonSchemainstance.toMap()Get the value of all properties of thisResponseFormatJsonSchemainstance including unrecognized properties.toString()Set the type of thisResponseFormatJsonSchemainstance and return the same instance.
-
Constructor Details
-
ResponseFormatJsonSchema
protected ResponseFormatJsonSchema()Default constructor for ResponseFormatJsonSchema.
-
-
Method Details
-
type
Set the type of thisResponseFormatJsonSchemainstance and return the same instance.- Parameters:
type- The type of response format being defined: `json_schema`- Returns:
- The same instance of this
ResponseFormatJsonSchemaclass
-
getType
The type of response format being defined: `json_schema`- Returns:
- type The type of this
ResponseFormatJsonSchemainstance.
-
setType
Set the type of thisResponseFormatJsonSchemainstance.- Parameters:
type- The type of response format being defined: `json_schema`
-
jsonSchema
@Nonnull public ResponseFormatJsonSchema jsonSchema(@Nonnull ResponseFormatJsonSchemaJsonSchema jsonSchema) Set the jsonSchema of thisResponseFormatJsonSchemainstance and return the same instance.- Parameters:
jsonSchema- The jsonSchema of thisResponseFormatJsonSchema- Returns:
- The same instance of this
ResponseFormatJsonSchemaclass
-
getJsonSchema
Get jsonSchema- Returns:
- jsonSchema The jsonSchema of this
ResponseFormatJsonSchemainstance.
-
setJsonSchema
Set the jsonSchema of thisResponseFormatJsonSchemainstance.- Parameters:
jsonSchema- The jsonSchema of thisResponseFormatJsonSchema
-
getCustomFieldNames
Get the names of the unrecognizable properties of theResponseFormatJsonSchema.- Returns:
- The set of properties names
-
getCustomField
@Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException Deprecated.UsetoMap()instead.Get the value of an unrecognizable property of thisResponseFormatJsonSchemainstance.- 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
Get the value of all properties of thisResponseFormatJsonSchemainstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisResponseFormatJsonSchemainstance. 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 propertycustomFieldValue- The value of the property
-
equals
-
hashCode
public int hashCode() -
toString
-
create
Create a type-safe, fluent-api builder object to construct a newResponseFormatJsonSchemainstance with all required arguments.
-
toMap()instead.