All Implemented Interfaces:


public final class ToolSpecification.Builder

ToolSpecification builder static inner class.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`ToolSpecification.Builder`	`name(String name)`	Sets the `name`.
`ToolSpecification.Builder`	`description(String description)`	Sets the `description`.
`ToolSpecification.Builder`	`parameters(JsonObjectSchema parameters)`	Sets the `parameters`.
`ToolSpecification.Builder`	`parameters(ToolParameters parameters)`	Sets the `parameters`.
`ToolSpecification.Builder`	`addParameter(String name, Array<JsonSchemaProperty> jsonSchemaProperties)`	Adds a parameter to the tool.
`ToolSpecification.Builder`	`addParameter(String name, Iterable<JsonSchemaProperty> jsonSchemaProperties)`	Adds a parameter to the tool.
`ToolSpecification.Builder`	`addOptionalParameter(String name, Array<JsonSchemaProperty> jsonSchemaProperties)`	Adds an optional parameter to the tool.
`ToolSpecification.Builder`	`addOptionalParameter(String name, Iterable<JsonSchemaProperty> jsonSchemaProperties)`	Adds an optional parameter to the tool.
`ToolSpecification`	`build()`	Returns a `ToolSpecification` built from the parameters previously set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - name
```
 ToolSpecification.Builder name(String name)
```
    Sets the name.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    this
  - description
```
 ToolSpecification.Builder description(String description)
```
    Sets the description.
    
    Parameters:
    
    description - the description
    
    Returns:
    
    this
  - parameters
```
 ToolSpecification.Builder parameters(JsonObjectSchema parameters)
```
    Sets the parameters.
    
    Parameters:
    
    parameters - the parameters
    
    Returns:
    
    this
  - parameters
```
@Deprecated(forRemoval = true) ToolSpecification.Builder parameters(ToolParameters parameters)
```
    Sets the parameters.
    
    Parameters:
    
    parameters - the parameters
    
    Returns:
    
    this
  - addParameter
```
@Deprecated(forRemoval = true) ToolSpecification.Builder addParameter(String name, Array<JsonSchemaProperty> jsonSchemaProperties)
```
    Adds a parameter to the tool.
    
    Parameters:
    
    name - the name of the parameter.
    
    jsonSchemaProperties - the properties of the parameter.
    
    Returns:
    
    this
  - addParameter
```
@Deprecated(forRemoval = true) ToolSpecification.Builder addParameter(String name, Iterable<JsonSchemaProperty> jsonSchemaProperties)
```
    Adds a parameter to the tool.
    
    Parameters:
    
    name - the name of the parameter.
    
    jsonSchemaProperties - the properties of the parameter.
    
    Returns:
    
    this
  - addOptionalParameter
```
@Deprecated(forRemoval = true) ToolSpecification.Builder addOptionalParameter(String name, Array<JsonSchemaProperty> jsonSchemaProperties)
```
    Adds an optional parameter to the tool.
    
    Parameters:
    
    name - the name of the parameter.
    
    jsonSchemaProperties - the properties of the parameter.
    
    Returns:
    
    this
  - addOptionalParameter
```
@Deprecated(forRemoval = true) ToolSpecification.Builder addOptionalParameter(String name, Iterable<JsonSchemaProperty> jsonSchemaProperties)
```
    Adds an optional parameter to the tool.
    
    Parameters:
    
    name - the name of the parameter.
    
    jsonSchemaProperties - the properties of the parameter.
    
    Returns:
    
    this
  - build
```
 ToolSpecification build()
```
    Returns a ToolSpecification built from the parameters previously set.
    
    Returns:
    
    a ToolSpecification built with parameters of this ToolSpecification.Builder

Class ToolSpecification.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

name

description

parameters

parameters

addParameter

addParameter

addOptionalParameter

addOptionalParameter

build