Class PerplexityWebSearch

Search the Internet for sources related to the prompt.

Inheritance
object
Tool
PerplexityWebSearch
Inherited Members
Namespace: Glitch9.AIDevKit.Perplexity
Assembly: Glitch9.AIDevKit.dll
Syntax
public class PerplexityWebSearch : Tool

Properties

| Edit this page View Source

EnableSearchClassifier

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

Declaration
[JsonProperty("enable_search_classifier")]
public bool? EnableSearchClassifier { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

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)

Declaration
[JsonProperty("last_updated_after_filter")]
public UnixTime? LastUpdatedAfterFilter { get; set; }
Property Value
Type Description
UnixTime?
| Edit this page View Source

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)

Declaration
[JsonProperty("last_updated_before_filter")]
public UnixTime? LastUpdatedBeforeFilter { get; set; }
Property Value
Type Description
UnixTime?
| Edit this page View Source

ReturnImages

Optional. Determines whether search results should include images.

Declaration
[JsonProperty("return_images")]
public bool? ReturnImages { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

ReturnRelatedQuestions

Optional. Determines whether related questions should be returned.

Declaration
[JsonProperty("return_related_questions")]
public bool? ReturnRelatedQuestions { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

SearchAfterDateFilter

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

Declaration
[JsonProperty("search_after_date_filter")]
public UnixTime? SearchAfterDateFilter { get; set; }
Property Value
Type Description
UnixTime?
| Edit this page View Source

SearchBeforeDateFilter

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

Declaration
[JsonProperty("search_before_date_filter")]
public UnixTime? SearchBeforeDateFilter { get; set; }
Property Value
Type Description
UnixTime?
| Edit this page View Source

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.

Declaration
[JsonProperty("search_domain_filter")]
public DomainFilter SearchDomainFilter { get; set; }
Property Value
Type Description
DomainFilter
| Edit this page View Source

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.

Declaration
[JsonProperty("search_mode")]
public PerplexityTypes.WebSearchMode? SearchMode { get; set; }
Property Value
Type Description
PerplexityTypes.WebSearchMode?
| Edit this page View Source

SearchRecencyFilter

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

Declaration
[JsonProperty("search_recency_filter")]
public string SearchRecencyFilter { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Type

Required. The logical type of the tool. The serialized string is resolved by API settings (ApiPolicy.TryGetToolTypeString).

Declaration
[JsonProperty("type")]
public override ToolType Type { get; }
Property Value
Type Description
ToolType
Overrides
| Edit this page View Source

WebSearchOptions

Optional. Configuration for using web search in model responses.

Declaration
[JsonProperty("web_search_options")]
public PerplexityWebSearchOptions WebSearchOptions { get; set; }
Property Value
Type Description
PerplexityWebSearchOptions

Extension Methods