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 ClassesModifier and TypeClassDescriptionstatic interfaceBuilder helper class.static enumThe type of response format being defined: `json_object` -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDefault constructor for ResponseFormatJsonObject. -
Method Summary
Modifier and TypeMethodDescriptioncreate()Create a type-safe, fluent-api builder object to construct a newResponseFormatJsonObjectinstance with all required arguments.booleangetCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theResponseFormatJsonObject.getType()The type of response format being defined: `json_object`inthashCode()voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisResponseFormatJsonObjectinstance.voidSet the type of thisResponseFormatJsonObjectinstance.toMap()Get the value of all properties of thisResponseFormatJsonObjectinstance including unrecognized properties.toString()Set the type of thisResponseFormatJsonObjectinstance and return the same instance.
-
Constructor Details
-
ResponseFormatJsonObject
protected ResponseFormatJsonObject()Default constructor for ResponseFormatJsonObject.
-
-
Method Details
-
type
Set the type of thisResponseFormatJsonObjectinstance and return the same instance.- Parameters:
type- The type of response format being defined: `json_object`- Returns:
- The same instance of this
ResponseFormatJsonObjectclass
-
getType
The type of response format being defined: `json_object`- Returns:
- type The type of this
ResponseFormatJsonObjectinstance.
-
setType
Set the type of thisResponseFormatJsonObjectinstance.- Parameters:
type- The type of response format being defined: `json_object`
-
getCustomFieldNames
Get the names of the unrecognizable properties of theResponseFormatJsonObject.- 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 thisResponseFormatJsonObjectinstance.- 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 thisResponseFormatJsonObjectinstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisResponseFormatJsonObjectinstance. 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 newResponseFormatJsonObjectinstance with all required arguments.
-
toMap()instead.