Package org.springframework.ai.openai.metadata

Class OpenAiRateLimit

java.lang.Object

org.springframework.ai.openai.metadata.OpenAiRateLimit

All Implemented Interfaces:

RateLimit

public class OpenAiRateLimit
extends Object
implements RateLimit

RateLimit implementation for OpenAI SDK.

Author:

John Blum, Ilayaperumal Gopinathan

See Also:

• Rate limits in headers

Constructor Summary

Constructors

Constructor	Description
OpenAiRateLimit(@Nullable Long requestsLimit, @Nullable Long requestsRemaining, @Nullable Duration requestsReset, @Nullable Long tokensLimit, @Nullable Long tokensRemaining, @Nullable Duration tokensReset)

Method Summary

Modifier and Type	Method	Description
Long	getRequestsLimit()	Returns the maximum number of requests that are permitted before exhausting the rate limit.
Long	getRequestsRemaining()	Returns the remaining number of requests that are permitted before exhausting the rate limit.
Duration	getRequestsReset()	Returns the time until the rate limit (based on requests) resets to its initial state.
Long	getTokensLimit()	Returns the maximum number of tokens that are permitted before exhausting the rate limit.
Long	getTokensRemaining()	Returns the remaining number of tokens that are permitted before exhausting the rate limit.
Duration	getTokensReset()	Returns the time until the rate limit (based on tokens) resets to its initial state.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

OpenAiRateLimit

public OpenAiRateLimit(@Nullable Long requestsLimit,
 @Nullable Long requestsRemaining,
 @Nullable Duration requestsReset,
 @Nullable Long tokensLimit,
 @Nullable Long tokensRemaining,
 @Nullable Duration tokensReset)

Method Details

getRequestsLimit

public Long getRequestsLimit()

Description copied from interface: RateLimit

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

Specified by:

getRequestsLimit in interface RateLimit

Returns:

an Long with the maximum number of requests that are permitted before exhausting the rate limit.

See Also:

• RateLimit.getRequestsRemaining()

getTokensLimit

public Long getTokensLimit()

Description copied from interface: RateLimit

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

Specified by:

getTokensLimit in interface RateLimit

Returns:

an Long with the maximum number of tokens that are permitted before exhausting the rate limit.

See Also:

• RateLimit.getTokensRemaining()

getRequestsRemaining

public Long getRequestsRemaining()

Description copied from interface: RateLimit

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

Specified by:

getRequestsRemaining in interface RateLimit

Returns:

an Long with the remaining number of requests that are permitted before exhausting the rate limit.

See Also:

• RateLimit.getRequestsLimit()

getTokensRemaining

public Long getTokensRemaining()

Description copied from interface: RateLimit

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

Specified by:

getTokensRemaining in interface RateLimit

Returns:

an Long with the remaining number of tokens that are permitted before exhausting the rate limit.

See Also:

• RateLimit.getTokensLimit()

getRequestsReset

public Duration getRequestsReset()

Description copied from interface: RateLimit

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

Specified by:

getRequestsReset in interface RateLimit

Returns:

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

See Also:

• RateLimit.getRequestsLimit()

getTokensReset

public Duration getTokensReset()

Description copied from interface: RateLimit

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

Specified by:

getTokensReset in interface RateLimit

Returns:

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

See Also:

• RateLimit.getTokensLimit()

toString

public String toString()

Overrides:

toString in class Object