Skip to content

[FEATURE REQ] Support .action in web_search_call response item (Response API) #760

@gaspardpetit

Description

@gaspardpetit

Describe the feature or improvement you are requesting

Hello,

The web_search_call response item contains an action field which details, when the status is marked completed the query that was performed and the results that were found by the tool. This information is extremely useful when assessing whether a reference has been invented or retrieved.

The full payload looks like this:

{
    "id": "ws_012fd37678f71cf60168f014348b40819f809e6820d06bd17c",
    "type": "web_search_call",
    "status": "completed",
    "action": {
        "type": "search",
        "query": "why are cats so soft",
        "sources": [
            {
                "type": "url",
                "url": "https://betterwithcats.net/why-are-cats-so-soft/"
            },
            {
                "type": "url",
                "url": "https://vetexplainspets.com/why-are-cats-so-soft/"
            },
            {
                "type": "url",
                "url": "https://groofypet.com/why-are-cats-so-soft/"
            }
       ]
    }
}

Presently, the action attributes is inserted into the additionalBinaryDataProperties - so there is a workaround, but relying on it means that when this feature is supported, it will silently break our code. Please consider extracting the action property.

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: responsesThis item is related to Responsesblocked: specThis issue is blocked on a needed REST API spec update.feature-requestCategory: A new feature or enhancement to an existing feature is being requested.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions