dev.langchain4j.agent.tool

Class JsonSchemaProperty

java.lang.Object

dev.langchain4j.agent.tool.JsonSchemaProperty

public class JsonSchemaProperty
extends Object

Represents a property in a JSON schema.

Field Summary

Fields

Modifier and Type	Field and Description
static JsonSchemaProperty	ARRAY A property with key "type" and value "array".
static JsonSchemaProperty	BOOLEAN A property with key "type" and value "boolean".
static JsonSchemaProperty	INTEGER A property with key "type" and value "integer".
static JsonSchemaProperty	NULL A property with key "type" and value "null".
static JsonSchemaProperty	NUMBER A property with key "type" and value "number".
static JsonSchemaProperty	OBJECT A property with key "type" and value "object".
static JsonSchemaProperty	STRING A property with key "type" and value "string".

Constructor Summary

Constructors

Constructor and Description
JsonSchemaProperty(String key, Object value) Construct a property with key and value.

Method Summary

Modifier and Type	Method and Description
static JsonSchemaProperty	description(String value) Construct a property with key "description" and value.
static JsonSchemaProperty	enums(Class<?> enumClass) Construct a property with key "enum" and values taken from enumClass.
static JsonSchemaProperty	enums(Object... enumValues) Construct a property with key "enum" and value enumValues.
static JsonSchemaProperty	enums(String... enumValues) Construct a property with key "enum" and value enumValues.
boolean	equals(Object another)
static JsonSchemaProperty	from(String key, Object value) Construct a property with key and value.
int	hashCode()
static JsonSchemaProperty	items(JsonSchemaProperty type) Wraps the given type in a property with key "items".
String	key() Get the key.
static JsonSchemaProperty	property(String key, Object value) Construct a property with key and value.
String	toString()
static JsonSchemaProperty	type(String value) Construct a property with key "type" and value.
Object	value() Get the value.

Methods inherited from class java.lang.Object

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

Field Detail

STRING

public static final JsonSchemaProperty STRING

A property with key "type" and value "string".

INTEGER

public static final JsonSchemaProperty INTEGER

A property with key "type" and value "integer".

NUMBER

public static final JsonSchemaProperty NUMBER

A property with key "type" and value "number".

OBJECT

public static final JsonSchemaProperty OBJECT

A property with key "type" and value "object".

ARRAY

public static final JsonSchemaProperty ARRAY

A property with key "type" and value "array".

BOOLEAN

public static final JsonSchemaProperty BOOLEAN

A property with key "type" and value "boolean".

NULL

public static final JsonSchemaProperty NULL

A property with key "type" and value "null".

Constructor Detail

JsonSchemaProperty

public JsonSchemaProperty(String key,
                          Object value)

Construct a property with key and value.

Parameters:

key - the key.

value - the value.

Method Detail

key

public String key()

Get the key.

Returns:

the key.

value

public Object value()

Get the value.

Returns:

the value.

equals

public boolean equals(Object another)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

from

public static JsonSchemaProperty from(String key,
                                      Object value)

Construct a property with key and value.

Equivalent to new JsonSchemaProperty(key, value).

Parameters:

key - the key.

value - the value.

Returns:

a property with key and value.

property

public static JsonSchemaProperty property(String key,
                                          Object value)

Construct a property with key and value.

Equivalent to new JsonSchemaProperty(key, value).

Parameters:

key - the key.

value - the value.

Returns:

a property with key and value.

type

public static JsonSchemaProperty type(String value)

Construct a property with key "type" and value.

Equivalent to new JsonSchemaProperty("type", value).

Parameters:

value - the value.

Returns:

a property with key and value.

description

public static JsonSchemaProperty description(String value)

Construct a property with key "description" and value.

Equivalent to new JsonSchemaProperty("description", value).

Parameters:

value - the value.

Returns:

a property with key and value.

enums

public static JsonSchemaProperty enums(String... enumValues)

Construct a property with key "enum" and value enumValues.

Parameters:

enumValues - enum values

Returns:

a property with key "enum" and value enumValues

enums

public static JsonSchemaProperty enums(Object... enumValues)

Construct a property with key "enum" and value enumValues.

Verifies that each value is a java class.

Parameters:

enumValues - enum values

Returns:

a property with key "enum" and value enumValues

enums

public static JsonSchemaProperty enums(Class<?> enumClass)

Construct a property with key "enum" and values taken from enumClass.

Parameters:

enumClass - enum class

Returns:

a property with key "enum" and values taken from enumClass

items

public static JsonSchemaProperty items(JsonSchemaProperty type)

Wraps the given type in a property with key "items".

Parameters:

type - the type

Returns:

a property with key "items" and value type.