Record Class TurLLMTokenUsageAPI.UsageReport

java.lang.Object
java.lang.Record
com.viglet.turing.api.llm.tokenusage.TurLLMTokenUsageAPI.UsageReport
Enclosing class:
TurLLMTokenUsageAPI
public static record TurLLMTokenUsageAPI.UsageReport(String periodStart, String periodEnd, List<TurLLMTokenUsageAPI.DailyUsageRow> daily, List<TurLLMTokenUsageAPI.MonthlySummaryRow> summary, long totalInputTokens, long totalOutputTokens, long totalTokens, long totalRequests) extends Record

  • Constructor Details

    • UsageReport

      public UsageReport(String periodStart, String periodEnd, List<TurLLMTokenUsageAPI.DailyUsageRow> daily, List<TurLLMTokenUsageAPI.MonthlySummaryRow> summary, long totalInputTokens, long totalOutputTokens, long totalTokens, long totalRequests)
      Creates an instance of a UsageReport record class.
      Parameters:
      periodStart - the value for the periodStart record component
      periodEnd - the value for the periodEnd record component
      daily - the value for the daily record component
      summary - the value for the summary record component
      totalInputTokens - the value for the totalInputTokens record component
      totalOutputTokens - the value for the totalOutputTokens record component
      totalTokens - the value for the totalTokens record component
      totalRequests - the value for the totalRequests record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • periodStart

      public String periodStart()
      Returns the value of the periodStart record component.
      Returns:
      the value of the periodStart record component

    • periodEnd

      public String periodEnd()
      Returns the value of the periodEnd record component.
      Returns:
      the value of the periodEnd record component

    • daily

      public List<TurLLMTokenUsageAPI.DailyUsageRow> daily()
      Returns the value of the daily record component.
      Returns:
      the value of the daily record component

    • summary

      public List<TurLLMTokenUsageAPI.MonthlySummaryRow> summary()
      Returns the value of the summary record component.
      Returns:
      the value of the summary record component

    • totalInputTokens

      public long totalInputTokens()
      Returns the value of the totalInputTokens record component.
      Returns:
      the value of the totalInputTokens record component

    • totalOutputTokens

      public long totalOutputTokens()
      Returns the value of the totalOutputTokens record component.
      Returns:
      the value of the totalOutputTokens record component

    • totalTokens

      public long totalTokens()
      Returns the value of the totalTokens record component.
      Returns:
      the value of the totalTokens record component

    • totalRequests

      public long totalRequests()
      Returns the value of the totalRequests record component.
      Returns:
      the value of the totalRequests record component