OpenAIChatPromptMessage

Namespace: Vercel.AI.OpenAI

public sealed class OpenAIChatPromptMessage

One prompt message converted into an OpenAI chat message.

Inheritance: object

View source

Constructors

OpenAIChatPromptMessage(string)

public OpenAIChatPromptMessage(string role)

Creates a message.

Parameters

Name	Type	Description
role	string

View source

Properties

Parts

public IReadOnlyList<OpenAIChatPromptPart>? Parts { get; set; }

User or assistant parts.

Value: IReadOnlyList<OpenAIChatPromptPart>

View source

ProviderOptions

public JsonElement? ProviderOptions { get; set; }

Provider options for this message. The openai object is read.

Value: JsonElement?

View source

Role

public string Role { get; }

system, user, assistant, or tool.

Value: string

View source

Text

public string? Text { get; set; }

System text, or assistant text when there are no parts.

Value: string

View source

ToolCallId

public string? ToolCallId { get; set; }

Tool result id.

Value: string

View source

ToolCalls

public IReadOnlyList<GeneratedToolCall>? ToolCalls { get; set; }

Assistant tool calls.

Value: IReadOnlyList<GeneratedToolCall>

View source

ToolOutput

public string? ToolOutput { get; set; }

Tool result text.

Value: string

View source

ToolOutputType

public string? ToolOutputType { get; set; }

Tool result type: text, json, error-text, error-json, or execution-denied. Error types are sent as {"error": value}. When it is null, ToolOutput is sent as is.

Value: string

View source