PerplexityLanguageModel

Namespace: Vercel.AI.Perplexity

public sealed class PerplexityLanguageModel : ILanguageModel

Perplexity Agent API language model. Generate and stream requests post to /v1/agent. Sonar PDF input, video input, and image or video results have no Agent API equivalent and are not mapped.

Inheritance: object

Implements: ILanguageModel

View source

Constructors

PerplexityLanguageModel(PerplexityProvider, string)

public PerplexityLanguageModel(PerplexityProvider provider, string modelId)

Creates a language model for an Agent API preset or direct model id.

Parameters

Name	Type	Description
provider	PerplexityProvider
modelId	string

View source

Properties

ModelId

public string ModelId { get; }

Model id.

Value: string

View source

Provider

public string Provider { get; }

Provider id, such as openai.

Value: string

View source

SpecificationVersion

public string SpecificationVersion { get; }

Always V4.

Value: string

View source

Methods

DoGenerateAsync(LanguageModelCallOptions, CancellationToken)

public Task<LanguageModelGenerateResult> DoGenerateAsync(LanguageModelCallOptions options, CancellationToken cancellationToken)

Generates a complete result.

Parameters

Name	Type	Description
options	LanguageModelCallOptions
cancellationToken	CancellationToken

Returns: Task<LanguageModelGenerateResult>

View source

DoStreamAsync(LanguageModelCallOptions, CancellationToken)

public Task<LanguageModelStreamResult> DoStreamAsync(LanguageModelCallOptions options, CancellationToken cancellationToken)

Streams partial results. The result carries the stream with the request and response info.

Parameters

Name	Type	Description
options	LanguageModelCallOptions
cancellationToken	CancellationToken

Returns: Task<LanguageModelStreamResult>

View source