Class RequiredActionFunctionToolCall
-
- All Implemented Interfaces:
public final class RequiredActionFunctionToolCallTool call objects
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRequiredActionFunctionToolCall.BuilderA builder for RequiredActionFunctionToolCall.
public final classRequiredActionFunctionToolCall.FunctionThe function definition.
-
Method Summary
Modifier and Type Method Description final Stringid()The ID of the tool call. final RequiredActionFunctionToolCall.Functionfunction()The function definition. final JsonValue_type()The type of tool call the output is required for. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<RequiredActionFunctionToolCall.Function>_function()Returns the raw JSON value of function. final Map<String, JsonValue>_additionalProperties()final RequiredActionFunctionToolCall.BuildertoBuilder()final RequiredActionFunctionToolCallvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static RequiredActionFunctionToolCall.Builderbuilder()Returns a mutable builder for constructing an instance of RequiredActionFunctionToolCall. -
-
Method Detail
-
id
final String id()
The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the Submit tool outputs to run endpoint.
-
function
final RequiredActionFunctionToolCall.Function function()
The function definition.
-
_type
final JsonValue _type()
The type of tool call the output is required for. For now, this 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).
-
_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<RequiredActionFunctionToolCall.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 RequiredActionFunctionToolCall.Builder toBuilder()
-
validate
final RequiredActionFunctionToolCall validate()
-
builder
final static RequiredActionFunctionToolCall.Builder builder()
Returns a mutable builder for constructing an instance of RequiredActionFunctionToolCall.
The following fields are required:
.id() .function()
-
-
-
-