Support for OpenAI tools parameter (e.g. web_search_preview) with GPT-4o

[hellodit]

Hi PrismPHP team 👋

First of all, thank you for this great library — it really simplifies working with the OpenAI API in PHP!

I’m currently trying to use tool feature web_search_preview introduced by OpenAI for the gpt-4o model, as described in the official documentation:
🔗 https://platform.openai.com/docs/guides/tools-web-search

However, I couldn’t find a way to include the web_search_preview tools.
Is this something that’s currently supported, or do I need to override part of the library?

Thanks in advance for any guidance! I’m happy to test or contribute if needed 🙌

[ChrisB-TL]

This isn't currently possible with Prism - but shouldn't be too far away.

Once the Responses API PR has been merged (#256) and provider tool use has been added (#365 - which I think I saw @sixlive is working on), this should be possible.

[hellodit]

This is fantastic to hear. I've been eagerly waiting for the Responses API (#256) and provider tool use (#365) to be merged.

As a temporary solution, I'm planning to implement a new tool that simply wraps an HTTP call to the OpenAI web search endpoint. I'm happy to share the approach here if anyone else is looking for a short-term fix.

Big thanks to @sixlive and the team for working on this. Can't wait!

[ChrisB-TL]

Responses API PR has been merged.

I've just submitted #405 for review, which adds provider tools.

Once that is merged, you'll be able to do the following:

use Prism\Prism\Prism;
use Prism\Prism\ValueObjects\ProviderTool;

Prism::text()
    ->using('openai', 'gpt-4.1')
    ->withPrompt('Solve the equation 3x + 10 = 14.')
    ->withProviderTools([new ProviderTool(type: 'web_search_preview')])
    ->asText();

Or with options:

use Prism\Prism\Prism;
use Prism\Prism\ValueObjects\ProviderTool;

Prism::text()
    ->using('openai', 'gpt-4.1')
    ->withPrompt('Solve the equation 3x + 10 = 14.')
    ->withProviderTools([
        new ProviderTool(type: 'web_search_preview', options: [
            'user_location' => [
                'type' => 'approximate',
                'country' => 'GB',
                'city' => 'London',
                'region' => 'London',
            ]
        ])
    ])
    ->asText();

[hellodit]

Finnaly it's marged!!

[aleex1848]

Thank your for this awesome stuff!
OpenAI web_search_preview is working well, but i don't get file_search to work.

I'm doing like this

->withProviderTools([
                new ProviderTool(type: 'file_search', options: ['vector_store_ids' => ["vs_myFancyVectorstoreId"]]),
                new ProviderTool(type: 'web_search_preview'),
                ])

but the tool file_search is not available, when i ask for that the anwer is always something like "I currently do not have access to the “file_search” tool in this environment. I can assist with other tasks or searches, such as web searches using “web_search_preview.” If you need help with something specific, please let me know!"

Is it supposed to work like this, or am i doing something wrong?

[ChrisB-TL]

It does look like this is mapping across correctly from Prism, so I suspect its an OpenAI issue. Perhaps not supported by the model you are using?