BetaToolChoiceFunction 4.42.0 API

All Implemented Interfaces:
```
public final class BetaToolChoiceFunction

                    
```
Use this option to force the model to call a specific function.

Nested Class Summary

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

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 String`	`name()`	The name of the function to call.
`final JsonValue`	`_type()`	For function calling, the type is always `function`.
`final JsonField<String>`	`_name()`	Returns the raw JSON value of name.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final BetaToolChoiceFunction.Builder`	`toBuilder()`
`final BetaToolChoiceFunction`	`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 BetaToolChoiceFunction.Builder`	`builder()`	Returns a mutable builder for constructing an instance of BetaToolChoiceFunction.

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

- Constructor Detail
- Method Detail
  - name
```
 final String name()
```
    The name of the function to call.
  - _type
```
 final JsonValue _type()
```
    For function calling, the type is always function.
    Expected to always return the following:
    JsonValue.from("function")
    However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
  - _name
```
 final JsonField<String> _name()
```
    Returns the raw JSON value of name.
    Unlike name, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final BetaToolChoiceFunction.Builder toBuilder()
```
  - validate
```
 final BetaToolChoiceFunction 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 BetaToolChoiceFunction.Builder builder()
```
    Returns a mutable builder for constructing an instance of BetaToolChoiceFunction.
    The following fields are required:
    .name()