Skip to content

OpenAICallWarning

Namespace: Vercel.AI.OpenAI

public sealed class OpenAICallWarning

A warning produced while preparing an OpenAI request.

Inheritance: object

View source

OpenAICallWarning(string, string?, string?, string?)

Section titled “OpenAICallWarning(string, string?, string?, string?)”
public OpenAICallWarning(string type, string? feature, string? details, string? message = null)

Creates a warning. <code class=“paramref”>details</code> or <code class=“paramref”>message</code> is the text callers read.

Parameters

Name Type Description
type string
feature string
details string
message string

View source

public string? Details { get; }

Why the request was changed.

Value: string

View source

public string? Feature { get; }

Feature the warning refers to.

Value: string

View source

public string? Message { get; }

Free-form message used by other warnings.

Value: string

View source

public string Type { get; }

Warning category, such as unsupported or compatibility.

Value: string

View source

public CallWarning ToCallWarning()

The warning text stored on language-model results.

Returns: CallWarning

View source

Apache-2.0 · Copyright 2023 Vercel, Inc. · unofficial community port, not an official Vercel product