Class ResponseCustomToolCall
-
- All Implemented Interfaces:
public final class ResponseCustomToolCallA call to a custom tool created by the model.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseCustomToolCall.BuilderA builder for ResponseCustomToolCall.
-
Method Summary
Modifier and Type Method Description final StringcallId()An identifier used to map this custom tool call to a tool call output. final Stringinput()The input for the custom tool call generated by the model. final Stringname()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 Optional<String>namespace()The namespace of the custom tool being called. 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 JsonField<String>_namespace()Returns the raw JSON value of namespace. final Map<String, JsonValue>_additionalProperties()final ResponseCustomToolCall.BuildertoBuilder()final ResponseCustomToolCallvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseCustomToolCall.Builderbuilder()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.
-
_namespace
final JsonField<String> _namespace()
Returns the raw JSON value of namespace.
Unlike namespace, 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()
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 ResponseCustomToolCall.Builder builder()
Returns a mutable builder for constructing an instance of ResponseCustomToolCall.
The following fields are required:
.callId() .input() .name()
-
-
-
-