Class ResponseInputItem.ShellCall
-
- All Implemented Interfaces:
public final class ResponseInputItem.ShellCallA tool representing a request to execute one or more shell commands.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseInputItem.ShellCall.BuilderA builder for ShellCall.
public final classResponseInputItem.ShellCall.ActionThe shell commands and limits that describe how to run the tool call.
public final classResponseInputItem.ShellCall.EnvironmentThe environment to execute the shell commands in.
public final classResponseInputItem.ShellCall.StatusThe status of the shell call. One of
in_progress,completed, orincomplete.
-
Method Summary
Modifier and Type Method Description final ResponseInputItem.ShellCall.Actionaction()The shell commands and limits that describe how to run the tool call. final StringcallId()The unique ID of the shell tool call generated by the model. final JsonValue_type()The type of the item. final Optional<String>id()The unique ID of the shell tool call. final Optional<ResponseInputItem.ShellCall.Environment>environment()The environment to execute the shell commands in. final Optional<ResponseInputItem.ShellCall.Status>status()The status of the shell call. final JsonField<ResponseInputItem.ShellCall.Action>_action()Returns the raw JSON value of action. final JsonField<String>_callId()Returns the raw JSON value of callId. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<ResponseInputItem.ShellCall.Environment>_environment()Returns the raw JSON value of environment. final JsonField<ResponseInputItem.ShellCall.Status>_status()Returns the raw JSON value of status. final Map<String, JsonValue>_additionalProperties()final ResponseInputItem.ShellCall.BuildertoBuilder()final ResponseInputItem.ShellCallvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseInputItem.ShellCall.Builderbuilder()Returns a mutable builder for constructing an instance of ShellCall. -
-
Method Detail
-
action
final ResponseInputItem.ShellCall.Action action()
The shell commands and limits that describe how to run the tool call.
-
_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 Optional<String> id()
The unique ID of the shell tool call. Populated when this item is returned via API.
-
environment
final Optional<ResponseInputItem.ShellCall.Environment> environment()
The environment to execute the shell commands in.
-
status
final Optional<ResponseInputItem.ShellCall.Status> status()
The status of the shell call. One of
in_progress,completed, orincomplete.
-
_action
final JsonField<ResponseInputItem.ShellCall.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.
-
_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.
-
_environment
final JsonField<ResponseInputItem.ShellCall.Environment> _environment()
Returns the raw JSON value of environment.
Unlike environment, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<ResponseInputItem.ShellCall.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseInputItem.ShellCall.Builder toBuilder()
-
validate
final ResponseInputItem.ShellCall 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 ResponseInputItem.ShellCall.Builder builder()
Returns a mutable builder for constructing an instance of ShellCall.
The following fields are required:
.action() .callId()
-
-
-
-