Class ResponseCustomToolCallItem
-
- All Implemented Interfaces:
public final class ResponseCustomToolCallItemA call to a custom tool created by the model.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseCustomToolCallItem.BuilderA builder for ResponseCustomToolCallItem.
public final classResponseCustomToolCallItem.StatusThe status of the item. One of
in_progress,completed, orincomplete. Populated when items are returned via API.
-
Method Summary
Modifier and Type Method Description final ResponseCustomToolCalltoResponseCustomToolCall()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 ResponseCustomToolCallItem.Statusstatus()The status of the item. final Optional<String>createdBy()The identifier of the actor that created the item. 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 JsonField<ResponseCustomToolCallItem.Status>_status()Returns the raw JSON value of status. final JsonField<String>_createdBy()Returns the raw JSON value of createdBy. final Map<String, JsonValue>_additionalProperties()final ResponseCustomToolCallItem.BuildertoBuilder()final ResponseCustomToolCallItemvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseCustomToolCallItem.Builderbuilder()Returns a mutable builder for constructing an instance of ResponseCustomToolCallItem. -
-
Method Detail
-
toResponseCustomToolCall
final ResponseCustomToolCall toResponseCustomToolCall()
-
_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).
-
status
final ResponseCustomToolCallItem.Status status()
The status of the item. One of
in_progress,completed, orincomplete. Populated when items are returned via API.
-
_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.
-
_status
final JsonField<ResponseCustomToolCallItem.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_createdBy
final JsonField<String> _createdBy()
Returns the raw JSON value of createdBy.
Unlike createdBy, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseCustomToolCallItem.Builder toBuilder()
-
validate
final ResponseCustomToolCallItem validate()
-
builder
final static ResponseCustomToolCallItem.Builder builder()
Returns a mutable builder for constructing an instance of ResponseCustomToolCallItem.
The following fields are required:
.callId() .input() .name() .status()
-
-
-
-