|
| 1 | +/* |
| 2 | + * Copyright 2025 CloudWeGo Authors |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package agentic |
| 18 | + |
| 19 | +import ( |
| 20 | + "github.com/cloudwego/eino/callbacks" |
| 21 | + "github.com/cloudwego/eino/schema" |
| 22 | +) |
| 23 | + |
| 24 | +// TokenUsageMeta is the token usage for the model. |
| 25 | +type TokenUsageMeta struct { |
| 26 | + InputTokens int64 `json:"input_tokens"` |
| 27 | + InputTokensDetails InputTokensUsageDetails `json:"input_tokens_details"` |
| 28 | + OutputTokens int64 `json:"output_tokens"` |
| 29 | + OutputTokensDetails OutputTokensUsageDetails `json:"output_tokens_details"` |
| 30 | + TotalTokens int64 `json:"total_tokens"` |
| 31 | +} |
| 32 | + |
| 33 | +type InputTokensUsageDetails struct { |
| 34 | + CachedTokens int64 `json:"cached_tokens"` |
| 35 | +} |
| 36 | + |
| 37 | +type OutputTokensUsageDetails struct { |
| 38 | + ReasoningTokens int64 `json:"reasoning_tokens"` |
| 39 | +} |
| 40 | + |
| 41 | +// Config is the config for the model. |
| 42 | +type Config struct { |
| 43 | + // Model is the model name. |
| 44 | + Model string |
| 45 | + // Temperature is the temperature, which controls the randomness of the model. |
| 46 | + Temperature float32 |
| 47 | + // TopP is the top p, which controls the diversity of the model. |
| 48 | + TopP float32 |
| 49 | +} |
| 50 | + |
| 51 | +// CallbackInput is the input for the model callback. |
| 52 | +type CallbackInput struct { |
| 53 | + // Responses is the responses to be sent to the model. |
| 54 | + Responses []*schema.AgenticMessage |
| 55 | + // Tools is the tools to be used in the model. |
| 56 | + Tools []*schema.ToolInfo |
| 57 | + // Config is the config for the model. |
| 58 | + Config *Config |
| 59 | + // Extra is the extra information for the callback. |
| 60 | + Extra map[string]any |
| 61 | +} |
| 62 | + |
| 63 | +// CallbackOutput is the output for the model callback. |
| 64 | +type CallbackOutput struct { |
| 65 | + // Response is the response generated by the model. |
| 66 | + Response *schema.AgenticMessage |
| 67 | + // Config is the config for the model. |
| 68 | + Config *Config |
| 69 | + // Usage is the token usage of this request. |
| 70 | + Usage *TokenUsageMeta |
| 71 | + // Extra is the extra information for the callback. |
| 72 | + Extra map[string]any |
| 73 | +} |
| 74 | + |
| 75 | +// ConvCallbackInput converts the callback input to the model callback input. |
| 76 | +func ConvCallbackInput(src callbacks.CallbackInput) *CallbackInput { |
| 77 | + switch t := src.(type) { |
| 78 | + case *CallbackInput: // when callback is triggered within component implementation, the input is usually already a typed *model.CallbackInput |
| 79 | + return t |
| 80 | + case []*schema.AgenticMessage: // when callback is injected by graph node, not the component implementation itself, the input is the input of Chat Model interface, which is []*schema.AgenticMessage |
| 81 | + return &CallbackInput{ |
| 82 | + Responses: t, |
| 83 | + } |
| 84 | + default: |
| 85 | + return nil |
| 86 | + } |
| 87 | +} |
| 88 | + |
| 89 | +// ConvCallbackOutput converts the callback output to the model callback output. |
| 90 | +func ConvCallbackOutput(src callbacks.CallbackOutput) *CallbackOutput { |
| 91 | + switch t := src.(type) { |
| 92 | + case *CallbackOutput: // when callback is triggered within component implementation, the output is usually already a typed *model.CallbackOutput |
| 93 | + return t |
| 94 | + case *schema.AgenticMessage: // when callback is injected by graph node, not the component implementation itself, the output is the output of Chat Model interface, which is *schema.AgenticMessage |
| 95 | + return &CallbackOutput{ |
| 96 | + Response: t, |
| 97 | + } |
| 98 | + default: |
| 99 | + return nil |
| 100 | + } |
| 101 | +} |
0 commit comments