Skip to content

Class: LMOutput

One generated candidate inside an LMResponse.

URI: dspy:LMOutput

 classDiagram
    class LMOutput
    click LMOutput href "../LMOutput/"
      LMOutput : finish_reason





        LMOutput --> "0..1" FinishReason : finish_reason
        click FinishReason href "../FinishReason/"



      LMOutput : logprobs





        LMOutput --> "0..1" Any : logprobs
        click Any href "../Any/"



      LMOutput : metadata





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



      LMOutput : parts





        LMOutput --> "1..*" LMPart : parts
        click LMPart href "../LMPart/"



      LMOutput : provider_data





        LMOutput --> "0..1" Any : provider_data
        click Any href "../Any/"



      LMOutput : truncated

Slots

Name Cardinality and Range Description Inheritance
parts 1..*
LMPart
Ordered content parts of an LM message or output direct
finish_reason 0..1
FinishReason
Why the model stopped generating this candidate direct
truncated 0..1
Boolean
Whether the model output was truncated direct
logprobs 0..1
Any
Token log-probability payload as returned by the provider direct
provider_data 0..1
Any
Provider-specific raw payload preserved with a normalized object direct
metadata 0..1
Any
Opaque key/value metadata passed alongside an object direct

Usages

used by used in type used
LMResponse outputs range LMOutput

In Subsets

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self dspy:LMOutput
native dspy:LMOutput

LinkML Source

Direct

name: LMOutput
description: One generated candidate inside an ``LMResponse``.
in_subset:
- lm_contract
from_schema: https://w3id.org/lmodel/dspy
slots:
- parts
- finish_reason
- truncated
- logprobs
- provider_data
- metadata

Induced

name: LMOutput
description: One generated candidate inside an ``LMResponse``.
in_subset:
- lm_contract
from_schema: https://w3id.org/lmodel/dspy
attributes:
  parts:
    name: parts
    description: Ordered content parts of an LM message or output.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMOutput
    domain_of:
    - LMMessage
    - LMOutput
    range: LMPart
    required: true
    multivalued: true
    inlined: true
    inlined_as_list: true
  finish_reason:
    name: finish_reason
    description: Why the model stopped generating this candidate.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMOutput
    domain_of:
    - LMOutput
    range: FinishReason
  truncated:
    name: truncated
    description: Whether the model output was truncated.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    ifabsent: boolean(False)
    owner: LMOutput
    domain_of:
    - LMOutput
    range: boolean
  logprobs:
    name: logprobs
    description: Token log-probability payload as returned by the provider.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMOutput
    domain_of:
    - LMOutput
    range: Any
  provider_data:
    name: provider_data
    description: Provider-specific raw payload preserved with a normalized object.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMOutput
    domain_of:
    - ToolResult
    - LMToolCallPart
    - LMToolResultPart
    - LMToolSpec
    - LMOutput
    - LMResponse
    range: Any
  metadata:
    name: metadata
    description: Opaque key/value metadata passed alongside an object.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMOutput
    domain_of:
    - ToolResult
    - Citation
    - LMPart
    - LMMessage
    - LMToolSpec
    - LMRequest
    - LMUsage
    - LMOutput
    - LMResponse
    range: Any