Skip to content

Class: Document

Citation-enabled document content (dspy.adapters.types.document.Document).

URI: dspy:Document

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

      Document : citations





        Document --> "*" LMCitationPart : citations
        click LMCitationPart href "../LMCitationPart/"



      Document : context

      Document : data

      Document : description

      Document : file_id

      Document : id

      Document : mimetype

      Document : name

      Document : path

      Document : title

      Document : url

Inheritance

Slots

Name Cardinality and Range Description Inheritance
data 0..1
String		 Base64-encoded inline payload direct
mimetype 0..1
MimeType		 IANA media type for the payload direct
url 0..1
String		 URL pointing at a remote payload direct
file_id 0..1
Identifier		 Provider-side file identifier for an uploaded asset direct
path 0..1
String		 Local filesystem path to a payload direct
title 0..1
String		 Human-readable title or display name direct
context 0..1
String		 Additional context attached to a document direct
citations *
LMCitationPart		 Citations returned by the model 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/document.py']
dspy_source_urls ['https://github.com/stanfordnlp/dspy/blob/main/dspy/adapters/types/document.py']

Schema Source

Mappings

Mapping Type Mapped Value
self dspy:Document
native dspy:Document
broad nexus:Modality

LinkML Source

Direct

name: Document
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/adapters/types/document.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/adapters/types/document.py
description: Citation-enabled document content (``dspy.adapters.types.document.Document``).
in_subset:
- custom_types
from_schema: https://w3id.org/lmodel/dspy
broad_mappings:
- nexus:Modality
is_a: Type
slots:
- data
- mimetype
- url
- file_id
- path
- title
- context
- citations

Induced

name: Document
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/adapters/types/document.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/adapters/types/document.py
description: Citation-enabled document content (``dspy.adapters.types.document.Document``).
in_subset:
- custom_types
from_schema: https://w3id.org/lmodel/dspy
broad_mappings:
- nexus:Modality
is_a: Type
attributes:
  data:
    name: data
    description: Base64-encoded inline payload.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Document
    domain_of:
    - Audio
    - File
    - Document
    - LMSourcePart
    - LMDocumentPart
    range: string
  mimetype:
    name: mimetype
    description: IANA media type for the payload.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Document
    domain_of:
    - Audio
    - File
    - Document
    - LMSourcePart
    - LMDocumentPart
    range: MimeType
  url:
    name: url
    description: URL pointing at a remote payload.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    slot_uri: schema:url
    owner: Document
    domain_of:
    - Image
    - Audio
    - File
    - Citation
    - Document
    - LMSourcePart
    - LMDocumentPart
    - LMCitationPart
    range: string
  file_id:
    name: file_id
    description: Provider-side file identifier for an uploaded asset.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Document
    domain_of:
    - Document
    - LMSourcePart
    - LMDocumentPart
    range: Identifier
  path:
    name: path
    description: Local filesystem path to a payload.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Document
    domain_of:
    - Document
    - LMSourcePart
    - LMDocumentPart
    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: Document
    domain_of:
    - Citation
    - Document
    - LMDocumentPart
    - LMCitationPart
    range: string
  context:
    name: context
    description: Additional context attached to a document.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Document
    domain_of:
    - Document
    - LMDocumentPart
    range: string
  citations:
    name: citations
    description: Citations returned by the model.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Document
    domain_of:
    - Document
    - LMDocumentPart
    range: LMCitationPart
    multivalued: true
    inlined: true
    inlined_as_list: 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: Document
    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: Document
    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: Document
    domain_of:
    - NamedThing
    - LMToolSpec
    range: string