Table of Contents

Class Error

Namespace
OpenAI
Assembly
OpenAI-DotNet.dll
public sealed class Error : BaseResponse, IServerSentEvent
Inheritance
Error
Implements
Inherited Members

Constructors

Error() 

public Error()

Properties

Code

An error code identifying the error type.

[JsonInclude]
[JsonPropertyName("code")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string Code { get; }

Property Value

string

Exception 

[JsonIgnore]
public Exception Exception { get; }

Property Value

Exception

Line

The line number of the input file where the error occurred, if applicable.

[JsonInclude]
[JsonPropertyName("line")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? Line { get; }

Property Value

int?

Message

A human-readable message providing more details about the error.

[JsonInclude]
[JsonPropertyName("message")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string Message { get; }

Property Value

string

Object 

[JsonIgnore]
public string Object { get; }

Property Value

string

Parameter

The name of the parameter that caused the error, if applicable.

[JsonInclude]
[JsonPropertyName("param")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string Parameter { get; }

Property Value

string

Type

The type.

[JsonInclude]
[JsonPropertyName("type")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string Type { get; }

Property Value

string

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Operators

implicit operator Exception(Error) 

public static implicit operator Exception(Error error)

Parameters

error Error

Returns

Exception
Edit this page