Package dev.langchain4j.model.chat.request.json

Class JsonObjectSchema.Builder

java.lang.Object

dev.langchain4j.model.chat.request.json.JsonObjectSchema.Builder

Enclosing class:

JsonObjectSchema

public static class JsonObjectSchema.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
JsonObjectSchema.Builder	addBooleanProperty(String name)	Adds a single boolean property to the properties of this JSON object.
JsonObjectSchema.Builder	addBooleanProperty(String name, String description)	Adds a single boolean property with a description to the properties of this JSON object.
JsonObjectSchema.Builder	addEnumProperty(String name, List<String> enumValues)	Adds a single enum property to the properties of this JSON object.
JsonObjectSchema.Builder	addEnumProperty(String name, List<String> enumValues, String description)	Adds a single enum property with a description to the properties of this JSON object.
JsonObjectSchema.Builder	addIntegerProperty(String name)	Adds a single integer property to the properties of this JSON object.
JsonObjectSchema.Builder	addIntegerProperty(String name, String description)	Adds a single integer property with a description to the properties of this JSON object.
JsonObjectSchema.Builder	additionalProperties(Boolean additionalProperties)
JsonObjectSchema.Builder	addNumberProperty(String name)	Adds a single number property to the properties of this JSON object.
JsonObjectSchema.Builder	addNumberProperty(String name, String description)	Adds a single number property with a description to the properties of this JSON object.
JsonObjectSchema.Builder	addProperties(Map<String,JsonSchemaElement> properties)	Adds all properties in the parameter Map to the properties of this JSON object.
JsonObjectSchema.Builder	addProperty(String name, JsonSchemaElement jsonSchemaElement)	Adds a single property to the properties of this JSON object.
JsonObjectSchema.Builder	addStringProperty(String name)	Adds a single string property to the properties of this JSON object.
JsonObjectSchema.Builder	addStringProperty(String name, String description)	Adds a single string property with a description to the properties of this JSON object.
JsonObjectSchema	build()
JsonObjectSchema.Builder	definitions(Map<String,JsonSchemaElement> definitions)	Used together with JsonReferenceSchema when recursion is required.
JsonObjectSchema.Builder	description(String description)
JsonObjectSchema.Builder	properties(Map<String,JsonSchemaElement> properties)	Deprecated, for removal: This API element is subject to removal in a future version. since it has the misleading side effect of deleting all other properties eventually added so far.
JsonObjectSchema.Builder	required(String... required)
JsonObjectSchema.Builder	required(List<String> required)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

description

public JsonObjectSchema.Builder description(String description)

properties

@Deprecated(forRemoval=true)
public JsonObjectSchema.Builder properties(Map<String,JsonSchemaElement> properties)

Deprecated, for removal: This API element is subject to removal in a future version.

since it has the misleading side effect of deleting all other properties eventually added so far. Use addProperties(Map) instead.

Sets the properties of this JSON object. Please note that required(List) should be set explicitly if you want the properties to be mandatory.

See Also:

• addProperties(Map)
• addProperty(String, JsonSchemaElement)
• addStringProperty(String)
• addStringProperty(String, String)
• addIntegerProperty(String)
• addIntegerProperty(String, String)
• addNumberProperty(String)
• addNumberProperty(String, String)
• addBooleanProperty(String)
• addBooleanProperty(String, String)
• addEnumProperty(String, List)
• addEnumProperty(String, List, String)

addProperties

public JsonObjectSchema.Builder addProperties(Map<String,JsonSchemaElement> properties)

Adds all properties in the parameter Map to the properties of this JSON object. Please note that required(List) should be set explicitly if you want the properties to be mandatory.

See Also:

• addProperty(String, JsonSchemaElement)
• addStringProperty(String)
• addStringProperty(String, String)
• addIntegerProperty(String)
• addIntegerProperty(String, String)
• addNumberProperty(String)
• addNumberProperty(String, String)
• addBooleanProperty(String)
• addBooleanProperty(String, String)
• addEnumProperty(String, List)
• addEnumProperty(String, List, String)

addProperty

public JsonObjectSchema.Builder addProperty(String name,
 JsonSchemaElement jsonSchemaElement)

Adds a single property to the properties of this JSON object. Please note that required(List) should be set explicitly if you want the properties to be mandatory.

See Also:

• addProperties(Map)
• addStringProperty(String)
• addStringProperty(String, String)
• addIntegerProperty(String)
• addIntegerProperty(String, String)
• addNumberProperty(String)
• addNumberProperty(String, String)
• addBooleanProperty(String)
• addBooleanProperty(String, String)
• addEnumProperty(String, List)
• addEnumProperty(String, List, String)

addStringProperty

public JsonObjectSchema.Builder addStringProperty(String name)

Adds a single string property to the properties of this JSON object. Please note that required(List) should be set explicitly if you want the properties to be mandatory.

See Also:

• addStringProperty(String, String)
• addProperty(String, JsonSchemaElement)
• addProperties(Map)

addStringProperty

public JsonObjectSchema.Builder addStringProperty(String name,
 String description)

Adds a single string property with a description to the properties of this JSON object. Please note that required(List) should be set explicitly if you want the properties to be mandatory.

See Also:

• addStringProperty(String)
• addProperty(String, JsonSchemaElement)
• addProperties(Map)

addIntegerProperty

public JsonObjectSchema.Builder addIntegerProperty(String name)

Adds a single integer property to the properties of this JSON object. Please note that required(List) should be set explicitly if you want the properties to be mandatory.

See Also:

• addIntegerProperty(String, String)
• addProperty(String, JsonSchemaElement)
• addProperties(Map)

addIntegerProperty

public JsonObjectSchema.Builder addIntegerProperty(String name,
 String description)

Adds a single integer property with a description to the properties of this JSON object. Please note that required(List) should be set explicitly if you want the properties to be mandatory.

See Also:

• addIntegerProperty(String)
• addProperty(String, JsonSchemaElement)
• addProperties(Map)

addNumberProperty

public JsonObjectSchema.Builder addNumberProperty(String name)

Adds a single number property to the properties of this JSON object. Please note that required(List) should be set explicitly if you want the properties to be mandatory.

See Also:

• addNumberProperty(String, String)
• addProperty(String, JsonSchemaElement)
• addProperties(Map)

addNumberProperty

public JsonObjectSchema.Builder addNumberProperty(String name,
 String description)

Adds a single number property with a description to the properties of this JSON object. Please note that required(List) should be set explicitly if you want the properties to be mandatory.

See Also:

• addNumberProperty(String)
• addProperty(String, JsonSchemaElement)
• addProperties(Map)

addBooleanProperty

public JsonObjectSchema.Builder addBooleanProperty(String name)

Adds a single boolean property to the properties of this JSON object. Please note that required(List) should be set explicitly if you want the properties to be mandatory.

See Also:

• addBooleanProperty(String, String)
• addProperty(String, JsonSchemaElement)
• addProperties(Map)

addBooleanProperty

public JsonObjectSchema.Builder addBooleanProperty(String name,
 String description)

Adds a single boolean property with a description to the properties of this JSON object. Please note that required(List) should be set explicitly if you want the properties to be mandatory.

See Also:

• addBooleanProperty(String)
• addProperty(String, JsonSchemaElement)
• addProperties(Map)

addEnumProperty

public JsonObjectSchema.Builder addEnumProperty(String name,
 List<String> enumValues)

Adds a single enum property to the properties of this JSON object. Please note that required(List) should be set explicitly if you want the properties to be mandatory.

See Also:

• addEnumProperty(String, List, String)
• addProperty(String, JsonSchemaElement)
• addProperties(Map)

addEnumProperty

public JsonObjectSchema.Builder addEnumProperty(String name,
 List<String> enumValues,
 String description)

Adds a single enum property with a description to the properties of this JSON object. Please note that required(List) should be set explicitly if you want the properties to be mandatory.

See Also:

• addEnumProperty(String, List)
• addProperty(String, JsonSchemaElement)
• addProperties(Map)

required

public JsonObjectSchema.Builder required(List<String> required)

required

public JsonObjectSchema.Builder required(String... required)

additionalProperties

public JsonObjectSchema.Builder additionalProperties(Boolean additionalProperties)

definitions

public JsonObjectSchema.Builder definitions(Map<String,JsonSchemaElement> definitions)

Used together with JsonReferenceSchema when recursion is required.

build

public JsonObjectSchema build()