Class ComputerTool
-
- All Implemented Interfaces:
public final class ComputerTool
A tool that controls a virtual computer. Learn more about the computer tool.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ComputerTool.Builder
A builder for ComputerTool.
public final class
ComputerTool.Environment
The type of computer environment to control.
-
Method Summary
Modifier and Type Method Description final Double
displayHeight()
The height of the computer display. final Double
displayWidth()
The width of the computer display. final ComputerTool.Environment
environment()
The type of computer environment to control. final JsonValue
_type()
The type of the computer use tool. final JsonField<Double>
_displayHeight()
Returns the raw JSON value of displayHeight. final JsonField<Double>
_displayWidth()
Returns the raw JSON value of displayWidth. final JsonField<ComputerTool.Environment>
_environment()
Returns the raw JSON value of environment. final Map<String, JsonValue>
_additionalProperties()
final ComputerTool.Builder
toBuilder()
final ComputerTool
validate()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ComputerTool.Builder
builder()
Returns a mutable builder for constructing an instance of ComputerTool. -
-
Method Detail
-
displayHeight
final Double displayHeight()
The height of the computer display.
-
displayWidth
final Double displayWidth()
The width of the computer display.
-
environment
final ComputerTool.Environment environment()
The type of computer environment to control.
-
_type
final JsonValue _type()
The type of the computer use tool. Always
computer_use_preview
.Expected to always return the following:
JsonValue.from("computer_use_preview")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_displayHeight
final JsonField<Double> _displayHeight()
Returns the raw JSON value of displayHeight.
Unlike displayHeight, this method doesn't throw if the JSON field has an unexpected type.
-
_displayWidth
final JsonField<Double> _displayWidth()
Returns the raw JSON value of displayWidth.
Unlike displayWidth, this method doesn't throw if the JSON field has an unexpected type.
-
_environment
final JsonField<ComputerTool.Environment> _environment()
Returns the raw JSON value of environment.
Unlike environment, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ComputerTool.Builder toBuilder()
-
validate
final ComputerTool validate()
-
builder
final static ComputerTool.Builder builder()
Returns a mutable builder for constructing an instance of ComputerTool.
The following fields are required:
.displayHeight() .displayWidth() .environment()
-
-
-
-