Function withHeliconeLogging

Parameters

• agentName: string

  Name of the agent for logging purposes
• payloadConfig: HeliconePayloadConfig

  Configuration for the Helicone payload
• operation: (() => Promise<TInternal>)

  The async operation to execute (returns internal result with extra data)

  • • (): Promise<TInternal>

    • Returns Promise<TInternal>

• resultExtractor: ((internalResult) => TExtracted)

  Function to extract the user-facing result from internal result

  • • (internalResult): TExtracted

    • Parameters

      • internalResult: TInternal

      Returns TExtracted

• usageCalculator: ((internalResult) => {
      completion_tokens: number;
      completion_tokens_details?: {
          accepted_prediction_tokens: number;
          audio_tokens: number;
          reasoning_tokens: number;
          rejected_prediction_tokens: number;
      };
      prompt_tokens: number;
      prompt_tokens_details?: {
          audio_tokens: number;
          cached_tokens: number;
      };
      total_tokens: number;
  })

  Function to calculate usage metrics from the internal result

  • • (internalResult): {
          completion_tokens: number;
          completion_tokens_details?: {
              accepted_prediction_tokens: number;
              audio_tokens: number;
              reasoning_tokens: number;
              rejected_prediction_tokens: number;
          };
          prompt_tokens: number;
          prompt_tokens_details?: {
              audio_tokens: number;
              cached_tokens: number;
          };
          total_tokens: number;
      }

    • Parameters

      • internalResult: TInternal

      Returns {
          completion_tokens: number;
          completion_tokens_details?: {
              accepted_prediction_tokens: number;
              audio_tokens: number;
              reasoning_tokens: number;
              rejected_prediction_tokens: number;
          };
          prompt_tokens: number;
          prompt_tokens_details?: {
              audio_tokens: number;
              cached_tokens: number;
          };
          total_tokens: number;
      }

      • completion_tokens: number

      • Optional completion_tokens_details?: {
            accepted_prediction_tokens: number;
            audio_tokens: number;
            reasoning_tokens: number;
            rejected_prediction_tokens: number;
        }

        • accepted_prediction_tokens: number

        • audio_tokens: number

        • reasoning_tokens: number

        • rejected_prediction_tokens: number

      • prompt_tokens: number

      • Optional prompt_tokens_details?: {
            audio_tokens: number;
            cached_tokens: number;
        }

        • audio_tokens: number

        • cached_tokens: number

      • total_tokens: number

• responseIdPrefix: string

  Prefix for the response ID
• heliconeApiKey: string

  The Helicone API key for logging
• heliconeManualLoggingUrl: string

  The Helicone manual logging endpoint URL
• accountAddress: string

  The account address for logging purposes
• customProperties: CustomProperties

  Custom properties to add as Helicone headers (should include agentid and sessionid)