store

Documentation

Index

• type ModelUsageSummary
  • func ListModelUsageSummaries(s *store.Store, tenantID string, startTime, endTime time.Time, ...) ([]*ModelUsageSummary, error)
• type Summary
  • func AggregatedUsage(s *store.Store, tenantID string, start, end int64) ([]Summary, error)
• type UsageByGroup
  • func GetUsagesByGroups(s *store.Store, tenantID string, start, end int64) ([]*UsageByGroup, error)

Types

type ModelUsageSummary

type ModelUsageSummary struct {
	UserID  string
	ModelID string

	TruncatedTimestamp int64

	TotalRequests         int64
	TotalPromptTokens     int64
	TotalCompletionTokens int64
}

ModelUsageSummary is a struct that represents the usage summary for a specific model, user and truncated timestamp.

func ListModelUsageSummaries

func ListModelUsageSummaries(
	s *store.Store,
	tenantID string,
	startTime,
	endTime time.Time,
	interval time.Duration,
) ([]*ModelUsageSummary, error)

ListModelUsageSummaries returns the usage summaries for models grouped by user and truncated by the specified interval.

type Summary

type Summary struct {
	APIMethod       string
	TotalRequests   int64
	SuccessRequests int64
	FailureRequests int64
	AverageLatency  float64
}

Summary is a struct that represents the summary of the usage data.

func AggregatedUsage

func AggregatedUsage(s *store.Store, tenantID string, start, end int64) ([]Summary, error)

AggregatedUsage returns the aggregated usage data for the given tenant and time range.

type UsageByGroup

type UsageByGroup struct {
	APIKeyID string
	UserID   string
	ModelID  string

	TotalRequests           int64
	TotalPromptTokens       int64
	TotalCompletionTokens   int64
	AverageLatency          float64
	AverageTimeToFirstToken float64
}

UsageByGroup represents the aggregated usage data grouped by API key, user, and model.

func GetUsagesByGroups

func GetUsagesByGroups(s *store.Store, tenantID string, start, end int64) ([]*UsageByGroup, error)

GetUsagesByGroups returns the aggregated usage data by groups for the given tenant and time range.