Documentation
¶
Index ¶
- Constants
- Variables
- func AdaptFunctionFallbackEvents(ctx context.Context, events <-chan ir.Event, ...) <-chan ir.Event
- func AdaptNamespacedFunctionEvents(ctx context.Context, events <-chan ir.Event, ...) <-chan ir.Event
- func AssertStreamingToolCallInvariant(events []ir.Event) error
- func AssertToolsInvariant(tools []any) error
- func BuildChatFunctionName(namespace, name string) string
- func CloneToolCallProviderData(data *ir.ToolCallProviderData) *ir.ToolCallProviderData
- func DropEmptyTextBlocks(blocks []ir.ContentBlock) []ir.ContentBlock
- func EncodeReasoningBlock(reasoning *ir.ReasoningContent, targetProtocol string) json.RawMessage
- func FilterOptionalRequestFields(request *ir.Request, permissions RequestFieldPermissions)
- func FunctionFallbackTools(request *ir.Request) map[string]FunctionFallbackTool
- func IsPackedToolCallID(id string) bool
- func NamespacedFunctionBindings(request *ir.Request) map[string]NamespacedFunctionBinding
- func NormalizeAssistantToolCallSequence(messages []ir.Message) []ir.Message
- func PackToolCallEvents(ctx context.Context, events <-chan ir.Event) <-chan ir.Event
- func PackToolCallID(id string, data *ir.ToolCallProviderData) string
- func PrepareNamespacedFunctionsForChat(request *ir.Request) (*ir.Request, error)
- func PrepareToolCallsForUpstream(request *ir.Request, targetProtocol ir.Protocol, targetModel string, ...)
- func RecordDroppedTools(request *ir.Request, dropped []DroppedTool)
- func RecordFunctionFallbackTools(request *ir.Request, tools []FunctionFallbackTool)
- func UnpackRequestToolCallIDs(request *ir.Request)
- func UnpackToolCallEvents(ctx context.Context, events <-chan ir.Event, targetModel string) <-chan ir.Event
- func UnpackToolCallID(id string) (rawID string, data *ir.ToolCallProviderData)
- type BuiltinToolFallbackPolicy
- type DroppedTool
- type FunctionFallbackTool
- type NamespacedFunctionBinding
- type OpenAIUsageTokens
- type Options
- type RequestFieldPermissions
- type ResolvedTool
- type TargetEmitFuncs
- type ToolSignatureFallback
Constants ¶
const ( ReasoningProtocolClaude = "claude" ReasoningProtocolResponses = "responses" ReasoningProtocolOpenAIChat = "openai_chat" )
const ( DroppedToolReasonCrossProtocolIncompatible = "cross_protocol_incompatible" DroppedToolReasonFunctionFallbackUnsupported = "function_fallback_unsupported" )
Variables ¶
var ( ErrNamespacedFunctionMissingNamespace = errors.New("codec: namespaced function has empty namespace") ErrNamespacedFunctionMissingName = errors.New("codec: namespaced function has empty name") ErrNamespacedFunctionNotFunction = errors.New("codec: namespaced tool is not a function") ErrNamespacedFunctionNameCollision = errors.New("codec: namespaced function Chat name collision") )
var ( ErrFunctionToolMissingName = errors.New("codec: function tool has empty name") ErrBuiltinToolUnsupported = errors.New("codec: built-in tool not supported by target protocol") )
Functions ¶
func AssertToolsInvariant ¶
func BuildChatFunctionName ¶
func CloneToolCallProviderData ¶ added in v0.0.26
func CloneToolCallProviderData(data *ir.ToolCallProviderData) *ir.ToolCallProviderData
CloneToolCallProviderData 深拷贝 ProviderData,改副本不影响原值。
func DropEmptyTextBlocks ¶
func DropEmptyTextBlocks(blocks []ir.ContentBlock) []ir.ContentBlock
func EncodeReasoningBlock ¶ added in v0.0.19
func EncodeReasoningBlock(reasoning *ir.ReasoningContent, targetProtocol string) json.RawMessage
EncodeReasoningBlock projects protocol-neutral reasoning into a complete Claude thinking block, Responses reasoning item, or OpenAI Chat reasoning_content representation. Unknown source fields are preserved, while structured fields remain authoritative.
func FilterOptionalRequestFields ¶
func FilterOptionalRequestFields(request *ir.Request, permissions RequestFieldPermissions)
func FunctionFallbackTools ¶
func FunctionFallbackTools(request *ir.Request) map[string]FunctionFallbackTool
func IsPackedToolCallID ¶ added in v0.0.26
IsPackedToolCallID 判断一个工具调用 ID 是不是 llmkit 打包的,任何版本的包和坏包都算。
func NamespacedFunctionBindings ¶
func NamespacedFunctionBindings(request *ir.Request) map[string]NamespacedFunctionBinding
func NormalizeAssistantToolCallSequence ¶
NormalizeAssistantToolCallSequence moves matching tool responses next to their assistant tool calls and absorbs interleaved assistant preamble text. It returns a new slice and does not mutate the input messages.
func PackToolCallEvents ¶ added in v0.0.26
PackToolCallEvents 把写给使用者的工具调用 ID 打包,并清掉 ProviderData。
func PackToolCallID ¶ added in v0.0.26
func PackToolCallID(id string, data *ir.ToolCallProviderData) string
PackToolCallID 把原始 ID 和 ProviderData 编成一个工具调用 ID;没有 ProviderData 时返回原始 ID。
func PrepareToolCallsForUpstream ¶ added in v0.0.26
func PrepareToolCallsForUpstream(request *ir.Request, targetProtocol ir.Protocol, targetModel string, fallback ToolSignatureFallback)
PrepareToolCallsForUpstream 按目标协议和模型决定每个工具调用写原生字段、写包还是只写原始 ID,再按兜底补假签名。
func RecordDroppedTools ¶
func RecordDroppedTools(request *ir.Request, dropped []DroppedTool)
func RecordFunctionFallbackTools ¶
func RecordFunctionFallbackTools(request *ir.Request, tools []FunctionFallbackTool)
func UnpackRequestToolCallIDs ¶ added in v0.0.26
UnpackRequestToolCallIDs 把使用者请求里工具调用和工具结果的包拆回原始 ID 和 ProviderData。
func UnpackToolCallEvents ¶ added in v0.0.26
func UnpackToolCallEvents(ctx context.Context, events <-chan ir.Event, targetModel string) <-chan ir.Event
UnpackToolCallEvents 拆开上游响应事件里的包,并给 ProviderData 追加本层模型名。
func UnpackToolCallID ¶ added in v0.0.26
func UnpackToolCallID(id string) (rawID string, data *ir.ToolCallProviderData)
UnpackToolCallID 从工具调用 ID 拆出原始 ID 和 ProviderData。
Types ¶
type BuiltinToolFallbackPolicy ¶
type BuiltinToolFallbackPolicy string
const ( BuiltinToolFallbackDrop BuiltinToolFallbackPolicy = "drop" BuiltinToolFallbackError BuiltinToolFallbackPolicy = "error" BuiltinToolFallbackPassthrough BuiltinToolFallbackPolicy = "passthrough" BuiltinToolFallbackFunction BuiltinToolFallbackPolicy = "function" )
func NormalizeBuiltinToolFallback ¶
func NormalizeBuiltinToolFallback(value string) BuiltinToolFallbackPolicy
type DroppedTool ¶
type DroppedTool struct {
Type string `json:"type"`
Name string `json:"name,omitempty"`
Reason string `json:"reason"`
}
func DroppedTools ¶
func DroppedTools(request *ir.Request) []DroppedTool
type FunctionFallbackTool ¶
type OpenAIUsageTokens ¶ added in v0.0.22
type OpenAIUsageTokens struct {
PromptTokens int
CompletionTokens int
TotalTokens int
CachedTokens int
}
OpenAIUsageTokens is an IR usage projected onto OpenAI wire semantics.
func ProjectUsageOpenAI ¶ added in v0.0.22
func ProjectUsageOpenAI(u *ir.Usage) OpenAIUsageTokens
ProjectUsageOpenAI converts IR usage to OpenAI conventions.
IR keeps cache tokens in disjoint buckets (Claude convention: PromptTokens excludes cache; CacheReadTokens/CacheWriteTokens are separate counters), while OpenAI reports prompt/input tokens as the FULL input including cached tokens and carries the cached subset in *_tokens_details.cached_tokens. CachedTokens is only set by OpenAI decoders, where PromptTokens already includes the cached subset.
type Options ¶
type Options struct {
BuiltinToolFallback BuiltinToolFallbackPolicy
RequestFields RequestFieldPermissions
}
type RequestFieldPermissions ¶
type RequestFieldPermissions struct {
AllowServiceTier bool `json:"allow_service_tier,omitempty"`
AllowInferenceGeo bool `json:"allow_inference_geo,omitempty"`
AllowStore bool `json:"allow_store"`
AllowSafetyIdentifier bool `json:"allow_safety_identifier,omitempty"`
AllowIncludeObfuscation bool `json:"allow_include_obfuscation,omitempty"`
}
func DefaultRequestFieldPermissions ¶
func DefaultRequestFieldPermissions() RequestFieldPermissions
type ResolvedTool ¶
type ResolvedTool struct {
Emit any
Dropped *DroppedTool
FunctionFallback *FunctionFallbackTool
}
func ResolveTool ¶
func ResolveTool(tool ir.Tool, source, target ir.Protocol, policy BuiltinToolFallbackPolicy, emit TargetEmitFuncs) (ResolvedTool, error)
type TargetEmitFuncs ¶
type ToolSignatureFallback ¶ added in v0.0.26
type ToolSignatureFallback string
ToolSignatureFallback 是一轮工具调用没有可用签名时补什么。
const ( ToolSignatureFallbackNone ToolSignatureFallback = "none" ToolSignatureFallbackGemini ToolSignatureFallback = "gemini" )