Class ResponseFunctionShellToolCall
-
- All Implemented Interfaces:
public final class ResponseFunctionShellToolCallA tool call that executes one or more shell commands in a managed environment.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseFunctionShellToolCall.BuilderA builder for ResponseFunctionShellToolCall.
public final classResponseFunctionShellToolCall.ActionThe shell commands and limits that describe how to run the tool call.
public final classResponseFunctionShellToolCall.StatusThe status of the shell call. One of
in_progress,completed, orincomplete.
-
Method Summary
Modifier and Type Method Description final Stringid()The unique ID of the function shell tool call. final ResponseFunctionShellToolCall.Actionaction()The shell commands and limits that describe how to run the tool call. final StringcallId()The unique ID of the function shell tool call generated by the model. final ResponseFunctionShellToolCall.Statusstatus()The status of the shell call. final JsonValue_type()The type of the item. final Optional<String>createdBy()The ID of the entity that created this tool call. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<ResponseFunctionShellToolCall.Action>_action()Returns the raw JSON value of action. final JsonField<String>_callId()Returns the raw JSON value of callId. final JsonField<ResponseFunctionShellToolCall.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 ResponseFunctionShellToolCall.BuildertoBuilder()final ResponseFunctionShellToolCallvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseFunctionShellToolCall.Builderbuilder()Returns a mutable builder for constructing an instance of ResponseFunctionShellToolCall. -
-
Method Detail
-
id
final String id()
The unique ID of the function shell tool call. Populated when this item is returned via API.
-
action
final ResponseFunctionShellToolCall.Action action()
The shell commands and limits that describe how to run the tool call.
-
status
final ResponseFunctionShellToolCall.Status status()
The status of the shell call. One of
in_progress,completed, orincomplete.
-
_type
final JsonValue _type()
The type of the item. Always
shell_call.Expected to always return the following:
JsonValue.from("shell_call")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.
-
_action
final JsonField<ResponseFunctionShellToolCall.Action> _action()
Returns the raw JSON value of action.
Unlike action, this method doesn't throw if the JSON field has an unexpected type.
-
_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.
-
_status
final JsonField<ResponseFunctionShellToolCall.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 ResponseFunctionShellToolCall.Builder toBuilder()
-
validate
final ResponseFunctionShellToolCall validate()
-
builder
final static ResponseFunctionShellToolCall.Builder builder()
Returns a mutable builder for constructing an instance of ResponseFunctionShellToolCall.
The following fields are required:
.id() .action() .callId() .status()
-
-
-
-