XaiResponsesLanguageModel

Namespace: Vercel.AI.Xai

public sealed class XaiResponsesLanguageModel : ILanguageModel

xAI Responses API language model. Generate and stream requests post to /responses. Pass xAI provider-defined tools with JsonElement) and the ids xai.web_search, xai.x_search, xai.code_execution, xai.view_image, xai.view_x_video, xai.image_generation, xai.file_search, and xai.mcp.

Inheritance: object

Implements: ILanguageModel

View source

Constructors

XaiResponsesLanguageModel(XaiProvider, string)

public XaiResponsesLanguageModel(XaiProvider provider, string modelId)

Creates a Responses model for <code class=“paramref”>modelId</code>.

Parameters

Name	Type	Description
provider	XaiProvider
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