Package com.bytedesk.ai.statistic_token

Class StatisticTokenRestService

java.lang.Object

com.bytedesk.core.base.BaseRestService<T,TRequest,TResponse>

com.bytedesk.core.base.BaseRestServiceWithExport<StatisticTokenEntity,StatisticTokenRequest,StatisticTokenResponse,StatisticTokenExcel>

com.bytedesk.ai.statistic_token.StatisticTokenRestService

@Service
@Description("AI Token Statistics Service - AI token usage statistics and analytics service")
public class StatisticTokenRestService
extends BaseRestServiceWithExport<StatisticTokenEntity,StatisticTokenRequest,StatisticTokenResponse,StatisticTokenExcel>

Field Summary

Fields

Modifier and Type	Field	Description
private static final DateTimeFormatter	DATE_FORMATTER
private final org.modelmapper.ModelMapper	modelMapper
private final StatisticTokenRepository	statistic_tokenRepository
private final UidUtils	uidUtils

Fields inherited from class com.bytedesk.core.base.BaseRestService

authService

Constructor Summary

Constructors

Constructor	Description
StatisticTokenRestService()

Method Summary

Modifier and Type	Method	Description
StatisticTokenExcel	convertToExcel(StatisticTokenEntity entity)	转换为Excel对象 子类必须实现此方法
StatisticTokenResponse	convertToResponse(StatisticTokenEntity entity)
StatisticTokenResponse	create(StatisticTokenRequest request)
protected org.springframework.data.jpa.domain.Specification<StatisticTokenEntity>	createSpecification(StatisticTokenRequest request)	创建Specification对象，子类必须实现 用于queryByOrg的通用实现
void	delete(StatisticTokenRequest request)
void	deleteByUid(String uid)
protected StatisticTokenEntity	doSave(StatisticTokenEntity entity)	子类实现具体的保存逻辑
protected org.springframework.data.domain.Page<StatisticTokenEntity>	executePageQuery(org.springframework.data.jpa.domain.Specification<StatisticTokenEntity> spec, org.springframework.data.domain.Pageable pageable)	执行分页查询，子类必须实现 用于queryByOrg的通用实现
Boolean	existsByUid(String uid)
Optional<StatisticTokenEntity>	findByOrgUidAndType(String orgUid, String type)
Optional<StatisticTokenEntity>	findByUid(String uid)
List<StatisticTokenEntity>	getAiTokenStatisticsByDateRange(String orgUid, String startDate, String endDate)	Get AI token statistics by organization and date range
List<StatisticTokenEntity>	getAiTokenStatisticsByModelType(String orgUid, String aiModelType)	Get AI token statistics by organization and AI model type
List<StatisticTokenEntity>	getAiTokenStatisticsByProvider(String orgUid, String aiProvider)	Get AI token statistics by organization and AI provider
StatisticTokenHourlyResponse	getHourlyTokenStatistics(String orgUid, String date)	Get hourly AI token statistics for a specific organization and date Returns token usage data organized by hour (0-23) for the entire day
StatisticTokenHourlyResponse	getHourlyTokenStatisticsByModelType(String orgUid, String date, String aiModelType)	Get hourly AI token statistics for a specific organization, date and AI model type
StatisticTokenHourlyResponse	getHourlyTokenStatisticsByProvider(String orgUid, String date, String aiProvider)	Get hourly AI token statistics for a specific organization, date and AI provider
BigDecimal	getTotalCostByDateRange(String orgUid, String startDate, String endDate)	Get total cost by organization and date range
Long	getTotalTokensByDateRange(String orgUid, String startDate, String endDate)	Get total token consumption by organization and date range
StatisticTokenEntity	handleOptimisticLockingFailureException(org.springframework.orm.ObjectOptimisticLockingFailureException e, StatisticTokenEntity entity)
void	recordAiTokenUsage(String orgUid, String aiProvider, String aiModelType, long promptTokens, long completionTokens, boolean success, long responseTime, BigDecimal tokenUnitPrice)	Record AI token usage statistics
StatisticTokenResponse	update(StatisticTokenRequest request)

Methods inherited from class com.bytedesk.core.base.BaseRestServiceWithExport

queryByOrgEntity

Methods inherited from class com.bytedesk.core.base.BaseRestService

deleteByOrgUid, findByOrgUid, getUidFromRequest, queryByOrg, queryByUid, queryByUser, recover, save, setUserUidToRequest

Methods inherited from class java.lang.Object

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

Field Details

statistic_tokenRepository

private final StatisticTokenRepository statistic_tokenRepository

modelMapper

private final org.modelmapper.ModelMapper modelMapper

uidUtils

private final UidUtils uidUtils

DATE_FORMATTER

private static final DateTimeFormatter DATE_FORMATTER

Constructor Details

StatisticTokenRestService

public StatisticTokenRestService()

Method Details

createSpecification

protected org.springframework.data.jpa.domain.Specification<StatisticTokenEntity> createSpecification(StatisticTokenRequest request)

Description copied from class: BaseRestService

创建Specification对象，子类必须实现 用于queryByOrg的通用实现

Specified by:

createSpecification in class BaseRestService<StatisticTokenEntity,StatisticTokenRequest,StatisticTokenResponse>

executePageQuery

protected org.springframework.data.domain.Page<StatisticTokenEntity> executePageQuery(org.springframework.data.jpa.domain.Specification<StatisticTokenEntity> spec,
 org.springframework.data.domain.Pageable pageable)

Description copied from class: BaseRestService

执行分页查询，子类必须实现 用于queryByOrg的通用实现

Specified by:

executePageQuery in class BaseRestService<StatisticTokenEntity,StatisticTokenRequest,StatisticTokenResponse>

findByUid

@Cacheable(value="statistic_token",
           key="#uid",
           unless="#result==null")
public Optional<StatisticTokenEntity> findByUid(String uid)

Specified by:

findByUid in class BaseRestService<StatisticTokenEntity,StatisticTokenRequest,StatisticTokenResponse>

findByOrgUidAndType

@Cacheable(value="statistic_token",
           key="#orgUid + \'_\' + #type",
           unless="#result==null")
public Optional<StatisticTokenEntity> findByOrgUidAndType(String orgUid,
 String type)

existsByUid

public Boolean existsByUid(String uid)

create

@Transactional
public StatisticTokenResponse create(StatisticTokenRequest request)

Specified by:

create in class BaseRestService<StatisticTokenEntity,StatisticTokenRequest,StatisticTokenResponse>

update

@Transactional
public StatisticTokenResponse update(StatisticTokenRequest request)

Specified by:

update in class BaseRestService<StatisticTokenEntity,StatisticTokenRequest,StatisticTokenResponse>

doSave

protected StatisticTokenEntity doSave(StatisticTokenEntity entity)

Description copied from class: BaseRestService

子类实现具体的保存逻辑

Specified by:

doSave in class BaseRestService<StatisticTokenEntity,StatisticTokenRequest,StatisticTokenResponse>

handleOptimisticLockingFailureException

public StatisticTokenEntity handleOptimisticLockingFailureException(org.springframework.orm.ObjectOptimisticLockingFailureException e,
 StatisticTokenEntity entity)

Specified by:

handleOptimisticLockingFailureException in class BaseRestService<StatisticTokenEntity,StatisticTokenRequest,StatisticTokenResponse>

deleteByUid

@Transactional
public void deleteByUid(String uid)

Specified by:

deleteByUid in class BaseRestService<StatisticTokenEntity,StatisticTokenRequest,StatisticTokenResponse>

delete

public void delete(StatisticTokenRequest request)

Specified by:

delete in class BaseRestService<StatisticTokenEntity,StatisticTokenRequest,StatisticTokenResponse>

convertToResponse

public StatisticTokenResponse convertToResponse(StatisticTokenEntity entity)

Specified by:

convertToResponse in class BaseRestService<StatisticTokenEntity,StatisticTokenRequest,StatisticTokenResponse>

convertToExcel

public StatisticTokenExcel convertToExcel(StatisticTokenEntity entity)

Description copied from class: BaseRestServiceWithExport

转换为Excel对象 子类必须实现此方法

Specified by:

convertToExcel in class BaseRestServiceWithExport<StatisticTokenEntity,StatisticTokenRequest,StatisticTokenResponse,StatisticTokenExcel>

recordAiTokenUsage

@Transactional
public void recordAiTokenUsage(String orgUid,
 String aiProvider,
 String aiModelType,
 long promptTokens,
 long completionTokens,
 boolean success,
 long responseTime,
 BigDecimal tokenUnitPrice)

Record AI token usage statistics

Parameters:

orgUid - Organization UID

aiProvider - AI provider (openai, baidu, zhipuai, etc.)

aiModelType - AI model type (gpt-4, gpt-3.5, claude, gemini, etc.)

promptTokens - Number of prompt tokens consumed

completionTokens - Number of completion tokens consumed

success - Whether the request was successful

responseTime - Response time in milliseconds

tokenUnitPrice - Cost per token in USD

getAiTokenStatisticsByDateRange

public List<StatisticTokenEntity> getAiTokenStatisticsByDateRange(String orgUid,
 String startDate,
 String endDate)

Get AI token statistics by organization and date range

Parameters:

orgUid - Organization UID

startDate - Start date (YYYY-MM-DD)

endDate - End date (YYYY-MM-DD)

Returns:

List of AI token statistics

getTotalTokensByDateRange

public Long getTotalTokensByDateRange(String orgUid,
 String startDate,
 String endDate)

Get total token consumption by organization and date range

Parameters:

orgUid - Organization UID

startDate - Start date (YYYY-MM-DD)

endDate - End date (YYYY-MM-DD)

Returns:

Total tokens consumed

getTotalCostByDateRange

public BigDecimal getTotalCostByDateRange(String orgUid,
 String startDate,
 String endDate)

Get total cost by organization and date range

Parameters:

orgUid - Organization UID

startDate - Start date (YYYY-MM-DD)

endDate - End date (YYYY-MM-DD)

Returns:

Total cost in USD

getAiTokenStatisticsByProvider

public List<StatisticTokenEntity> getAiTokenStatisticsByProvider(String orgUid,
 String aiProvider)

Get AI token statistics by organization and AI provider

Parameters:

orgUid - Organization UID

aiProvider - AI provider

Returns:

List of AI token statistics

getAiTokenStatisticsByModelType

public List<StatisticTokenEntity> getAiTokenStatisticsByModelType(String orgUid,
 String aiModelType)

Get AI token statistics by organization and AI model type

Parameters:

orgUid - Organization UID

aiModelType - AI model type

Returns:

List of AI token statistics

getHourlyTokenStatistics

public StatisticTokenHourlyResponse getHourlyTokenStatistics(String orgUid,
 String date)

Get hourly AI token statistics for a specific organization and date Returns token usage data organized by hour (0-23) for the entire day

Parameters:

orgUid - Organization UID

date - Date in YYYY-MM-DD format

Returns:

StatisticTokenHourlyResponse with hourly data

getHourlyTokenStatisticsByProvider

public StatisticTokenHourlyResponse getHourlyTokenStatisticsByProvider(String orgUid,
 String date,
 String aiProvider)

Get hourly AI token statistics for a specific organization, date and AI provider

Parameters:

orgUid - Organization UID

date - Date in YYYY-MM-DD format

aiProvider - AI provider (openai, baidu, zhipuai, etc.)

Returns:

StatisticTokenHourlyResponse with hourly data for the specific provider

getHourlyTokenStatisticsByModelType

public StatisticTokenHourlyResponse getHourlyTokenStatisticsByModelType(String orgUid,
 String date,
 String aiModelType)

Get hourly AI token statistics for a specific organization, date and AI model type

Parameters:

orgUid - Organization UID

date - Date in YYYY-MM-DD format

aiModelType - AI model type (gpt-4, gpt-3.5, claude, gemini, etc.)

Returns:

StatisticTokenHourlyResponse with hourly data for the specific model type