Skip to content

feat(schema): track cache creation tokens #1158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
March-77 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(schema): track cache creation tokens #1158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion components/model/callback_extra.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,10 @@ type CompletionTokensDetails struct {

// PromptTokenDetails provides a breakdown of prompt token usage.
type PromptTokenDetails struct {
// Cached tokens present in the prompt.
// CachedTokens is the number of prompt tokens read from a provider cache.
CachedTokens int
// CacheCreationTokens is the number of prompt tokens written to a provider cache.
CacheCreationTokens int
}

// Config is the config for the model.
Expand Down
3 changes: 3 additions & 0 deletions schema/agentic_message.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1126,6 +1126,9 @@ func concatTokenUsage(usages []*TokenUsage) *TokenUsage {
if usage.PromptTokenDetails.CachedTokens > ret.PromptTokenDetails.CachedTokens {
ret.PromptTokenDetails.CachedTokens = usage.PromptTokenDetails.CachedTokens
}
if usage.PromptTokenDetails.CacheCreationTokens > ret.PromptTokenDetails.CacheCreationTokens {
ret.PromptTokenDetails.CacheCreationTokens = usage.PromptTokenDetails.CacheCreationTokens
}
if usage.CompletionTokensDetails.ReasoningTokens > ret.CompletionTokensDetails.ReasoningTokens {
ret.CompletionTokensDetails.ReasoningTokens = usage.CompletionTokensDetails.ReasoningTokens
}
Expand Down
7 changes: 5 additions & 2 deletions schema/agentic_message_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -811,7 +811,8 @@ func TestConcatAgenticMessages(t *testing.T) {
PromptTokens: 10,
CompletionTokens: 5,
PromptTokenDetails: PromptTokenDetails{
CachedTokens: 3,
CachedTokens: 3,
CacheCreationTokens: 7,
},
CompletionTokensDetails: CompletionTokensDetails{
ReasoningTokens: 2,
Expand All @@ -827,7 +828,8 @@ func TestConcatAgenticMessages(t *testing.T) {
PromptTokens: 8,
CompletionTokens: 15,
PromptTokenDetails: PromptTokenDetails{
CachedTokens: 5,
CachedTokens: 5,
CacheCreationTokens: 4,
},
CompletionTokensDetails: CompletionTokensDetails{
ReasoningTokens: 4,
Expand All @@ -845,6 +847,7 @@ func TestConcatAgenticMessages(t *testing.T) {
assert.Equal(t, 10, result.ResponseMeta.TokenUsage.PromptTokens)
assert.Equal(t, 23, result.ResponseMeta.TokenUsage.TotalTokens)
assert.Equal(t, 5, result.ResponseMeta.TokenUsage.PromptTokenDetails.CachedTokens)
assert.Equal(t, 7, result.ResponseMeta.TokenUsage.PromptTokenDetails.CacheCreationTokens)
assert.Equal(t, 4, result.ResponseMeta.TokenUsage.CompletionTokensDetails.ReasoningTokens)
})

Expand Down
7 changes: 6 additions & 1 deletion schema/message.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,8 +554,10 @@ type CompletionTokensDetails struct {

// PromptTokenDetails provides a breakdown of prompt token usage.
type PromptTokenDetails struct {
// Cached tokens present in the prompt.
// CachedTokens is the number of prompt tokens read from a provider cache.
CachedTokens int `json:"cached_tokens"`
// CacheCreationTokens is the number of prompt tokens written to a provider cache.
CacheCreationTokens int `json:"cache_creation_tokens"`
}

var _ MessagesTemplate = &Message{}
Expand Down Expand Up @@ -1752,6 +1754,9 @@ func ConcatMessages(msgs []*Message) (*Message, error) {
if msg.ResponseMeta.Usage.PromptTokenDetails.CachedTokens > ret.ResponseMeta.Usage.PromptTokenDetails.CachedTokens {
ret.ResponseMeta.Usage.PromptTokenDetails.CachedTokens = msg.ResponseMeta.Usage.PromptTokenDetails.CachedTokens
}
if msg.ResponseMeta.Usage.PromptTokenDetails.CacheCreationTokens > ret.ResponseMeta.Usage.PromptTokenDetails.CacheCreationTokens {
ret.ResponseMeta.Usage.PromptTokenDetails.CacheCreationTokens = msg.ResponseMeta.Usage.PromptTokenDetails.CacheCreationTokens
}

if msg.ResponseMeta.Usage.CompletionTokensDetails.ReasoningTokens > ret.ResponseMeta.Usage.CompletionTokensDetails.ReasoningTokens {
ret.ResponseMeta.Usage.CompletionTokensDetails.ReasoningTokens = msg.ResponseMeta.Usage.CompletionTokensDetails.ReasoningTokens
Expand Down
29 changes: 26 additions & 3 deletions schema/message_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package schema

import (
"context"
"encoding/json"
"reflect"
"sync"
"testing"
Expand All @@ -27,6 +28,25 @@ import (
"github.com/cloudwego/eino/internal/generic"
)

func TestPromptTokenDetailsJSON(t *testing.T) {
details := PromptTokenDetails{
CachedTokens: 3,
CacheCreationTokens: 5,
}

data, err := json.Marshal(details)
assert.NoError(t, err)
assert.JSONEq(t, `{"cached_tokens":3,"cache_creation_tokens":5}`, string(data))

var decoded PromptTokenDetails
assert.NoError(t, json.Unmarshal(data, &decoded))
assert.Equal(t, details, decoded)

var legacy PromptTokenDetails
assert.NoError(t, json.Unmarshal([]byte(`{"cached_tokens":3}`), &legacy))
assert.Equal(t, PromptTokenDetails{CachedTokens: 3}, legacy)
}

func TestMessageTemplate(t *testing.T) {
pyFmtMessage := UserMessage("input: {question}")
jinja2Message := UserMessage("input: {{question}}")
Expand Down Expand Up @@ -157,7 +177,8 @@ func TestConcatMessage(t *testing.T) {
CompletionTokens: 15,
PromptTokens: 30,
PromptTokenDetails: PromptTokenDetails{
CachedTokens: 15,
CachedTokens: 15,
CacheCreationTokens: 20,
},
CompletionTokensDetails: CompletionTokensDetails{
ReasoningTokens: 8,
Expand All @@ -179,7 +200,8 @@ func TestConcatMessage(t *testing.T) {
CompletionTokens: 10,
PromptTokens: 20,
PromptTokenDetails: PromptTokenDetails{
CachedTokens: 10,
CachedTokens: 10,
CacheCreationTokens: 20,
},
CompletionTokensDetails: CompletionTokensDetails{
ReasoningTokens: 5,
Expand All @@ -201,7 +223,8 @@ func TestConcatMessage(t *testing.T) {
CompletionTokens: 15,
PromptTokens: 30,
PromptTokenDetails: PromptTokenDetails{
CachedTokens: 15,
CachedTokens: 15,
CacheCreationTokens: 12,
},
CompletionTokensDetails: CompletionTokensDetails{
ReasoningTokens: 8,
Expand Down