Class ResponseInputItem.ShellCallOutput
-
- All Implemented Interfaces:
public final class ResponseInputItem.ShellCallOutputThe streamed output items emitted by a shell tool call.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseInputItem.ShellCallOutput.BuilderA builder for ShellCallOutput.
public final classResponseInputItem.ShellCallOutput.StatusThe status of the shell call output.
-
Method Summary
Modifier and Type Method Description final StringcallId()The unique ID of the shell tool call generated by the model. final List<ResponseFunctionShellCallOutputContent>output()Captured chunks of stdout and stderr output, along with their associated outcomes. final JsonValue_type()The type of the item. final Optional<String>id()The unique ID of the shell tool call output. final Optional<Long>maxOutputLength()The maximum number of UTF-8 characters captured for this shell call's combined output. final Optional<ResponseInputItem.ShellCallOutput.Status>status()The status of the shell call output. final JsonField<String>_callId()Returns the raw JSON value of callId. final JsonField<List<ResponseFunctionShellCallOutputContent>>_output()Returns the raw JSON value of output. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<Long>_maxOutputLength()Returns the raw JSON value of maxOutputLength. final JsonField<ResponseInputItem.ShellCallOutput.Status>_status()Returns the raw JSON value of status. final Map<String, JsonValue>_additionalProperties()final ResponseInputItem.ShellCallOutput.BuildertoBuilder()final ResponseInputItem.ShellCallOutputvalidate()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.ShellCallOutput.Builderbuilder()Returns a mutable builder for constructing an instance of ShellCallOutput. -
-
Method Detail
-
output
final List<ResponseFunctionShellCallOutputContent> output()
Captured chunks of stdout and stderr output, along with their associated outcomes.
-
_type
final JsonValue _type()
The type of the item. Always
shell_call_output.Expected to always return the following:
JsonValue.from("shell_call_output")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 output. Populated when this item is returned via API.
-
maxOutputLength
final Optional<Long> maxOutputLength()
The maximum number of UTF-8 characters captured for this shell call's combined output.
-
status
final Optional<ResponseInputItem.ShellCallOutput.Status> status()
The status of the shell call output.
-
_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.
-
_output
final JsonField<List<ResponseFunctionShellCallOutputContent>> _output()
Returns the raw JSON value of output.
Unlike output, 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.
-
_maxOutputLength
final JsonField<Long> _maxOutputLength()
Returns the raw JSON value of maxOutputLength.
Unlike maxOutputLength, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<ResponseInputItem.ShellCallOutput.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.ShellCallOutput.Builder toBuilder()
-
validate
final ResponseInputItem.ShellCallOutput 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.ShellCallOutput.Builder builder()
Returns a mutable builder for constructing an instance of ShellCallOutput.
The following fields are required:
.callId() .output()
-
-
-
-