Class: Completions

Container of candidate completions associated with a Prediction (dspy.Completions).

 classDiagram
    class Completions
    click Completions href "../Completions/"
      NamedThing <|-- Completions
        click NamedThing href "../NamedThing/"

      Completions : candidates





        Completions --> "*" Example : candidates
        click Example href "../Example/"



      Completions : description

      Completions : id

      Completions : name

      Completions : signature





        Completions --> "0..1" Signature : signature
        click Signature href "../Signature/"

Inheritance

NamedThing
- Completions

Slots

Name	Cardinality and Range	Description	Inheritance
signature	0..1 Signature	Signature attached to a predictor	direct
candidates	* Example	Per-candidate field assignments	direct
id	1 Identifier	Stable opaque identifier for an instance	NamedThing
name	0..1 String	Short human-readable name	NamedThing
description	0..1 String	Free-form description	NamedThing

Usages

used by	used in	type	used
Prediction	completions	range	Completions
EvaluationResult	completions	range	Completions

In Subsets

Core

Identifier and Mapping Information

Annotations

property	value
dspy_source_paths	['dspy/primitives/prediction.py']
dspy_source_urls	['https://github.com/stanfordnlp/dspy/blob/main/dspy/primitives/prediction.py']

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Completions
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/primitives/prediction.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/primitives/prediction.py
description: Container of candidate completions associated with a Prediction (``dspy.Completions``).
in_subset:
- core
from_schema: https://w3id.org/lmodel/dspy
is_a: NamedThing
slots:
- signature
attributes:
  candidates:
    name: candidates
    description: Per-candidate field assignments.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    domain_of:
    - Completions
    range: Example
    multivalued: true
    inlined: true
    inlined_as_list: true

Induced

name: Completions
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/primitives/prediction.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/primitives/prediction.py
description: Container of candidate completions associated with a Prediction (``dspy.Completions``).
in_subset:
- core
from_schema: https://w3id.org/lmodel/dspy
is_a: NamedThing
attributes:
  candidates:
    name: candidates
    description: Per-candidate field assignments.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Completions
    domain_of:
    - Completions
    range: Example
    multivalued: true
    inlined: true
    inlined_as_list: true
  signature:
    name: signature
    description: Signature attached to a predictor.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Completions
    domain_of:
    - Completions
    - Predictor
    range: Signature
    inlined: true
  id:
    name: id
    description: Stable opaque identifier for an instance.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    slot_uri: schema:identifier
    identifier: true
    owner: Completions
    domain_of:
    - NamedThing
    range: Identifier
    required: true
  name:
    name: name
    description: Short human-readable name.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    slot_uri: rdfs:label
    owner: Completions
    domain_of:
    - NamedThing
    - LMToolCallPart
    - LMMessage
    - LMToolSpec
    range: string
  description:
    name: description
    description: Free-form description.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    slot_uri: dct:description
    owner: Completions
    domain_of:
    - NamedThing
    - LMToolSpec
    range: string