Skip to content

agents / Exports / RemoteUsageStorage

Class: RemoteUsageStorage

Remote storage implementation for usage statistics with batching

Implements

Table of contents

Constructors

Methods

Constructors

constructor

new RemoteUsageStorage(apiUrl, _apiKey, _timeout, _headers?, batchSize?, flushInterval?): RemoteUsageStorage

Parameters

NameTypeDefault value
apiUrlstringundefined
_apiKeystringundefined
_timeoutnumberundefined
_headersRecord<string, string>{}
batchSizenumber50
flushIntervalnumber60000

Returns

RemoteUsageStorage

Defined in

packages/agents/src/plugins/usage/storages/remote-storage.ts:16

Methods

save

save(entry): Promise<void>

Parameters

NameType
entryUsageStats

Returns

Promise<void>

Implementation of

UsageStorage.save

Defined in

packages/agents/src/plugins/usage/storages/remote-storage.ts:32


getStats

getStats(conversationId?, timeRange?): Promise<UsageStats[]>

Parameters

NameType
conversationId?string
timeRange?Object
timeRange.startDate
timeRange.endDate

Returns

Promise<UsageStats[]>

Implementation of

UsageStorage.getStats

Defined in

packages/agents/src/plugins/usage/storages/remote-storage.ts:40


getAggregatedStats

getAggregatedStats(timeRange?): Promise<AggregatedUsageStats>

Parameters

NameType
timeRange?Object
timeRange.startDate
timeRange.endDate

Returns

Promise<AggregatedUsageStats>

Implementation of

UsageStorage.getAggregatedStats

Defined in

packages/agents/src/plugins/usage/storages/remote-storage.ts:59


clear

clear(): Promise<void>

Returns

Promise<void>

Implementation of

UsageStorage.clear

Defined in

packages/agents/src/plugins/usage/storages/remote-storage.ts:92


flush

flush(): Promise<void>

Returns

Promise<void>

Implementation of

UsageStorage.flush

Defined in

packages/agents/src/plugins/usage/storages/remote-storage.ts:107


close

close(): Promise<void>

Returns

Promise<void>

Implementation of

UsageStorage.close

Defined in

packages/agents/src/plugins/usage/storages/remote-storage.ts:140

Released under the MIT License.