Package dev.langchain4j.agent.tool

Class ToolParameters.Builder

java.lang.Object

dev.langchain4j.agent.tool.ToolParameters.Builder

Enclosing class:

ToolParameters

public static final class ToolParameters.Builder
extends Object

ToolParameters builder static inner class.

Method Summary

Modifier and Type	Method	Description
ToolParameters	build()	Deprecated, for removal: This API element is subject to removal in a future version. please use JsonObjectSchema.Builder.build() instead
ToolParameters.Builder	properties(Map<String,Map<String,Object>> properties)	Deprecated, for removal: This API element is subject to removal in a future version. please use JsonObjectSchema.Builder.properties(Map) instead
ToolParameters.Builder	required(List<String> required)	Deprecated, for removal: This API element is subject to removal in a future version. please use JsonObjectSchema.Builder.required(List) instead
ToolParameters.Builder	type(String type)	Deprecated, for removal: This API element is subject to removal in a future version. please use JsonObjectSchema.builder() instead

Methods inherited from class java.lang.Object

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

Method Details

type

@Deprecated(forRemoval=true)
public ToolParameters.Builder type(String type)

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

please use JsonObjectSchema.builder() instead

Sets the type.

Parameters:

type - the type

Returns:

the Builder.

properties

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

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

please use JsonObjectSchema.Builder.properties(Map) instead

Sets the properties.

Parameters:

properties - the properties

Returns:

the Builder.

required

@Deprecated(forRemoval=true)
public ToolParameters.Builder required(List<String> required)

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

please use JsonObjectSchema.Builder.required(List) instead

Sets the required.

Parameters:

required - the required

Returns:

the Builder.

build

@Deprecated(forRemoval=true)
public ToolParameters build()

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

please use JsonObjectSchema.Builder.build() instead

Returns a ToolParameters built from the parameters previously set.

Returns:

a ToolParameters built with parameters of this ToolParameters.Builder