Built In Tools

[SnakeO]

OpenAI Provides 3 built-in tools.

The WebSearchTool lets an agent search the web.
The FileSearchTool allows retrieving information from your OpenAI Vector Stores.
The ComputerTool allows automating computer use tasks.

The following classes will give the agent access to these built-in tools

<?php

namespace Swis\Agents\Tools;

use Swis\Agents\Tool;
use Swis\Agents\Tool\ToolParameter;
use Swis\Agents\Tool\Enum;

/**
 * Built-in tool to signal that OpenAI’s internal web search service is available.
 *
 * When the orchestration system builds the payload for the LLM,
 * this tool will be converted into a function definition with the name
 * "web_search_preview" and the appropriate parameters.
 */
class WebSearchPreviewTool extends Tool
{
    /**
     * A brief description of what this built-in tool does.
     *
     * @var string|null
     */
    protected ?string $toolDescription = 'Access the built-in OpenAI web search service.';

    /**
     * The amount of context to use for the search. Can be "low", "medium", or "high".
     *
     * @var string
     */
    #[ToolParameter(description: 'The amount of context to use for the search.')]
    #[Enum(values: ['low', 'medium', 'high'])]
    public string $search_context_size = 'medium';

    /**
     * Return the exact function name recognized by the orchestration system.
     *
     * @return string
     */
    public function name(): string
    {
        return 'web_search_preview';
    }

    /**
     * This built-in tool does not execute any local logic.
     * Execution is handled internally by OpenAI.
     *
     * @return null
     */
    public function __invoke(): ?string
    {
        return null;
    }
}

<?php

namespace Swis\Agents\Tools;

use Swis\Agents\Tool;
use Swis\Agents\Tool\ToolParameter;
use Swis\Agents\Tool\Required;

/**
 * Built-in tool to retrieve information from your OpenAI Vector Stores.
 *
 * When converted to a function definition, its name will be "file_search" with the specified parameters.
 */
class FileSearchTool extends Tool
{
    /**
     * A brief description of what this tool does.
     *
     * @var string|null
     */
    protected ?string $toolDescription = 'Retrieves information from your OpenAI Vector Stores.';

    /**
     * The IDs of the vector stores to search.
     *
     * @var array
     */
    #[ToolParameter(description: 'The IDs of the vector stores to search.')]
    #[Required]
    public array $vector_store_ids = [];

    /**
     * The maximum number of results to return.
     *
     * @var int|null
     */
    #[ToolParameter(description: 'The maximum number of results to return.')]
    public ?int $max_num_results = null;

    /**
     * Whether to include the search results in the output produced by the LLM.
     *
     * @var bool
     */
    #[ToolParameter(description: 'Whether to include the search results in the output produced by the LLM.')]
    public bool $include_search_results = false;

    /**
     * Ranking options for search.
     *
     * @var array|null
     */
    #[ToolParameter(description: 'Ranking options for search.')]
    public ?array $ranking_options = null;

    /**
     * A filter to apply based on file attributes.
     *
     * @var array|null
     */
    #[ToolParameter(description: 'A filter to apply based on file attributes.')]
    public ?array $filters = null;

    /**
     * Return the function name recognized by the orchestration system.
     *
     * @return string
     */
    public function name(): string
    {
        return 'file_search';
    }

    /**
     * This built-in tool does not execute any local logic.
     * Execution is handled internally by OpenAI.
     *
     * @return null
     */
    public function __invoke(): ?string
    {
        return null;
    }
}

<?php

namespace Swis\Agents\Tools;

use Swis\Agents\Tool;

/**
 * Built-in tool to signal that computer automation tasks can be executed via the internal system.
 *
 * Since the actual computer operations are handled internally, no parameters are exposed.
 */
class ComputerTool extends Tool
{
    /**
     * A brief description of what this tool does.
     *
     * @var string|null
     */
    protected ?string $toolDescription = 'Allows automating computer use tasks using the built-in system.';

    /**
     * The computer implementation is provided internally.
     * Not annotated as a tool parameter, so it won’t be exposed in the LLM function definition.
     *
     * @var mixed
     */
    public $computer;

    /**
     * Return the function name recognized by the orchestration system.
     *
     * @return string
     */
    public function name(): string
    {
        return 'computer_use_preview';
    }

    /**
     * This built-in tool does not execute any local logic.
     * Execution is handled internally by OpenAI.
     *
     * @return null
     */
    public function __invoke(): ?string
    {
        return null;
    }
}

[jormeijer]

Hi @SnakeO,

Great work! This is indeed how we are planning to add support for the build-in tools.

Build-in tools only work with the new Responses API endpoint of OpenAI. The community ad openai-php/client are already working on adding support for the endpoint.

After the release we are going to add support for theses tools.

[jorgecortesdev]

Hi @jormeijer,

First of all, thank you for the awesome work. The Responses API support has already been added, right here:

https://github.com/openai-php/client/releases/tag/v0.13.0

I haven't dug into the code yet to check how difficult it would be to update to the new version of openai-php/client. I just wanted to give you a heads-up. I'll try to check the source and see if I can help.

[jormeijer]

Hi @jorgecortesdev,

Thanks for the heads-up! Actually, i've been working on this feature for a few weeks now. I haven't found the time needed to work on this as i hoped. But, progress is steady!

I think i'll have something up and running next week

[jormeijer]

@jorgecortesdev @SnakeO #25