OpenAIWebSearchAction

@Serializable
sealed interface OpenAIWebSearchAction

An object describing the specific action taken in a web search call.

Includes details on how the model used the web: performed a search (Search), opened a page (OpenPage) or searched for a pattern within a loaded page (FindInPage).

Discriminated by the type property.

See also

Inheritors

Types

Link copied to clipboard
@Serializable
@SerialName(value = "find_in_page")
data class FindInPage(val url: String? = null, val pattern: String? = null) : OpenAIWebSearchAction

Searches for a pattern within a loaded page.

Link copied to clipboard
@Serializable
@SerialName(value = "open_page")
data class OpenPage(val url: String? = null) : OpenAIWebSearchAction

Opens a specific URL from search results.

Link copied to clipboard
@Serializable
@SerialName(value = "search")
data class Search(val query: String? = null, val queries: List<String> = emptyList(), val sources: List<OpenAIWebSearchSource> = emptyList()) : OpenAIWebSearchAction

Performs a web search query.