mirror of
https://github.com/we-promise/sure.git
synced 2026-06-04 10:19:03 +00:00
* feat(ai): add Anthropic provider with chat parity (1/5)
Introduces Provider::Anthropic alongside Provider::Openai, implementing
the LlmConcept chat_response contract over the official anthropic Ruby
SDK. Batch ops, PDF, and RAG land in follow-up PRs.
- Provider::Anthropic uses Messages API for sync and streaming responses
- ChatConfig builds requests with ephemeral prompt-cache markers on the
system prompt and the last tool definition
- MessageFormatter reconstructs multi-turn history (text + tool_use +
tool_result blocks) from raw Message records, including the paired
user-role tool_result turn Anthropic requires after every tool_use
- ChatParser maps Anthropic Message into the shared ChatResponse Data
- Registry, Setting, User, Chat default model wired for ANTHROPIC_*
envs and Setting.anthropic_*; LLM_PROVIDER selects between providers
- Responder forwards raw conversation_history (Array<Message>) so
providers without hosted conversation state can rebuild context
- OpenAI provider accepts and ignores the new kwarg (no behavior change)
Tests cover provider init, model gating, MessageFormatter for all turn
shapes, ChatConfig request building (max_tokens, system cache, tool
conversion), ChatParser for text / tool_use / mixed blocks, Registry
discovery, and mocked chat_response success / error / function_request
paths. Live VCR cassettes recorded in a follow-up with a real key.
Stacked PRs: 2/5 batch ops + cost ledger, 3/5 PDF, 4/5 pgvector RAG,
5/5 settings UI + disclosure.
* fix(ai): address PR review on Anthropic provider foundation
Surface fixes raised by Codex + CodeRabbit on PR 1/5:
- Provider::Anthropic#chat_response now accepts (and ignores) a
`messages:` kwarg. Assistant::Responder passes both `messages:`
(OpenAI-shape) and `conversation_history:` (raw Message records) for
cross-provider parity, so the previous signature raised
ArgumentError on the first chat turn through the Anthropic provider.
- Provider::Anthropic#supports_model? bypasses the `claude` prefix
gate when a custom base_url is configured, mirroring the OpenAI
provider. Bedrock-shaped IDs like
`anthropic.claude-sonnet-4-5-20250929-v1:0` and
`claude-opus-4@20250514` are otherwise rejected by
Assistant::Provided#get_model_provider and the chat dies.
- Setting.anthropic_access_token is now in
EncryptedSettingFields::ENCRYPTED_FIELDS so the Anthropic API key
is encrypted at rest like every other provider secret. Previously
plaintext while siblings (openai_access_token, twelve_data_api_key,
external_assistant_token) were ciphertext.
- Chat.default_model falls back to whichever provider is actually
configured. Previously, with LLM_PROVIDER=anthropic but no
Anthropic credentials, the default model resolved to a Claude ID
that no registered provider supported, so chats failed even when
OpenAI was fully configured. Adds Provider::{Anthropic,Openai}#configured?
class methods for the readable callsite.
- Provider::Anthropic.effective_model uses
`ENV["ANTHROPIC_MODEL"].presence || Setting.anthropic_model` so the
Setting lookup is only performed when the env var is absent — the
previous `ENV.fetch(KEY, default)` evaluated the default arg
eagerly on every call.
- Provider::Anthropic::ChatConfig#anthropic_input_schema strips both
`:strict` and `"strict"` keys so JSON-decoded schemas with string
keys cannot leak the OpenAI-only flag through to Anthropic.
Test coverage added: supports_model? bypass on custom endpoints,
chat_response messages: kwarg compatibility, default_model fallback
in the three credential combinations, configured? against ENV +
Setting, strict-flag stripping for both key types, and a
`Setting.expects(:anthropic_model).never` assertion proving the
ENV-precedence test now exercises the lazy path.
All 4365 tests pass (1 pre-existing libvips env error unrelated).
* test(chat): make default_model tests resilient to ENV model overrides
CodeRabbit flagged on PR review: the new default_model tests asserted
against Provider::*::DEFAULT_MODEL, but Chat.default_model actually
returns Provider::*.effective_model.presence (which reads
OPENAI_MODEL / ANTHROPIC_MODEL from the environment). With either env
var set, the tests would fail intermittently even though routing was
correct.
- New default_model tests now assert against the provider's
effective_model directly, so they verify the routing decision
(which provider's value wins) without coupling to the constant.
- Pre-existing "creates with default model" assertions had the same
brittleness; switch them to compare against Chat.default_model so
the chosen model is whatever the env / Setting cascade resolves to.
Verified by running `ANTHROPIC_MODEL=claude-haiku-4-5 OPENAI_MODEL=gpt-4o
bin/rails test test/models/chat_test.rb` — 16 runs, 0 failures
(previously 2 pre-existing failures + 0 from the new tests).
* fix(ai): address local review on Anthropic foundation
- Provider::Anthropic#supports_pdf_processing? bypasses prefix gate for
custom endpoints, mirroring supports_model?
- Provider::Anthropic#initialize raises Error when custom_endpoint? AND
model.blank?, parity with Provider::Openai
- stream_chat_response captures partial usage on mid-stream errors and
records it via the new on_partial callback so chat_response can skip
the duplicate error row in the outer rescue
- safe_accumulated_message swallows the secondary failure when the SDK
cannot reconstruct a snapshot
- langfuse_client memoizes properly (||= instead of =) so repeated calls
don't churn Langfuse instances
- MessageFormatter sorts tool_calls by created_at then id so the
message array is deterministic across replays; skips tool_calls
missing both provider_call_id and provider_id rather than sending
`id: nil` and getting rejected by Anthropic
- Setting.anthropic_access_token default falls back through
ENV["ANTHROPIC_API_KEY"].presence (was missing .presence, so an
empty-string env value bled through)
- User#openai_configured? / #anthropic_configured? delegate to the
Provider::* class methods — single source of truth
- Assistant::Responder renames the OpenAI-shape history builder
conversation_history → openai_messages_payload so the kwarg name
matches the local method name (messages: openai_messages_payload,
conversation_history: chat_message_records)
- Assistant::Builtin stale-history comment updated to reference both
builders
Adds a streaming chat_response test using ad-hoc subclasses of the
SDK event types so the case/when dispatch matches via is_a? without
stubbing class-level === behavior.
* test(ai): add Anthropic tool_use round-trip + multi-tool turn coverage
Addresses @jjmata's "worth confirming" note on PR #1983: tool-use turns
from prior assistant messages must round-trip correctly when retrieved
from the database.
- New `ChatParser → ToolCall::Function → MessageFormatter` test walks
the full path: Anthropic response with a tool_use block →
ChatFunctionRequest → ToolCall::Function.from_function_request →
persisted on the AssistantMessage → MessageFormatter rebuild on the
next turn. Asserts the original `tool_use.id` is preserved end-to-end
as both `tool_use.id` and the paired `tool_result.tool_use_id`, and
that the original `input` hash and serialized result content survive.
- New multi-tool assistant turn test confirms two tool_use blocks on a
single assistant message render as two tool_use blocks followed by
two paired tool_result blocks in a single user-role follow-up,
matching Anthropic's required alternation.
Both tests exercise the existing PR1 code without behavior changes.
* test(ai): require "ostruct" explicitly in Anthropic provider tests
OpenStruct is moving out of Ruby's default load path (warning in 3.4+,
removed in 3.5+). Tests work today because ActiveSupport transitively
loads it, but that's incidental. Match the existing convention in
test/controllers/settings/hostings_controller_test.rb which explicitly
requires ostruct for the same reason.
* fix(ai): sanitize Langfuse warn logs, normalize tool_use.input, dedup history fetch
Addresses three open CodeRabbit findings on PR #1983.
- Provider::Anthropic Langfuse rescue branches no longer include
`e.full_message` in `Rails.logger.warn`. `full_message` bundles the
backtrace + cause chain and on some SDK error types includes the
serialized request/response payload (prompt, model output). Logs
now report `#{e.class}: #{e.message}` only. Three sites:
create_langfuse_trace, log_langfuse_generation, upsert_langfuse_trace.
Note: Provider::Openai has the same pattern (copy-pasted source) —
harmonization deferred to a follow-up cleanup PR; this commit fixes
only the Anthropic provider to keep PR scope tight.
- MessageFormatter#parse_arguments now coerces any non-Hash parsed
result to `{}`. Anthropic's Messages API requires `tool_use.input`
to be a JSON object (map); a stored ToolCall::Function record whose
arguments parse to a scalar, bool, or array (corrupt row, legacy
data, cross-provider bleed) would otherwise produce a payload the
API rejects. Normal flow stores Hash arguments end-to-end so the
fix is defensive — adds 2 tests covering scalar/array JSON strings
and non-String non-Hash inputs.
- Assistant::Responder dedups the chat-history fetch. The previous
layout fired two near-identical `chat.messages.where(...).includes(
:tool_calls).ordered` queries per LLM turn (one for the OpenAI-shape
payload, one for the raw-records kwarg). A new memoized
`complete_chat_messages` fetches once; `chat_message_records` filters
out the current message via `Array#reject`, `openai_messages_payload`
iterates the cached array unchanged. One SQL query per turn instead
of two. Memoization scope = single Responder instance (per LLM call),
so cache invalidation is not a concern.
All 4370 tests pass (1 pre-existing libvips env error unrelated).
Rubocop + brakeman clean.
* fix(ci): replace sk-ant- prefixed test placeholders
Pipelock secret scanner pattern-matches `sk-ant-*` as a real Anthropic
API key and fails the PR security-scan check. Test stubs and
ClimateControl env values used `sk-ant-test`, `sk-ant-from-setting`,
`sk-ant-x`, `sk-ant-y` as obvious placeholders, but the scanner does
not care about value entropy.
Switched to `fake-anthropic-key-*` / `fake-token-*` strings so the
scanner stops flagging them. No production code touched, no behavior
change — Provider::Anthropic still accepts any non-blank token.
* feat(ai): add Anthropic batch ops + LLM cost ledger (2/5)
Implements auto_categorize, auto_detect_merchants, and
enhance_provider_merchants on Provider::Anthropic via forced tool calls,
plus the cost-ledger plumbing they need.
- Provider::Anthropic::AutoCategorizer, AutoMerchantDetector,
ProviderMerchantEnhancer each define a single output tool whose
input_schema mirrors the desired output, then force the model to call
it via tool_choice: { type: "tool", name: ..., disable_parallel_tool_use: true }.
Anthropic guarantees the tool_use.input matches the schema, so there
is no JSON parsing fragility, no <think> tag stripping, and no
json_object/json_schema fallback ladders.
- Concerns::UsageRecorder mirrors the OpenAI sibling but persists
cache_creation_input_tokens / cache_read_input_tokens to dedicated
columns instead of metadata.
- Migration adds cache_creation_tokens, cache_read_tokens (nullable
integers) to llm_usages. OpenAI rows leave them null.
- LlmUsage::PRICING gains Claude 4.x rows (opus-4-7 $15/$75, sonnet-4-6
$3/$15, haiku-4-5 $1/$5 per MTok). infer_provider returns "anthropic"
for claude-* via the existing exact/prefix lookup.
- Provider::Anthropic#chat_response now persists cache columns directly
rather than stashing them in metadata.
- 25-transaction batch cap mirrors the OpenAI provider so the cost
ledger sees the same shape regardless of which provider ran a batch.
Tests cover the forced-tool-call path, null/None normalization,
case-insensitive merchant matching, the missing-tool_use error path,
and Anthropic-specific pricing + provider inference on LlmUsage.
Stacked on #1983 (PR 1/5). 3/5 PDF + vision next.
* fix(ai): attribute Bedrock model IDs to anthropic + clean nil enum
- LlmUsage.infer_provider now returns "anthropic" for Bedrock /
Vertex shaped IDs (anthropic.* and anthropic/*), so cost-ledger
filtering by provider stays correct even when no per-MTok rate is
stored. Previously these IDs fell through to the "openai" default.
- AutoCategorizer drops the redundant nil sentinel from the
category_name enum — the union type [string, null] already permits
null, and some JSON Schema validators reject nil literals inside
enum arrays.
* test(ai): require "ostruct" in Anthropic batch op tests
Same rationale as the PR1 ostruct fix — explicit require so the tests
don't depend on ActiveSupport's transitive load when Ruby 3.5+ removes
OpenStruct from the default load path.
* fix(llm-usage): include Anthropic cache tokens in estimated_cost
calculate_cost only priced prompt + completion tokens, so estimated_cost
under-reported every cached call — the cache_creation/cache_read columns this PR
added were tracked but never billed. Verified against the Anthropic dashboard: a
cached chat turn billed $0.05 but the ledger recorded $0.038; the gap was exactly
the unpriced cache tokens.
Price them relative to the input rate (Anthropic: cache write 1.25x, read 0.1x)
and thread the cache counts from both recorders (chat + batch). OpenAI rows leave
the columns null (treated as 0), so they're unaffected. Ledger now reproduces the
dashboard ($0.054 for the test turn).
* chore(ai): guard chat usage double-record; flag deferred Anthropic batch wiring
- Hardening: guard the success-path record_llm_usage with
`unless partial_usage_recorded` so a future change that emits partial usage on
a normal stream can't silently double-bill (the symptom investigated in the
#1984 review). No behavior change today — on_partial only fires from the
mid-stream-error rescue, which re-raises past this line.
- Notice: the family auto-categorize / merchant-detect / merchant-enhance flows
still hardcode get_provider(:openai). Provider::Anthropic now implements those
batch ops but they aren't wired into the family flows yet — documented with
TODOs at each site for the follow-up.
* chore(ai): point family-flow TODOs at tracking issue #2113
* fix(ai): address review findings on cost ledger + categorizer schema
Three AI-review findings on #1984:
- category_name enum omitted null (codex + coderabbit): the prompt + type allow
Claude to abstain on uncertain transactions, but JSON Schema `enum` restricted
the value to category names, so null was invalid — forcing miscategorization.
Append nil to the enum (the consumer already normalizes null -> uncategorized).
- Cache pricing applied to all providers (coderabbit): the 1.25x/0.1x cache
multipliers are Anthropic-specific. Gate them on provider == "anthropic" so a
non-Anthropic caller passing cache counts isn't billed with the wrong rates.
- Negative cache-token counts (coderabbit): add DB check constraints
(cache_*_tokens IS NULL OR >= 0), per the repo's DB-level-validation convention.
Tests: enum includes nil; non-Anthropic cache tokens aren't priced.
202 lines
8.2 KiB
Ruby
202 lines
8.2 KiB
Ruby
class LlmUsage < ApplicationRecord
|
|
belongs_to :family
|
|
|
|
validates :provider, :model, :operation, presence: true
|
|
validates :prompt_tokens, :completion_tokens, :total_tokens, presence: true, numericality: { greater_than_or_equal_to: 0 }
|
|
validates :estimated_cost, numericality: { greater_than_or_equal_to: 0 }, allow_nil: true
|
|
|
|
scope :for_family, ->(family) { where(family: family) }
|
|
scope :for_operation, ->(operation) { where(operation: operation) }
|
|
scope :recent, -> { order(created_at: :desc) }
|
|
scope :for_date_range, ->(start_date, end_date) { where(created_at: start_date..end_date) }
|
|
|
|
# OpenAI pricing per 1M tokens (as of Oct 2025)
|
|
# Source: https://platform.openai.com/docs/pricing
|
|
PRICING = {
|
|
"openai" => {
|
|
# GPT-4.1 and similar models
|
|
"gpt-4.1" => { prompt: 2.00, completion: 8.00 },
|
|
"gpt-4.1-mini" => { prompt: 0.40, completion: 1.60 },
|
|
"gpt-4.1-nano" => { prompt: 0.40, completion: 1.60 },
|
|
# 4o
|
|
"gpt-4o" => { prompt: 2.50, completion: 10.00 },
|
|
"gpt-4o-mini" => { prompt: 0.15, completion: 0.60 },
|
|
# GPT-5 models (estimated pricing)
|
|
"gpt-5" => { prompt: 1.25, completion: 10.00 },
|
|
"gpt-5-mini" => { prompt: 0.25, completion: 2.00 },
|
|
"gpt-5-nano" => { prompt: 0.05, completion: 0.40 },
|
|
"gpt-5-pro" => { prompt: 15.00, completion: 120.00 },
|
|
# o1 models
|
|
"o1-mini" => { prompt: 1.10, completion: 4.40 },
|
|
"o1" => { prompt: 15.00, completion: 60.00 },
|
|
# o3 models (estimated pricing)
|
|
"o3" => { prompt: 2.00, completion: 8.00 },
|
|
"o3-mini" => { prompt: 1.10, completion: 4.40 },
|
|
"o3-pro" => { prompt: 20.00, completion: 80.00 }
|
|
},
|
|
"google" => {
|
|
"gemini-2.5-pro" => { prompt: 1.25, completion: 10.00 },
|
|
"gemini-2.5-flash" => { prompt: 0.3, completion: 2.50 }
|
|
},
|
|
# Anthropic pricing per 1M tokens (Claude 4.x family, as of May 2026)
|
|
# Source: https://www.anthropic.com/pricing
|
|
"anthropic" => {
|
|
"claude-opus-4-7" => { prompt: 15.00, completion: 75.00 },
|
|
"claude-opus-4-6" => { prompt: 15.00, completion: 75.00 },
|
|
"claude-sonnet-4-6" => { prompt: 3.00, completion: 15.00 },
|
|
"claude-sonnet-4-5" => { prompt: 3.00, completion: 15.00 },
|
|
"claude-haiku-4-5" => { prompt: 1.00, completion: 5.00 }
|
|
}
|
|
}.freeze
|
|
|
|
# Calculate cost for a model and token usage
|
|
# Provider is automatically inferred from the model using the pricing map
|
|
# Returns nil if pricing is not available for the model (e.g., custom/self-hosted providers)
|
|
def self.calculate_cost(model:, prompt_tokens:, completion_tokens:, cache_creation_tokens: 0, cache_read_tokens: 0)
|
|
provider = infer_provider(model)
|
|
pricing = find_pricing(provider, model)
|
|
|
|
unless pricing
|
|
Rails.logger.info("No pricing found for model: #{model} (inferred provider: #{provider})")
|
|
return nil
|
|
end
|
|
|
|
# Pricing is per 1M tokens, so divide by 1_000_000
|
|
prompt_cost = (prompt_tokens * pricing[:prompt]) / 1_000_000.0
|
|
completion_cost = (completion_tokens * pricing[:completion]) / 1_000_000.0
|
|
|
|
# Anthropic prompt-cache tokens bill relative to the input rate: cache
|
|
# writes at 1.25x, cache reads at 0.1x. These multipliers are Anthropic's;
|
|
# gate on the provider so a non-Anthropic caller that happens to pass cache
|
|
# counts can't be priced with the wrong (e.g. OpenAI cached-input is 0.5x,
|
|
# no write premium) rates. Without cache pricing at all, estimated_cost
|
|
# under-reports every cached Anthropic call vs the real bill (see #1984 review).
|
|
cache_creation_cost = 0.0
|
|
cache_read_cost = 0.0
|
|
if provider == "anthropic"
|
|
cache_creation_cost = (cache_creation_tokens.to_i * pricing[:prompt] * 1.25) / 1_000_000.0
|
|
cache_read_cost = (cache_read_tokens.to_i * pricing[:prompt] * 0.10) / 1_000_000.0
|
|
end
|
|
|
|
cost = (prompt_cost + completion_cost + cache_creation_cost + cache_read_cost).round(6)
|
|
Rails.logger.info("Calculated cost for #{provider}/#{model}: $#{cost} (#{prompt_tokens} prompt + #{cache_creation_tokens.to_i} cache-write + #{cache_read_tokens.to_i} cache-read input, #{completion_tokens} completion)")
|
|
cost
|
|
end
|
|
|
|
# Find pricing for a model, with prefix matching support
|
|
def self.find_pricing(provider, model)
|
|
return nil unless PRICING.key?(provider)
|
|
|
|
provider_pricing = PRICING[provider]
|
|
|
|
# Try exact match first
|
|
return provider_pricing[model] if provider_pricing.key?(model)
|
|
|
|
# Try prefix matching (e.g., "gpt-4.1-2024-08-06" matches "gpt-4.1")
|
|
provider_pricing.each do |model_prefix, pricing|
|
|
return pricing if model.start_with?(model_prefix)
|
|
end
|
|
|
|
nil
|
|
end
|
|
|
|
# Infer provider from model name by checking which provider has pricing for it
|
|
# Returns the provider name if found, or "openai" as default (for backward compatibility)
|
|
def self.infer_provider(model)
|
|
return "openai" if model.blank?
|
|
|
|
# Bedrock + Vertex prefix model IDs with "anthropic." regardless of
|
|
# whether the Claude family is in the local PRICING map. Attribute them
|
|
# to the Anthropic provider so cost-ledger filtering by provider is
|
|
# correct even when we can't compute a per-token rate (custom endpoints
|
|
# bill via their own provider, not Anthropic directly).
|
|
return "anthropic" if model.start_with?("anthropic.", "anthropic/")
|
|
|
|
# Check each provider to see if they have pricing for this model
|
|
PRICING.each do |provider_name, provider_pricing|
|
|
# Try exact match first
|
|
return provider_name if provider_pricing.key?(model)
|
|
|
|
# Try prefix matching
|
|
provider_pricing.each_key do |model_prefix|
|
|
return provider_name if model.start_with?(model_prefix)
|
|
end
|
|
end
|
|
|
|
# Default to "openai" if no pricing found (for custom/self-hosted models)
|
|
"openai"
|
|
end
|
|
|
|
# Aggregate statistics for a family
|
|
def self.statistics_for_family(family, start_date: nil, end_date: nil)
|
|
scope = for_family(family)
|
|
scope = scope.for_date_range(start_date, end_date) if start_date && end_date
|
|
|
|
# Exclude records with nil cost from cost calculations
|
|
scope_with_cost = scope.where.not(estimated_cost: nil)
|
|
|
|
requests_with_cost = scope_with_cost.count
|
|
total_cost = scope_with_cost.sum(:estimated_cost).to_f.round(2)
|
|
avg_cost = requests_with_cost > 0 ? (total_cost / requests_with_cost).round(4) : 0.0
|
|
|
|
{
|
|
total_requests: scope.count,
|
|
requests_with_cost: requests_with_cost,
|
|
total_prompt_tokens: scope.sum(:prompt_tokens),
|
|
total_completion_tokens: scope.sum(:completion_tokens),
|
|
total_tokens: scope.sum(:total_tokens),
|
|
total_cost: total_cost,
|
|
avg_cost: avg_cost,
|
|
by_operation: scope_with_cost.group(:operation).sum(:estimated_cost).transform_values { |v| v.to_f.round(2) },
|
|
by_model: scope_with_cost.group(:model).sum(:estimated_cost).transform_values { |v| v.to_f.round(2) }
|
|
}
|
|
end
|
|
|
|
# Format cost as currency
|
|
def formatted_cost
|
|
estimated_cost.nil? ? "N/A" : "$#{estimated_cost.round(4)}"
|
|
end
|
|
|
|
# Check if this usage record represents a failed API call
|
|
def failed?
|
|
metadata.present? && metadata["error"].present?
|
|
end
|
|
|
|
# Get the HTTP status code from metadata
|
|
def http_status_code
|
|
metadata&.dig("http_status_code")
|
|
end
|
|
|
|
# Get the error message from metadata
|
|
def error_message
|
|
metadata&.dig("error")
|
|
end
|
|
|
|
# Estimate cost for auto-categorizing a batch of transactions
|
|
# Based on typical token usage patterns:
|
|
# - ~100 tokens per transaction in the prompt
|
|
# - ~50 tokens per category
|
|
# - ~50 tokens for completion per transaction
|
|
# Returns nil if pricing is not available for the model
|
|
def self.estimate_auto_categorize_cost(transaction_count:, category_count:, model: "gpt-4.1")
|
|
return 0.0 if transaction_count.zero?
|
|
|
|
# Estimate tokens
|
|
base_prompt_tokens = 150 # System message and instructions
|
|
transaction_tokens = transaction_count * 100
|
|
category_tokens = category_count * 50
|
|
estimated_prompt_tokens = base_prompt_tokens + transaction_tokens + category_tokens
|
|
|
|
# Completion tokens: roughly one category name per transaction
|
|
estimated_completion_tokens = transaction_count * 50
|
|
|
|
# calculate_cost will automatically infer the provider from the model
|
|
# Returns nil if pricing is not available
|
|
calculate_cost(
|
|
model: model,
|
|
prompt_tokens: estimated_prompt_tokens,
|
|
completion_tokens: estimated_completion_tokens
|
|
)
|
|
end
|
|
end
|