Class ResponseCustomToolCall
-
- All Implemented Interfaces:
public final class ResponseCustomToolCall
A call to a custom tool created by the model.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseCustomToolCall.Builder
A builder for ResponseCustomToolCall.
-
Method Summary
Modifier and Type Method Description final String
callId()
An identifier used to map this custom tool call to a tool call output. final String
input()
The input for the custom tool call generated by the model. final String
name()
The name of the custom tool being called. final JsonValue
_type()
The type of the custom tool call. final Optional<String>
id()
The unique ID of the custom tool call in the OpenAI platform. final JsonField<String>
_callId()
Returns the raw JSON value of callId. final JsonField<String>
_input()
Returns the raw JSON value of input. final JsonField<String>
_name()
Returns the raw JSON value of name. final JsonField<String>
_id()
Returns the raw JSON value of id. final Map<String, JsonValue>
_additionalProperties()
final ResponseCustomToolCall.Builder
toBuilder()
final ResponseCustomToolCall
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseCustomToolCall.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseCustomToolCall. -
-
Method Detail
-
_type
final JsonValue _type()
The type of the custom tool call. Always
custom_tool_call
.Expected to always return the following:
JsonValue.from("custom_tool_call")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_callId
final JsonField<String> _callId()
Returns the raw JSON value of callId.
Unlike callId, this method doesn't throw if the JSON field has an unexpected type.
-
_input
final JsonField<String> _input()
Returns the raw JSON value of input.
Unlike input, this method doesn't throw if the JSON field has an unexpected type.
-
_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.
-
_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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseCustomToolCall.Builder toBuilder()
-
validate
final ResponseCustomToolCall validate()
-
builder
final static ResponseCustomToolCall.Builder builder()
Returns a mutable builder for constructing an instance of ResponseCustomToolCall.
The following fields are required:
.callId() .input() .name()
-
-
-
-