Documentation
¶
Overview ¶
Package protocol provides backward compatibility aliases to the public protocol package. All code should migrate to use "github.com/tingly-dev/tingly-box/protocol" directly.
Index ¶
- Constants
- Variables
- func GetInputValue(input responses.ResponseNewParamsInputUnion) any
- func IsContextCanceled(err error) bool
- func PreprocessInputData(data []byte) ([]byte, error)
- type APIStyle
- type APIType
- type AnthropicBetaMessagesRequest
- type AnthropicMessagesRequest
- type BetaRound
- type Client
- type ErrorDetail
- type ErrorResponse
- type GoogleRequest
- type Grouper
- type GuardrailsBufferedEvent
- type GuardrailsStreamState
- type HandleContext
- func (hc *HandleContext) CallOnStreamComplete()
- func (hc *HandleContext) EnsureGuardrails() *HandleGuardrails
- func (hc *HandleContext) EnsureGuardrailsStream() *GuardrailsStreamState
- func (hc *HandleContext) ProcessStream(nextFunc func() (bool, error, interface{}), handleFunc func(interface{}) error) error
- func (hc *HandleContext) SendError(err error, errorType, code string)
- func (hc *HandleContext) SetupSSEHeaders()
- func (hc *HandleContext) WithOnStreamComplete(hook func()) *HandleContext
- func (hc *HandleContext) WithOnStreamError(hook func(error)) *HandleContext
- func (hc *HandleContext) WithOnStreamEvent(hook func(interface{}) error) *HandleContext
- type HandleGuardrails
- type OpenAIChatCompletionRequest
- type OpenAIConfig
- type Response
- type ResponseCreateRequest
- type ResponseInputItemUnionParam
- type ResponseNewParams
- type ResponseNewParamsInputUnion
- type RoundStats
- type TokenUsage
- type V1Round
Constants ¶
const ( APIStyleOpenAI APIStyle = publicprotocol.APIStyleOpenAI APIStyleAnthropic APIStyle = publicprotocol.APIStyleAnthropic APIStyleGoogle APIStyle = publicprotocol.APIStyleGoogle TypeOpenAIChat APIType = publicprotocol.TypeOpenAIChat TypeOpenAIResponses APIType = publicprotocol.TypeOpenAIResponses TypeAnthropicV1 APIType = publicprotocol.TypeAnthropicV1 TypeAnthropicBeta APIType = publicprotocol.TypeAnthropicBeta TypeGoogle APIType = publicprotocol.TypeGoogle CodexAPIBase = publicprotocol.CodexAPIBase )
Re-export constants for backward compatibility
Variables ¶
var ( NewTokenUsage = publicprotocol.NewTokenUsage NewTokenUsageWithCache = publicprotocol.NewTokenUsageWithCache ZeroTokenUsage = publicprotocol.ZeroTokenUsage )
Re-export functions for backward compatibility
Functions ¶
func GetInputValue ¶
func GetInputValue(input responses.ResponseNewParamsInputUnion) any
GetInputValue extracts the raw input value from ResponseNewParamsInputUnion. Returns the underlying string, array, or nil.
func IsContextCanceled ¶
IsContextCanceled checks if the error is due to context cancellation.
func PreprocessInputData ¶ added in v0.260409.1540
PreprocessInputData preprocesses the JSON data before unmarshaling. It performs two preprocessing steps: 1. Adds "type": "message" to input items that don't have a type field 2. Flattens output_text content blocks into single strings
Types ¶
type APIStyle ¶
type APIStyle = publicprotocol.APIStyle
Type aliases to public protocol types for backward compatibility
type APIType ¶
type APIType = publicprotocol.APIType
type AnthropicBetaMessagesRequest ¶
type AnthropicBetaMessagesRequest struct {
Stream bool `json:"stream"`
anthropic.BetaMessageNewParams
}
Use official Anthropic SDK types directly
func (*AnthropicBetaMessagesRequest) UnmarshalJSON ¶
func (r *AnthropicBetaMessagesRequest) UnmarshalJSON(data []byte) error
type AnthropicMessagesRequest ¶
type AnthropicMessagesRequest struct {
Stream bool `json:"stream"`
anthropic.MessageNewParams
}
Request types
func (*AnthropicMessagesRequest) UnmarshalJSON ¶
func (r *AnthropicMessagesRequest) UnmarshalJSON(data []byte) error
type BetaRound ¶
type BetaRound struct {
Messages []anthropic.BetaMessageParam
IsCurrentRound bool
Stats *RoundStats // Optional metadata about the round structure
}
BetaRound represents a conversation round for v1beta API.
type Client ¶
type Client = publicprotocol.Client
type ErrorDetail ¶
type ErrorDetail struct {
Message string `json:"message"`
Type string `json:"type"`
Code string `json:"code,omitempty"`
}
ErrorDetail represents error details
type ErrorResponse ¶
type ErrorResponse struct {
Error ErrorDetail `json:"error"`
}
ErrorResponse represents an error response
type GoogleRequest ¶
type GoogleRequest struct {
Model string
Contents []*genai.Content
Config *genai.GenerateContentConfig
}
GoogleRequest wraps Google API request parameters Google's SDK uses separate parameters rather than a single request struct
type Grouper ¶
type Grouper struct{}
Grouper provides methods to group messages into conversation rounds.
func (*Grouper) GroupBeta ¶
func (g *Grouper) GroupBeta(messages []anthropic.BetaMessageParam) []BetaRound
GroupBeta groups beta messages into conversation rounds.
func (*Grouper) GroupV1 ¶
func (g *Grouper) GroupV1(messages []anthropic.MessageParam) []V1Round
GroupV1 groups v1 messages into conversation rounds. A round starts with a pure user message and includes all subsequent messages (assistant with tool use, tool results) until the next pure user message (exclusive).
func (*Grouper) IsPureBetaUserMessage ¶
func (g *Grouper) IsPureBetaUserMessage(msg anthropic.BetaMessageParam) bool
IsPureBetaUserMessage checks if a beta message is a pure user instruction.
func (*Grouper) IsPureUserMessage ¶
func (g *Grouper) IsPureUserMessage(msg anthropic.MessageParam) bool
IsPureUserMessage checks if a v1 message is a pure user instruction (not a tool result).
type GuardrailsBufferedEvent ¶ added in v0.260418.2200
type GuardrailsStreamState ¶ added in v0.260418.2200
type GuardrailsStreamState struct {
// PendingBlockMessages stores early hook verdicts keyed by tool_use id.
PendingBlockMessages map[string]string
// PendingBlockedIndex tracks which content block index is currently blocked.
PendingBlockedIndex map[int]string
// AnthropicToolEvents buffers one tool_use block from start -> delta -> stop
// so the rewrite layer can either flush the original events or replace them.
AnthropicToolEvents map[int][]GuardrailsBufferedEvent
// AnthropicToolIDs links the buffered block index back to the provider tool id.
AnthropicToolIDs map[int]string
}
type HandleContext ¶
type HandleContext struct {
// Gin context
GinContext *gin.Context
// Model info
ResponseModel string
// Guardrails runtime state shared across request/response/stream phases for
// one proxied conversation.
Guardrails *HandleGuardrails
// Hooks for stream processing (chainable - multiple hooks can be added)
OnStreamEventHooks []func(event interface{}) error
OnStreamCompleteHooks []func()
OnStreamErrorHooks []func(err error)
// Stream configuration flags
DisableStreamUsage bool // Don't include usage in streaming chunks
}
HandleContext provides dependencies for handle functions. It uses the builder pattern for optional configuration and hooks.
func NewHandleContext ¶
func NewHandleContext(c *gin.Context, responseModel string) *HandleContext
NewHandleContext creates a new HandleContext with required dependencies.
func (*HandleContext) CallOnStreamComplete ¶
func (hc *HandleContext) CallOnStreamComplete()
CallOnStreamComplete calls all OnStreamComplete hooks. This is useful for non-streaming handlers that still need to invoke complete hooks.
func (*HandleContext) EnsureGuardrails ¶ added in v0.260418.2200
func (hc *HandleContext) EnsureGuardrails() *HandleGuardrails
func (*HandleContext) EnsureGuardrailsStream ¶ added in v0.260418.2200
func (hc *HandleContext) EnsureGuardrailsStream() *GuardrailsStreamState
func (*HandleContext) ProcessStream ¶
func (hc *HandleContext) ProcessStream(nextFunc func() (bool, error, interface{}), handleFunc func(interface{}) error) error
ProcessStream provides a generic framework for processing streaming responses. It handles context cancellation, error checking, and event processing.
nextFunc should return (true, nil, event) to continue, (false, nil, nil) to stop, or (false, err, nil) on error. handleFunc is called for each event after OnStreamEventHooks are invoked. It can be used to send the event to the client.
func (*HandleContext) SendError ¶
func (hc *HandleContext) SendError(err error, errorType, code string)
SendError sends an error response to the client.
func (*HandleContext) SetupSSEHeaders ¶
func (hc *HandleContext) SetupSSEHeaders()
SetupSSEHeaders sets the standard SSE (Server-Sent Events) headers.
func (*HandleContext) WithOnStreamComplete ¶
func (hc *HandleContext) WithOnStreamComplete(hook func()) *HandleContext
WithOnStreamComplete adds a hook that is called when stream completes successfully. Multiple hooks can be added and will be called in order.
func (*HandleContext) WithOnStreamError ¶
func (hc *HandleContext) WithOnStreamError(hook func(error)) *HandleContext
WithOnStreamError adds a hook that is called when stream encounters an error. Multiple hooks can be added and will be called in order.
func (*HandleContext) WithOnStreamEvent ¶
func (hc *HandleContext) WithOnStreamEvent(hook func(interface{}) error) *HandleContext
WithOnStreamEvent adds a hook that is called for each stream event. Multiple hooks can be added and will be called in order.
type HandleGuardrails ¶ added in v0.260418.2200
type HandleGuardrails struct {
Enabled bool
CredentialMask *guardrailscore.CredentialMaskState
Stream *GuardrailsStreamState
}
type OpenAIChatCompletionRequest ¶
type OpenAIChatCompletionRequest struct {
openai.ChatCompletionNewParams
Stream bool `json:"stream"`
}
OpenAIChatCompletionRequest is a type alias for OpenAI chat completion request with extra fields.
func (*OpenAIChatCompletionRequest) UnmarshalJSON ¶
func (r *OpenAIChatCompletionRequest) UnmarshalJSON(data []byte) error
type OpenAIConfig ¶
type OpenAIConfig = publicprotocol.OpenAIConfig
type ResponseCreateRequest ¶
type ResponseCreateRequest struct {
// Stream indicates whether to stream the response
// This is not part of ResponseNewParams as streaming is controlled
// by using NewStreaming() method on the SDK client
Stream bool `json:"stream"`
// Embed the native SDK type for all other fields
responses.ResponseNewParams
}
ResponseCreateRequest wraps the native ResponseNewParams with additional fields for proxy-specific handling like the `stream` parameter.
func (*ResponseCreateRequest) UnmarshalJSON ¶
func (r *ResponseCreateRequest) UnmarshalJSON(data []byte) error
UnmarshalJSON implements custom JSON unmarshaling for ResponseCreateRequest It handles both the custom Stream field and the embedded ResponseNewParams
type ResponseInputItemUnionParam ¶
type ResponseInputItemUnionParam = responses.ResponseInputItemUnionParam
ResponseInputItemUnionParam is an alias to the native OpenAI SDK type
type ResponseNewParams ¶
type ResponseNewParams = responses.ResponseNewParams
ResponseNewParams is an alias to the native OpenAI SDK type
type ResponseNewParamsInputUnion ¶
type ResponseNewParamsInputUnion = responses.ResponseNewParamsInputUnion
ResponseNewParamsInputUnion is an alias to the native OpenAI SDK type
type RoundStats ¶
type RoundStats struct {
UserMessageCount int // Number of pure user messages in this round (should be 1)
AssistantCount int // Number of assistant messages
ToolResultCount int // Number of tool result messages
TotalMessages int // Total messages in the round
HasThinking bool // Whether any assistant message contains thinking blocks
}
RoundStats contains metadata about a round's message composition.
type TokenUsage ¶
type TokenUsage = publicprotocol.TokenUsage
type V1Round ¶
type V1Round struct {
Messages []anthropic.MessageParam
IsCurrentRound bool
Stats *RoundStats // Optional metadata about the round structure
}
V1Round represents a conversation round for v1 API.