Share via

OpenAIPromptExecutionSettings.WebSearchOptions Property

Definition

Namespace:
Microsoft.SemanticKernel.Connectors.OpenAI
Assembly:
Microsoft.SemanticKernel.Connectors.OpenAI.dll
Package:
Microsoft.SemanticKernel.Connectors.OpenAI v1.45.0

An object to allow models to search the web for the latest information before generating a response.

[System.Text.Json.Serialization.JsonIgnore(Condition=System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull)]
[System.Text.Json.Serialization.JsonPropertyName("web_search_options")]
public object? WebSearchOptions { get; set; }
[<System.Text.Json.Serialization.JsonIgnore(Condition=System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull)>]
[<System.Text.Json.Serialization.JsonPropertyName("web_search_options")>]
member this.WebSearchOptions : obj with get, set
Public Property WebSearchOptions As Object

Property Value

Object
Attributes
JsonIgnoreAttribute JsonPropertyNameAttribute

Remarks

Supported types are:

- OpenAI.Chat.ChatWebSearchOptions object;

- JsonElement, which will be used to automatically deserialize into OpenAI.Chat.ChatWebSearchOptions.

- String, which will be used to automatically deserialize into OpenAI.Chat.ChatWebSearchOptions.

Currently, you need to use one of these models to use web search in Chat Completions:

Applies to