Class PerplexityRequest
- Namespace
- Glitch9.AIDevKit.Perplexity
public class PerplexityRequest : IJsonRequest- Inheritance
-
objectPerplexityRequest
Properties
DisableSearch
Optional. When set to true, disables web search completely and the model will only use its training data to respond. This is useful when you want deterministic responses without external information.
public bool? DisableSearch { get; set; }Property Value
- bool?
EnableSearchClassifier
Optional. Enables a classifier that decides if web search is needed based on your query.
public bool? EnableSearchClassifier { get; set; }Property Value
- bool?
FrequencyPenalty
Optional. Decreases likelihood of repetition based on prior frequency. Applies a penalty to tokens based on how frequently they've appeared in the text so far. Values typically range from 0 (no penalty) to 2.0 (strong penalty). Higher values (e.g., 1.5) reduce repetition of the same words and phrases. Useful for preventing the model from getting stuck in loops.
public float? FrequencyPenalty { get; set; }Property Value
- float?
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?
MaxTokens
Optional. The maximum number of completion tokens returned by the API. Controls the length of the model's response. If the response would exceed this limit, it will be truncated. Higher values allow for longer responses but may increase processing time and costs.
public int? MaxTokens { get; set; }Property Value
- int?
Messages
Required. A list of messages comprising the conversation so far.
public List<PerplexityMessage> Messages { get; set; }Property Value
- List<PerplexityMessage>
Model
Required. The name of the model that will complete your prompt. Choose from our available Sonar models: sonar (lightweight search), sonar-pro (advanced search), sonar-deep-research (exhaustive research), sonar-reasoning (fast reasoning), or sonar-reasoning-pro (premier reasoning).
public string Model { get; set; }Property Value
- string
PresencePenalty
Optional. Positive values increase the likelihood of discussing new topics. Applies a penalty to tokens that have already appeared in the text, encouraging the model to talk about new concepts. Values typically range from 0 (no penalty) to 2.0 (strong penalty). Higher values reduce repetition but may lead to more off-topic text.
public float? PresencePenalty { get; set; }Property Value
- float?
ReasoningEffort
WARNING: This parameter is ONLY applicable for sonar-deep-research.
Optional. Controls how much computational effort the AI dedicates to each
query for deep research models. 'low' provides faster, simpler answers with reduced token usage,
'medium' offers a balanced approach, and 'high' delivers deeper, more thorough responses
with increased token usage. WARNING: This parameter is ONLY applicable for sonar-deep-research.
Defaults to 'medium' when used with sonar-deep-research.
public ReasoningEffort? ReasoningEffort { get; set; }Property Value
ResponseFormat
Optional. Enables structured JSON output formatting.
public JsonSchema ResponseFormat { get; set; }Property Value
- JsonSchema
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
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
SearchRecencyFilter
Optional. Filters search results based on time (e.g., 'week', 'day').
public string SearchRecencyFilter { get; set; }Property Value
- string
Stream
Optional. Determines whether to stream the response incrementally.
public bool? Stream { get; set; }Property Value
- bool?
Temperature
Optional. The amount of randomness in the response, valued between 0 and 2. Lower values (e.g., 0.1) make the output more focused, deterministic, and less creative. Higher values (e.g., 1.5) make the output more random and creative. Use lower values for factual/information retrieval tasks and higher values for creative applications.
public float? Temperature { get; set; }Property Value
- float?
TopK
Optional. The number of tokens to keep for top-k filtering. Limits the model to consider only the k most likely next tokens at each step. Lower values (e.g., 10) make the output more focused and deterministic, while higher values allow for more diverse outputs. A value of 0 disables this filter. Often used in conjunction with top_p to control output randomness.
public int? TopK { get; set; }Property Value
- int?
TopP
Optional. The nucleus sampling threshold, valued between 0 and 1. Controls the diversity of generated text by considering only the tokens whose cumulative probability exceeds the top_p value. Lower values (e.g., 0.5) make the output more focused and deterministic, while higher values (e.g., 0.95) allow for more diverse outputs. Often used as an alternative to temperature.
public float? TopP { get; set; }Property Value
- float?
WebSearchOptions
Optional. Configuration for using web search in model responses.
public PerplexityWebSearchOptions WebSearchOptions { get; set; }