FunctionShellTool

All Implemented Interfaces:


public final class FunctionShellTool

A tool that allows the model to execute shell commands.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`FunctionShellTool.Builder`	A builder for FunctionShellTool.
`public final class`	`FunctionShellTool.Environment`

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 JsonValue`	`_type()`	The type of the shell tool.
`final Optional<FunctionShellTool.Environment>`	`environment()`
`final JsonField<FunctionShellTool.Environment>`	`_environment()`	Returns the raw JSON value of environment.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final FunctionShellTool.Builder`	`toBuilder()`
`final FunctionShellTool`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static FunctionShellTool.Builder`	`builder()`	Returns a mutable builder for constructing an instance of FunctionShellTool.

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

- Constructor Detail
- Method Detail
  - _type
```
 final JsonValue _type()
```
    The type of the shell tool. Always shell.
    Expected to always return the following:
    JsonValue.from("shell")
    However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
  - environment
```
 final Optional<FunctionShellTool.Environment> environment()
```
  - _environment
```
 final JsonField<FunctionShellTool.Environment> _environment()
```
    Returns the raw JSON value of environment.
    Unlike environment, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final FunctionShellTool.Builder toBuilder()
```
  - validate
```
 final FunctionShellTool validate()
```
    Validates that the types of all values in this object match their expected types recursively.
    This method is not forwards compatible with new types from the API for existing fields.
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static FunctionShellTool.Builder builder()
```
    Returns a mutable builder for constructing an instance of FunctionShellTool.