Class: LMUsage

Token and timing usage for one LM request (dspy.LMUsage).

 classDiagram
    class LMUsage
    click LMUsage href "../LMUsage/"
      LMUsage : cache_read_tokens

      LMUsage : cache_write_tokens

      LMUsage : completion_tokens

      LMUsage : input_audio_tokens

      LMUsage : input_tokens

      LMUsage : metadata





        LMUsage --> "0..1" Any : metadata
        click Any href "../Any/"



      LMUsage : output_audio_tokens

      LMUsage : output_tokens

      LMUsage : prompt_tokens

      LMUsage : reasoning_tokens

      LMUsage : total_tokens

Slots

Name	Cardinality and Range	Description	Inheritance
input_tokens	0..1 Integer		direct
output_tokens	0..1 Integer		direct
total_tokens	0..1 Integer		direct
prompt_tokens	0..1 Integer		direct
completion_tokens	0..1 Integer		direct
reasoning_tokens	0..1 Integer		direct
cache_read_tokens	0..1 Integer		direct
cache_write_tokens	0..1 Integer		direct
input_audio_tokens	0..1 Integer		direct
output_audio_tokens	0..1 Integer		direct
metadata	0..1 Any	Opaque key/value metadata passed alongside an object	direct

Usages

used by	used in	type	used
Prediction	lm_usage	range	LMUsage
LMResponse	usage	range	LMUsage
EvaluationResult	lm_usage	range	LMUsage

In Subsets

LmContract

Identifier and Mapping Information

Schema Source

from schema: https://w3id.org/lmodel/dspy

Mappings

Mapping Type	Mapped Value
self	dspy:LMUsage
native	dspy:LMUsage
related	uco_core:ConfidenceFacet

LinkML Source

Direct

name: LMUsage
description: Token and timing usage for one LM request (``dspy.LMUsage``).
in_subset:
- lm_contract
from_schema: https://w3id.org/lmodel/dspy
related_mappings:
- uco_core:ConfidenceFacet
slots:
- input_tokens
- output_tokens
- total_tokens
- prompt_tokens
- completion_tokens
- reasoning_tokens
- cache_read_tokens
- cache_write_tokens
- input_audio_tokens
- output_audio_tokens
- metadata

Induced

name: LMUsage
description: Token and timing usage for one LM request (``dspy.LMUsage``).
in_subset:
- lm_contract
from_schema: https://w3id.org/lmodel/dspy
related_mappings:
- uco_core:ConfidenceFacet
attributes:
  input_tokens:
    name: input_tokens
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMUsage
    domain_of:
    - LMUsage
    range: integer
    minimum_value: 0
  output_tokens:
    name: output_tokens
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMUsage
    domain_of:
    - LMUsage
    range: integer
    minimum_value: 0
  total_tokens:
    name: total_tokens
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMUsage
    domain_of:
    - LMUsage
    range: integer
    minimum_value: 0
  prompt_tokens:
    name: prompt_tokens
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMUsage
    domain_of:
    - LMUsage
    range: integer
    minimum_value: 0
  completion_tokens:
    name: completion_tokens
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMUsage
    domain_of:
    - LMUsage
    range: integer
    minimum_value: 0
  reasoning_tokens:
    name: reasoning_tokens
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMUsage
    domain_of:
    - LMUsage
    range: integer
    minimum_value: 0
  cache_read_tokens:
    name: cache_read_tokens
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMUsage
    domain_of:
    - LMUsage
    range: integer
    minimum_value: 0
  cache_write_tokens:
    name: cache_write_tokens
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMUsage
    domain_of:
    - LMUsage
    range: integer
    minimum_value: 0
  input_audio_tokens:
    name: input_audio_tokens
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMUsage
    domain_of:
    - LMUsage
    range: integer
    minimum_value: 0
  output_audio_tokens:
    name: output_audio_tokens
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMUsage
    domain_of:
    - LMUsage
    range: integer
    minimum_value: 0
  metadata:
    name: metadata
    description: Opaque key/value metadata passed alongside an object.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMUsage
    domain_of:
    - ToolResult
    - Citation
    - LMPart
    - LMMessage
    - LMToolSpec
    - LMRequest
    - LMUsage
    - LMOutput
    - LMResponse
    range: Any