All Implemented Interfaces:


public final class ChatCompletionTool

A function tool that can be used to generate a response.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`ChatCompletionTool.Visitor`	An interface that defines how to map each variant of ChatCompletionTool to a value of type T.

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
`final Optional<ChatCompletionFunctionTool>`	`function()`	A function tool that can be used to generate a response.
`final Optional<ChatCompletionCustomTool>`	`custom()`	A custom tool that processes input using a specified format.
`final Boolean`	`isFunction()`
`final Boolean`	`isCustom()`
`final ChatCompletionFunctionTool`	`asFunction()`	A function tool that can be used to generate a response.
`final ChatCompletionCustomTool`	`asCustom()`	A custom tool that processes input using a specified format.
`final Optional<JsonValue>`	`_json()`
`final <T extends Any> T`	`accept(ChatCompletionTool.Visitor<T> visitor)`
`final ChatCompletionTool`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ChatCompletionTool`	`ofFunction(ChatCompletionFunctionTool function)`	A function tool that can be used to generate a response.
`final static ChatCompletionTool`	`ofCustom(ChatCompletionCustomTool custom)`	A custom tool that processes input using a specified format.

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

Constructor Detail

Method Detail

function
```
 final Optional<ChatCompletionFunctionTool> function()
```
A function tool that can be used to generate a response.

custom
```
 final Optional<ChatCompletionCustomTool> custom()
```
A custom tool that processes input using a specified format.

isFunction
```
 final Boolean isFunction()
```

isCustom
```
 final Boolean isCustom()
```

asFunction
```
 final ChatCompletionFunctionTool asFunction()
```
A function tool that can be used to generate a response.

asCustom
```
 final ChatCompletionCustomTool asCustom()
```
A custom tool that processes input using a specified format.

_json
```
 final Optional<JsonValue> _json()
```

accept

 final <T extends Any> T accept(ChatCompletionTool.Visitor<T> visitor)

validate
```
 final ChatCompletionTool validate()
```

isValid
```
 final Boolean isValid()
```

equals
```
 Boolean equals(Object other)
```

hashCode
```
 Integer hashCode()
```

toString
```
 String toString()
```

ofFunction

 final static ChatCompletionTool ofFunction(ChatCompletionFunctionTool function)

A function tool that can be used to generate a response.

ofCustom

 final static ChatCompletionTool ofCustom(ChatCompletionCustomTool custom)

A custom tool that processes input using a specified format.

Class ChatCompletionTool

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

function

custom

isFunction

isCustom

asFunction

asCustom

_json

accept

validate

isValid

equals

hashCode

toString

ofFunction

ofCustom