Class ResponseFormatJsonSchemaJsonSchema
java.lang.Object
com.sap.ai.sdk.prompt.registry.model.ResponseFormatJsonSchemaJsonSchema
ResponseFormatJsonSchemaJsonSchema
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceBuilder helper class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDefault constructor for ResponseFormatJsonSchemaJsonSchema. -
Method Summary
Modifier and TypeMethodDescriptioncreate()Create a type-safe, fluent-api builder object to construct a newResponseFormatJsonSchemaJsonSchemainstance with all required arguments.description(String description) Set the description of thisResponseFormatJsonSchemaJsonSchemainstance and return the same instance.booleangetCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theResponseFormatJsonSchemaJsonSchema.A description of what the response format is for, used by the model to determine how to respond in the format.getName()The name of the response format.The schema for the response format, described as a JSON Schema object.inthashCode()isStrict()Whether to enable strict schema adherence when generating the output.Set the name of thisResponseFormatJsonSchemaJsonSchemainstance and return the same instance.putschemaItem(String key, Object schemaItem) Put one schema instance to thisResponseFormatJsonSchemaJsonSchemainstance.Set the schema of thisResponseFormatJsonSchemaJsonSchemainstance and return the same instance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisResponseFormatJsonSchemaJsonSchemainstance.voidsetDescription(String description) Set the description of thisResponseFormatJsonSchemaJsonSchemainstance.voidSet the name of thisResponseFormatJsonSchemaJsonSchemainstance.voidSet the schema of thisResponseFormatJsonSchemaJsonSchemainstance.voidSet the strict of thisResponseFormatJsonSchemaJsonSchemainstance.Set the strict of thisResponseFormatJsonSchemaJsonSchemainstance and return the same instance.toMap()Get the value of all properties of thisResponseFormatJsonSchemaJsonSchemainstance including unrecognized properties.toString()
-
Constructor Details
-
ResponseFormatJsonSchemaJsonSchema
protected ResponseFormatJsonSchemaJsonSchema()Default constructor for ResponseFormatJsonSchemaJsonSchema.
-
-
Method Details
-
description
Set the description of thisResponseFormatJsonSchemaJsonSchemainstance 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
ResponseFormatJsonSchemaJsonSchemaclass
-
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
ResponseFormatJsonSchemaJsonSchemainstance.
-
setDescription
Set the description of thisResponseFormatJsonSchemaJsonSchemainstance.- Parameters:
description- A description of what the response format is for, used by the model to determine how to respond in the format.
-
name
Set the name of thisResponseFormatJsonSchemaJsonSchemainstance 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
ResponseFormatJsonSchemaJsonSchemaclass
-
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
ResponseFormatJsonSchemaJsonSchemainstance.
-
setName
Set the name of thisResponseFormatJsonSchemaJsonSchemainstance.- 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
Set the schema of thisResponseFormatJsonSchemaJsonSchemainstance 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
ResponseFormatJsonSchemaJsonSchemaclass
-
putschemaItem
@Nonnull public ResponseFormatJsonSchemaJsonSchema putschemaItem(@Nonnull String key, @Nullable Object schemaItem) Put one schema instance to thisResponseFormatJsonSchemaJsonSchemainstance.- Parameters:
key- The String key of this schema instanceschemaItem- The schema that should be added under the given key- Returns:
- The same instance of type
ResponseFormatJsonSchemaJsonSchema
-
getSchema
The schema for the response format, described as a JSON Schema object.- Returns:
- schema The schema of this
ResponseFormatJsonSchemaJsonSchemainstance.
-
setSchema
Set the schema of thisResponseFormatJsonSchemaJsonSchemainstance.- Parameters:
schema- The schema for the response format, described as a JSON Schema object.
-
strict
Set the strict of thisResponseFormatJsonSchemaJsonSchemainstance 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
ResponseFormatJsonSchemaJsonSchemaclass
-
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
ResponseFormatJsonSchemaJsonSchemainstance.
-
setStrict
Set the strict of thisResponseFormatJsonSchemaJsonSchemainstance.- 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
Get the names of the unrecognizable properties of theResponseFormatJsonSchemaJsonSchema.- 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 thisResponseFormatJsonSchemaJsonSchemainstance.- 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 thisResponseFormatJsonSchemaJsonSchemainstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisResponseFormatJsonSchemaJsonSchemainstance. 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 newResponseFormatJsonSchemaJsonSchemainstance with all required arguments.
-
toMap()instead.