[QUESTION] How to set allowed_domains in web search tool

[webwarrior06]

I am trying to use web search. But I am unable to find a strongly-typed usage of "allowed_domains" property which is available on the API now.

One alternative would be to use BinaryContent for all the request body. But I would like to see a standalone solution to this. And I wonder if it is possible to tweak only relevant tool from a BinaryContent?

This is dynamic representation of the web search tool:
tools=[ { "type": "web_search", "filters": { "allowed_domains": [ "mywebsite.com" ] }, "search_context_size": "medium", "user_location": { "type": "approximate", "city": null, "country": null, "region": null, "timezone": null } } ]

[jsquire]

Hi @webwarrior06. Thanks for reaching out and for your request. The allowed_domains attribute was recently added and does not yet exist in the REST API Spec from which the client is generated. Once an updated spec is available with that parameter, it will be included in the library.

Unfortunately, it is not possible to do partial edits on the tool JSON natively just yet. You could serialize to BinaryData using ModelReaderWriter and manipulate it - but you'd have to parse the data and update it manually and then serialize back to BinaryData. That would look something like:

// Create the tool without the property
var tool = ResponseTool.CreateWebSearchTool(WebSearchUserLocation.CreateApproximateLocation());
var binaryData = ModelReaderWriter.Write(tool, ModelReaderWriterOptions.Json);

// =======================    
// ... Parse and update the raw JSON
// =======================
    
// Write the updated JSON back to the tool.
tool = ModelReaderWriter.Read<ResponseTool>(binaryData, ModelReaderWriterOptions.Json).Dump();

In my opinion, it would be easier to just form the entire web search tool by hand and then use it with the convenience API, which would look something like:

var binaryData = BinaryData.FromObjectAsJson(new
{
    type = "web_search",
    search_context_size = "medium",
    filters = new
    {
        allowed_domains = new string[] { "mywebsite.com" }
    },
    user_location = new
    {
        type = "approximate",
        city = default(string?),
        country = default(string?),
        region = default(string?),
        timezone = default(string?)
    }
});

var client = new OpenAIResponseClient("gpt-5", "<< YOUR API KEY >>");
var tool = ModelReaderWriter.Read<ResponseTool>(binaryData, ModelReaderWriterOptions.Json);

var responseOptions = new ResponseCreationOptions();
responseOptions.Tools.Add(tool);

var result = await client.CreateResponseAsync(
    [ResponseItem.CreateUserMessageItem("Tell me a story about cheese")], 
    responseOptions);

[webwarrior06]

It is working as expected, thanks for the suggestion. I am looking forward to the established solution in place.