Class FunctionToolCall
-
- All Implemented Interfaces:
public final class FunctionToolCall
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFunctionToolCall.BuilderA builder for FunctionToolCall.
public final classFunctionToolCall.FunctionThe definition of the function that was called.
-
Method Summary
Modifier and Type Method Description final Stringid()The ID of the tool call object. final FunctionToolCall.Functionfunction()The definition of the function that was called. final JsonValue_type()The type of tool call. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<FunctionToolCall.Function>_function()Returns the raw JSON value of function. final Map<String, JsonValue>_additionalProperties()final FunctionToolCall.BuildertoBuilder()final FunctionToolCallvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FunctionToolCall.Builderbuilder()Returns a mutable builder for constructing an instance of FunctionToolCall. -
-
Method Detail
-
function
final FunctionToolCall.Function function()
The definition of the function that was called.
-
_type
final JsonValue _type()
The type of tool call. This is always going to be
functionfor this type of tool call.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).
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_function
final JsonField<FunctionToolCall.Function> _function()
Returns the raw JSON value of function.
Unlike function, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final FunctionToolCall.Builder toBuilder()
-
validate
final FunctionToolCall 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.
-
builder
final static FunctionToolCall.Builder builder()
Returns a mutable builder for constructing an instance of FunctionToolCall.
The following fields are required:
.id() .function()
-
-
-
-