Documentation
¶
Index ¶
Constants ¶
const ( RelayModeInherit = "inherit" RelayModeCustom = "custom" RelayModeDisabled = "disabled" PeerRouteModeDirectFirst = "direct_first" PeerRouteModeRelayOnly = "relay_only" SettingAgentRelayDefaultURI = "agent.relay_default_uri" SettingAgentRelayFallbackEnabled = "agent.relay_fallback_enabled" SettingAgentConnectivityProbeSuccessTTLSeconds = "agent.connectivity_probe_success_ttl_seconds" SettingAgentConnectivityProbeFailureRetryMinSeconds = "agent.connectivity_probe_failure_retry_min_seconds" SettingAgentConnectivityProbeFailureRetryMaxSeconds = "agent.connectivity_probe_failure_retry_max_seconds" RouteErrorSelectorInvalid = "selector_invalid" RouteErrorTargetNotFound = "target_not_found" RouteErrorTargetDisabled = "target_disabled" RouteErrorTagNoCandidate = "tag_no_candidate" RouteErrorDirectDisabled = "direct_disabled" RouteErrorDirectIngressUnsupported = "direct_ingress_unsupported" RouteErrorDirectCircuitOpen = "direct_circuit_open" RouteErrorDirectDNS = "direct_dns" RouteErrorDirectConnect = "direct_connect" RouteErrorDirectTLS = "direct_tls" RouteErrorDirectIdentityMismatch = "direct_identity_mismatch" RouteErrorDirectProbeInvalidResponse = "direct_probe_invalid_response" RouteErrorDirectCommitUncertain = "direct_commit_uncertain" RouteErrorDirectResponseInterrupted = "direct_response_interrupted" RouteErrorRelayUnsupported = "relay_unsupported" RouteErrorRelayNotConfigured = "relay_not_configured" RouteErrorRelayDisabled = "relay_disabled" RouteErrorRelayFallbackDisabled = "relay_fallback_disabled" RouteErrorRelayNotReady = "relay_not_ready" RouteErrorRelayOverloaded = "relay_overloaded" RouteErrorRelayProtocol = "relay_protocol" RouteErrorRelayAuth = "relay_auth" RouteErrorRelayCommitUncertain = "relay_commit_uncertain" RouteErrorRelayResponseInterrupted = "relay_response_interrupted" RouteErrorRequestCancelled = "request_cancelled" RouteErrorRequestDeadline = "request_deadline" RouteErrorBodyTooLarge = "body_too_large" RouteErrorBodyStoreFailed = "body_store_failed" RouteErrorStreamWindowTimeout = "stream_window_timeout" RouteErrorSessionClosed = "session_closed" RouteErrorDrainTimeout = "drain_timeout" RouteErrorRelayProbeHTTPStatus = "relay_probe_http_status" RouteErrorRelayProbeBodyTooLarge = "relay_probe_body_too_large" RouteErrorRelayProbeInvalidResponse = "relay_probe_invalid_response" RouteErrorRelayProbeInvalidResult = "relay_probe_invalid_result" )
const ( APITypeChatCompletion = "chat-completion" APITypeResponses = "responses" APITypeClaude = "claude" )
API type strings stored in database / used by frontend.
const ( FinishReasonStop = "stop" FinishReasonLength = "length" FinishReasonToolCalls = "tool_calls" FinishReasonContentFilter = "content_filter" )
Finish reason values (normalized across protocols).
const ( ClaudeStopEndTurn = "end_turn" ClaudeStopMaxTokens = "max_tokens" ClaudeStopToolUse = "tool_use" )
Claude-specific stop reason values.
const ( SettingKeyBYOKEnabled = "byok_enabled" SettingKeyBYOKMaxChannelsPerUser = "byok_max_channels_per_user" SettingKeyBYOKBillingMode = "byok_billing_mode" SettingKeyBYOKServiceFeeRatio = "byok_service_fee_ratio" SettingKeyBYOKBaseURLAllowlist = "byok_base_url_allowlist" )
BYOK 相关 settings 表 key。Setting.Value 是 string,按 typed runtime 语义 由 LookupBool/Int/String/Float 解析。所有读写此 5 key 的代码必须用这些常量, 避免拼写漂移;这些 key 同时在 settings.go settingDefs 白名单 + seed.go 默认 写入 + 各 LookupXxx 调用点共享。
const ( BYOKBillingModeFree = "free" BYOKBillingModeServiceFee = "service_fee" )
SettingKeyBYOKBillingMode 的合法枚举值。settings.go 的 validate 与 settler.go 的分支判断都引用同一常量,禁止任一边裸字面值。
const ( BYOKDefaultEnabledStr = "true" BYOKDefaultEnabledBool = true BYOKDefaultMaxChannelsPerUserStr = "20" BYOKDefaultMaxChannelsPerUserInt = 20 BYOKDefaultBillingMode = BYOKBillingModeFree BYOKDefaultServiceFeeRatioStr = "0.1" BYOKDefaultServiceFeeRatioFloat = 0.1 BYOKDefaultBaseURLAllowlistStr = "[]" )
BYOK 各 setting 的默认值。存在两种形式:
- *Str:DB 持久化形式(Setting.Value 是 string column)。被 settings.go settingDefs 的 Default 字段与 seed.go SeedBYOKSettings 共用,确保 admin 未改过任何值时落库和兜底完全一致。
- typed (Bool/Int/Float):runtime fallback 形式。被 validate.go / settler.go 的 LookupBool/LookupInt/LookupFloat 第二参数共用——LookupXxx 在 setting 不存在或解析失败时返回这个值,因此必须与 *Str 解析后语义相等。
双形式重复存在以避免每次调用 LookupXxx 都跑 strconv.Atoi/ParseFloat;改默认 值时务必同步两组常量。
const ( ChannelTypeOpenAI = 1 ChannelTypeAzure = 3 ChannelTypeOllama = 4 ChannelTypeAnthropic = 14 ChannelTypeGemini = 24 ChannelTypeAWS = 33 ChannelTypeVertexAI = 41 )
Channel provider types (numeric IDs used in database). Values match new-api's constant.ChannelType* constants.
const ( CtxKeyUserInfo = "user_info" CtxKeyRequestScope = "request_scope" CtxKeyTraceRecorder = "trace_recorder" )
Gin context key 常量,用于 middleware 写入和 handler 读取。
const ( ErrMissingToken = "missing token" ErrInvalidToken = "invalid token" ErrAdminOnly = "admin only" ErrNotFound = "not found" ErrMissingAPIKey = "missing api key" ErrInvalidAPIKey = "invalid api key" ErrTokenDisabled = "token disabled" ErrTokenExpired = "token expired" ErrModelNotAllowed = "model not allowed" ErrReadRequestBody = "failed to read request body" ErrInvalidRequestBody = "invalid request body" ErrModelRequired = "model is required" ErrNoChannelAvailable = "no available channels" ErrInsufficientQuota = "insufficient quota" )
HTTP 错误响应消息常量。
const ( HeaderAuthorization = "Authorization" HeaderContentType = "Content-Type" HeaderConnection = "Connection" HeaderCacheControl = "Cache-Control" HeaderHost = "Host" HeaderOpenAIOrg = "OpenAI-Organization" HeaderXAPIKey = "x-api-key" HeaderAnthropicVersion = "anthropic-version" // X-Vaala-* custom headers HeaderXRequestID = "X-Vaala-Request-ID" HeaderXChannelID = "X-Vaala-Channel-ID" HeaderXAgentID = "X-Vaala-Agent-ID" HeaderXAgentSecret = "X-Vaala-Agent-Secret" HeaderXAgentTag = "X-Vaala-Agent-Tag" HeaderXAgentAddressTag = "X-Vaala-Agent-Address-Tag" HeaderXAgentHop = "X-Vaala-Agent-Hop" HeaderXAgentForwardTicket = "X-Vaala-Agent-Forward-Ticket" HeaderXAgentRouteID = "X-Vaala-Agent-Route-ID" )
HTTP header names.
const ( ContentTypeJSON = "application/json" ContentTypeSSE = "text/event-stream" BearerPrefix = "Bearer " CacheControlNoCache = "no-cache" ConnectionKeepAlive = "keep-alive" AnthropicVersionValue = "2023-06-01" )
HTTP header values / prefixes.
const ( SettingKeyInviteEnabled = "invite_enabled" SettingKeyInviteUserMaxCodes = "invite_user_max_codes" SettingKeyInviteUserMaxUses = "invite_user_max_uses" )
const ( ClaimUserID = "user_id" ClaimRole = "role" ClaimUsername = "username" ClaimDisplayName = "display_name" ClaimAvatarURL = "avatar_url" ClaimExp = "exp" )
JWT MapClaims 字段名常量。
const ( RoleUser = 1 RoleAdmin = 2 )
const ( RouteChatCompletions = "/v1/chat/completions" RouteResponses = "/v1/responses" RouteMessages = "/v1/messages" )
API route paths.
const ( RPCSyncFullSync = "sync.fullSync" RPCSyncGetVersion = "sync.getVersion" RPCSyncPush = "sync.push" RPCSyncRequestFullSync = "sync.requestFullSync" RPCSyncForceFullSync = "sync.forceFullSync" RPCSyncAutoAddrUpdate = "sync.autoAddrUpdate" RPCSyncFetchEntity = "sync.fetchEntity" RPCSyncUserQuota = "sync.userQuota" RPCSyncAgentCapabilities = "sync.agentCapabilities" RPCAgentAuthBootstrap = "agent.authBootstrap" RPCAgentIssueRelayTicket = "agent.issueRelayTicket" RPCAgentIssueForwardTicket = "agent.issueForwardTicket" RPCAgentHeartbeat = "agent.heartbeat" RPCAgentOperation = "agent.operation" RPCAgentCheckConnectivity = "agent.checkConnectivity" RPCAgentDirectProbe = "agent.directProbe" RPCAgentRelayProbe = "agent.relayProbe" RPCAgentInflight = "agent.inflight" RPCAgentGoroutines = "agent.goroutines" RPCAgentInterrupt = "agent.interrupt" RPCAgentLimiterUsage = "agent.limiterUsage" RPCAgentBreakers = "agent.breakers" RPCAgentUsageQueue = "agent.usageQueue" RPCAgentUsageQueueOp = "agent.usageQueueOp" RPCAgentRouteTelemetry = "agent.routeTelemetry" RPCAgentRouteDigest = "agent.routeDigest" RPCChannelTest = "channel.test" RPCChannelFetchModels = "channel.fetchModels" RPCReportUsage = "report.usage" )
RPC/WebSocket 方法名常量。
const ( StatusEnabled = 1 StatusDisabled = 0 )
Channel/resource status values.
const SettingKeyMinQuotaReserve = "min_quota_reserve"
SettingKeyMinQuotaReserve 付费渠道放行所需的最低剩余额度(单位同 User.Quota)。 Quota <= 该值即拦付费、只放免费。默认 0(扣到 0 才拦)。
const SettingKeyTokenModelWhitelistSelfService = "token_model_whitelist_self_service"
const TraceBufferHardLimitMultiple = 30
TraceBufferHardLimitMultiple 是单个 Recorder buffer 的硬上限相对 maxBodySize 的倍数。 默认 maxBodySize=64KB → 单 buffer 硬上限 ≈ 1920 KB。
Variables ¶
var SystemBYOKBaseURLs = []string{
"https://api.openai.com",
"https://api.anthropic.com",
"https://api.groq.com",
"https://api.mistral.ai",
"https://api.cohere.com",
"https://api.x.ai",
"https://api.perplexity.ai",
"https://api.together.xyz",
"https://api.venice.ai",
"https://api.cerebras.ai",
"https://api.deepinfra.com",
"https://integrate.api.nvidia.com",
"https://openrouter.ai",
"https://api.llmgateway.io",
"https://zenmux.ai",
"https://api.kilo.ai",
"https://ai-gateway.vercel.sh",
"https://generativelanguage.googleapis.com",
"https://dashscope.aliyuncs.com",
"https://dashscope-intl.aliyuncs.com",
"https://api.githubcopilot.com",
"https://opencode.ai",
"https://api.cloudflare.com",
}
SystemBYOKBaseURLs 是系统内置的 BYOK BaseURL 前缀集合,随版本演进。 新增 provider 直接在这里 append;老部署升级即自动生效。 不写入 settings 表;admin 不可禁用某条(如未来需要禁用能力,加 byok_system_baseurl_disabled setting 走黑名单并集)。
Functions ¶
func IsConnectivityProbeErrorCode ¶ added in v0.0.13
func IsPublicRouteErrorCode ¶ added in v0.0.13
func PublicRouteErrorCodes ¶ added in v0.0.13
func PublicRouteErrorCodes() []string
Types ¶
This section is empty.