Class BaseResponse

Namespace

OpenAI

Assembly

OpenAI-DotNet.dll

public abstract class BaseResponse

Inheritance

object

BaseResponse

Derived

AssistantResponse

AudioResponse

BatchResponse

ChatResponse

EmbeddingsResponse

Error

EventResponse

FileResponse

FineTuneJobResponse

ListResponse<TObject>

ModerationsResponse

MessageResponse

RunResponse

RunStepResponse

ThreadResponse

VectorStoreFileBatchResponse

VectorStoreFileResponse

VectorStoreResponse

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Client

The OpenAIClient this response was generated from.

[JsonIgnore]
public OpenAIClient Client { get; }

Property Value

OpenAIClient

LimitRequests

The maximum number of requests that are permitted before exhausting the rate limit.

[JsonIgnore]
public int? LimitRequests { get; }

Property Value

int?

LimitTokens

The maximum number of tokens that are permitted before exhausting the rate limit.

[JsonIgnore]
public int? LimitTokens { get; }

Property Value

int?

OpenAIVersion

The version of the API used to generate this response, as reported in the response headers.

[JsonIgnore]
public string OpenAIVersion { get; }

Property Value

string

Organization

The organization associated with the API request, as reported by the API.

[JsonIgnore]
public string Organization { get; }

Property Value

string

ProcessingTime

The server-side processing time as reported by the API. This can be useful for debugging where a delay occurs.

[JsonIgnore]
public TimeSpan ProcessingTime { get; }

Property Value

TimeSpan

RemainingRequests

The remaining number of requests that are permitted before exhausting the rate limit.

[JsonIgnore]
public int? RemainingRequests { get; }

Property Value

int?

RemainingTokens

The remaining number of tokens that are permitted before exhausting the rate limit.

[JsonIgnore]
public int? RemainingTokens { get; }

Property Value

int?

RequestId

The request id of this API call, as reported in the response headers. This may be useful for troubleshooting or when contacting OpenAI support in reference to a specific request.

[JsonIgnore]
public string RequestId { get; }

Property Value

string

ResetRequests

The time until the rate limit (based on requests) resets to its initial state.

[JsonIgnore]
public string ResetRequests { get; }

Property Value

string

ResetRequestsTimespan

The time until the rate limit (based on requests) resets to its initial state represented as a TimeSpan.

[JsonIgnore]
public TimeSpan ResetRequestsTimespan { get; }

Property Value

TimeSpan

ResetTokens

The time until the rate limit (based on tokens) resets to its initial state.

[JsonIgnore]
public string ResetTokens { get; }

Property Value

string

ResetTokensTimespan

The time until the rate limit (based on tokens) resets to its initial state represented as a TimeSpan.

[JsonIgnore]
public TimeSpan ResetTokensTimespan { get; }

Property Value

TimeSpan

Methods

ToJsonString()

public string ToJsonString()

Returns

string