computerUseTool method

OpenAIBuilder computerUseTool({
  1. required int displayWidth,
  2. required int displayHeight,
  3. required String environment,
  4. Map<String, dynamic>? parameters,
})

Adds computer use built-in tool

Enables the model to interact with computers through mouse and keyboard actions. Currently in research preview with limited availability.

Example:

final provider = await ai()
    .openai((openai) => openai
        .useResponsesAPI()
        .computerUseTool(
          displayWidth: 1024,
          displayHeight: 768,
          environment: 'browser',
        ))
    .build();

Implementation

OpenAIBuilder computerUseTool({
  required int displayWidth,
  required int displayHeight,
  required String environment,
  Map<String, dynamic>? parameters,
}) {
  final tools = _getBuiltInTools();
  tools.add(OpenAIBuiltInTools.computerUse(
    displayWidth: displayWidth,
    displayHeight: displayHeight,
    environment: environment,
    parameters: parameters,
  ));
  _baseBuilder.extension('builtInTools', tools);
  return this;
}