Table of Contents

Class PerplexityWebSearch

Search the Internet for sources related to the prompt.

public class PerplexityWebSearch : Tool
Inheritance
object
PerplexityWebSearch

Properties

EnableSearchClassifier

Optional. Enables a classifier that decides if web search is needed based on your query.

public bool? EnableSearchClassifier { get; set; }

Property Value

bool?

LastUpdatedAfterFilter

Optional. Filters search results to only include content last updated after this date. Format should be %m/%d/%Y (e.g. 3/1/2025)

public UnixTime? LastUpdatedAfterFilter { get; set; }

Property Value

UnixTime?

LastUpdatedBeforeFilter

Optional. Filters search results to only include content last updated before this date. Format should be %m/%d/%Y (e.g. 3/1/2025)

public UnixTime? LastUpdatedBeforeFilter { get; set; }

Property Value

UnixTime?

ReturnImages

Optional. Determines whether search results should include images.

public bool? ReturnImages { get; set; }

Property Value

bool?

ReturnRelatedQuestions

Optional. Determines whether related questions should be returned.

public bool? ReturnRelatedQuestions { get; set; }

Property Value

bool?

SearchAfterDateFilter

Optional. Filters search results to only include content published after this date. Format should be %m/%d/%Y (e.g. 3/1/2025)

public UnixTime? SearchAfterDateFilter { get; set; }

Property Value

UnixTime?

SearchBeforeDateFilter

Optional. Filters search results to only include content published before this date. Format should be %m/%d/%Y (e.g. 3/1/2025)

public UnixTime? SearchBeforeDateFilter { get; set; }

Property Value

UnixTime?

SearchDomainFilter

Optional. A list of domains to limit search results to. Currently limited to 10 domains for Allowlisting and Denylisting. For Denylisting, add a - at the beginning of the domain string.

public DomainFilter SearchDomainFilter { get; set; }

Property Value

DomainFilter

SearchMode

Optional. Controls the search mode used for the request. When set to 'academic', results will prioritize scholarly sources like peer-reviewed papers and academic journals.

public PerplexityTypes.WebSearchMode? SearchMode { get; set; }

Property Value

PerplexityTypes.WebSearchMode?

SearchRecencyFilter

Optional. Filters search results based on time (e.g., 'week', 'day').

public string SearchRecencyFilter { get; set; }

Property Value

string

Type

Required. The type of the tool. Examples: Tool.Function, Tool.FileSearch, Tool.ComputerUsePreview, Tool.WebSearch

public override ToolType Type { get; }

Property Value

ToolType

WebSearchOptions

Optional. Configuration for using web search in model responses.

public PerplexityWebSearchOptions WebSearchOptions { get; set; }

Property Value

PerplexityWebSearchOptions