Interface PerplexityChatInput

Interface defining the parameters for the Perplexity chat model.

interface PerplexityChatInput {
    apiKey?: string;
    cache?: boolean | BaseCache<Generation[]>;
    callbackManager?: CallbackManager;
    callbacks?: Callbacks;
    disableStreaming?: boolean;
    frequencyPenalty?: number;
    maxConcurrency?: number;
    maxRetries?: number;
    maxTokens?: number;
    metadata?: Record<string, unknown>;
    model: string;
    onFailedAttempt?: FailedAttemptHandler;
    presencePenalty?: number;
    returnImages?: boolean;
    returnRelatedQuestions?: boolean;
    searchDomainFilter?: any[];
    searchRecencyFilter?: string;
    streaming?: boolean;
    tags?: string[];
    temperature?: number;
    timeout?: number;
    topK?: number;
    topP?: number;
    verbose?: boolean;
}

Hierarchy

  • BaseChatModelParams
    • PerplexityChatInput

Implemented by

Properties

OptionalapiKey

apiKey?: string

API key for Perplexity. Defaults to the value of PERPLEXITY_API_KEY environment variable.

Optionalcache

cache?: boolean | BaseCache<Generation[]>

OptionalcallbackManager

callbackManager?: CallbackManager

Deprecated

Use callbacks instead

Optionalcallbacks

callbacks?: Callbacks

OptionaldisableStreaming

disableStreaming?: boolean

Whether to disable streaming.

If streaming is bypassed, then stream() will defer to invoke().

  • If true, will always bypass streaming case.
  • If false (default), will always use streaming case if available.

OptionalfrequencyPenalty

frequencyPenalty?: number

Frequency penalty greater than 0

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

OptionalmaxTokens

maxTokens?: number

Maximum number of tokens to generate

Optionalmetadata

metadata?: Record<string, unknown>

model

model: string

Model name to use

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

OptionalpresencePenalty

presencePenalty?: number

Presence penalty between -2 and 2

OptionalreturnImages

returnImages?: boolean

Whether to return images

OptionalreturnRelatedQuestions

returnRelatedQuestions?: boolean

Determines whether or not a request to an online model should return related questions.

OptionalsearchDomainFilter

searchDomainFilter?: any[]

Search domain filter - limit the citations used by the online model to URLs from the specified domains.

OptionalsearchRecencyFilter

searchRecencyFilter?: string

Returns search results within the specified time interval - does not apply to images. Values include month, week, day, hour.

Optionalstreaming

streaming?: boolean

Whether to stream the results or not

Optionaltags

tags?: string[]

Optionaltemperature

temperature?: number

Temperature parameter between 0 and 2

Optionaltimeout

timeout?: number

Timeout for requests to Perplexity

OptionaltopK

topK?: number

Top K parameter between 1 and 2048

OptionaltopP

topP?: number

Top P parameter between 0 and 1

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties
""