Skip to content

Class: Citation

A single citation entry (dspy.experimental.Citations element).

URI: dspy:Citation

 classDiagram
    class Citation
    click Citation href "../Citation/"
      Type <|-- Citation
        click Type href "../Type/"

      Citation : description

      Citation : id

      Citation : metadata





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



      Citation : name

      Citation : text

      Citation : title

      Citation : url

Inheritance

Slots

Name Cardinality and Range Description Inheritance
text 0..1
String
Plain-text payload direct
title 0..1
String
Human-readable title or display name direct
url 0..1
String
URL pointing at a remote payload direct
metadata 0..1
Any
Opaque key/value metadata passed alongside an object 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

In Subsets

Identifier and Mapping Information

Annotations

property value
dspy_source_paths ['dspy/adapters/types/citation.py']
dspy_source_urls ['https://github.com/stanfordnlp/dspy/blob/main/dspy/adapters/types/citation.py']

Schema Source

Mappings

Mapping Type Mapped Value
self dspy:Citation
native dspy:Citation
close nexus:Documentation, uco_core:ExternalReference

LinkML Source

Direct

name: Citation
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/adapters/types/citation.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/adapters/types/citation.py
description: A single citation entry (``dspy.experimental.Citations`` element).
in_subset:
- custom_types
from_schema: https://w3id.org/lmodel/dspy
close_mappings:
- nexus:Documentation
- uco_core:ExternalReference
is_a: Type
slots:
- text
- title
- url
- metadata

Induced

name: Citation
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/adapters/types/citation.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/adapters/types/citation.py
description: A single citation entry (``dspy.experimental.Citations`` element).
in_subset:
- custom_types
from_schema: https://w3id.org/lmodel/dspy
close_mappings:
- nexus:Documentation
- uco_core:ExternalReference
is_a: Type
attributes:
  text:
    name: text
    description: Plain-text payload.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Citation
    domain_of:
    - Reasoning
    - Citation
    - LMTextPart
    - LMThinkingPart
    - LMCitationPart
    - LMRefusalPart
    range: string
  title:
    name: title
    description: Human-readable title or display name.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    slot_uri: dct:title
    owner: Citation
    domain_of:
    - Citation
    - Document
    - LMDocumentPart
    - LMCitationPart
    range: string
  url:
    name: url
    description: URL pointing at a remote payload.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    slot_uri: schema:url
    owner: Citation
    domain_of:
    - Image
    - Audio
    - File
    - Citation
    - Document
    - LMSourcePart
    - LMDocumentPart
    - LMCitationPart
    range: string
  metadata:
    name: metadata
    description: Opaque key/value metadata passed alongside an object.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Citation
    domain_of:
    - ToolResult
    - Citation
    - LMPart
    - LMMessage
    - LMToolSpec
    - LMRequest
    - LMUsage
    - LMOutput
    - LMResponse
    range: Any
  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: Citation
    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: Citation
    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: Citation
    domain_of:
    - NamedThing
    - LMToolSpec
    range: string