Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

Transações

Configure o registro de transações para uso de tokens no LibreChat

Visão geral

O objeto transactions controla se os registros de uso de tokens são salvos no banco de dados no LibreChat. Isso permite que os administradores ativem ou desativem o rastreamento de transações independentemente do sistema de saldo.

Campos em transactions:

  • enabled

Notas:

  • O registro de transações é essencial para rastrear o uso histórico de tokens
  • Quando balance.enabled estiver definido como true, as transações são habilitadas automaticamente, independentemente desta configuração.
  • O valor padrão é true para garantir que o uso de tokens seja rastreado por padrão
  • Desativar transações pode reduzir os requisitos de armazenamento do banco de dados, mas impedirá a análise do uso histórico.

Exemplo

transactions:
  enabled: false

enabled

Chave:

KeyTypeDescriptionExample
enabledBooleanControla se os registros de transação devem ser salvos no banco de dados.Default: true. Set to false to disable transaction recording (unless balance.enabled is true).

Descrição:

O campo enabled determina se o LibreChat salva registros detalhados de transações para cada evento de uso de tokens. Esses registros incluem:

  • Contagens de tokens para prompts e completions
  • Custos e taxas associados
  • Identificadores de usuário e conversa
  • Carimbos de data/hora para cada transação

Comportamento Importante:

Quando o sistema de saldo está habilitado (balance.enabled: true), o registro de transações é ativado automaticamente, independentemente da configuração transactions.enabled. Isso garante que:

  1. Funções de rastreamento de saldo operam corretamente com uma trilha de auditoria completa
  2. O uso de tokens pode ser calculado com precisão e deduzido dos saldos dos usuários
  3. Dados históricos estão disponíveis para reconciliação de saldo

Casos de uso:

  • Enable transactions (true): Quando você precisar rastrear padrões de uso, gerar relatórios ou manter uma trilha de auditoria
  • Disable transactions (false): Quando você deseja reduzir o armazenamento do banco de dados e não precisa de dados históricos de uso (funciona apenas quando o rastreamento de saldo também está desativado)

Relação com o Balance System

Os sistemas de transações e saldo funcionam em conjunto:

# When balance is enabled, transactions are always enabled
balance:
  enabled: true
  startBalance: 20000

transactions:
  enabled: false  # This will be overridden to true because balance.enabled is true
# Track transactions without balance management
balance:
  enabled: false

transactions:
  enabled: true  # Records all token usage without enforcing balance limits

Impacto no Banco de Dados

Quando as transações estão habilitadas, cada chamada de API que consome tokens cria um registro na coleção "Transactions" com as seguintes informações:

  • ID de usuário e e-mail
  • ID da Conversa
  • Modelo usado
  • Contagens de tokens (prompt e conclusão)
  • Valores e taxas de tokens
  • Carimbo de data/hora
  • Tipo de transação (crédito ou débito)

Considere as implicações de armazenamento ao habilitar transações para implantações de alto volume.

Como está este guia?