API Reference
Class
ChatGptUsageService
Retrieves ChatGPT usage, rate limits, and credit usage events.
Inheritance
- Object
- ChatGptUsageService
Constructors
public ChatGptUsageService(OpenAINativeOptions options) #Initializes a new usage service using native auth options.
Parameters
- options IntelligenceX.OpenAI.Native.OpenAINativeOptions
- Native options used for authentication and endpoints.
Methods
public async Task<ChatGptAccountAnalytics> GetAccountAnalyticsAsync(CancellationToken cancellationToken = default) #Returns:
Task<ChatGptAccountAnalytics>Retrieves provider account-wide profile, daily analytics and plan history. Endpoint failures are independent and do not imply zero usage.
Parameters
- cancellationToken System.Threading.CancellationToken = default
public Task<IReadOnlyList<ChatGptCreditUsageEvent>> GetCreditUsageEventsAsync(CancellationToken cancellationToken = default) #Returns:
Task<IReadOnlyList<ChatGptCreditUsageEvent>>Retrieves recent credit usage events.
Parameters
- cancellationToken System.Threading.CancellationToken = default
- Cancellation token.
public Task<ChatGptDailyTokenUsageBreakdown> GetDailyTokenUsageBreakdownAsync(CancellationToken cancellationToken = default) #Returns:
Task<ChatGptDailyTokenUsageBreakdown>Retrieves daily token usage breakdown by product surface.
Parameters
- cancellationToken System.Threading.CancellationToken = default
GetReportAsync 2 overloads
public Task<ChatGptUsageReport> GetReportAsync(Boolean includeEvents, CancellationToken cancellationToken = default) #Returns:
Task<ChatGptUsageReport>Retrieves a combined usage report.
Parameters
- includeEvents System.Boolean
- Whether to include credit usage events.
- cancellationToken System.Threading.CancellationToken = default
- Cancellation token.
public async Task<ChatGptUsageReport> GetReportAsync(Boolean includeEvents, Boolean includeDailyBreakdown = false, CancellationToken cancellationToken = default) #Returns:
Task<ChatGptUsageReport>Retrieves a combined usage report.
Parameters
- includeEvents System.Boolean
- Whether to include credit usage events.
- includeDailyBreakdown System.Boolean = false
- Whether to include daily token usage breakdown.
- cancellationToken System.Threading.CancellationToken = default
- Cancellation token.
public Task<ChatGptUsageSnapshot> GetUsageSnapshotAsync(CancellationToken cancellationToken = default) #Returns:
Task<ChatGptUsageSnapshot>Retrieves the current usage snapshot.
Parameters
- cancellationToken System.Threading.CancellationToken = default
- Cancellation token.
public async Task<ChatGptThreadUsage> QueryThreadUsageAsync(IReadOnlyList<ChatGptThreadUsageRequest> threads, CancellationToken cancellationToken = default) #Returns:
Task<ChatGptThreadUsage>Queries provider lifetime consumption for explicit root/descendant groups. Accepts up to 100 roots and 1,000 non-overlapping IDs. This read-only POST does not start a model turn.
Parameters
- threads System.Collections.Generic.IReadOnlyList<IntelligenceX.OpenAI.Usage.ChatGptThreadUsageRequest>
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?