Skip to content

Class: LMDocumentPart

Semantic source/document content, optionally citation-enabled.

URI: dspy:LMDocumentPart

 classDiagram
    class LMDocumentPart
    click LMDocumentPart href "../LMDocumentPart/"
      LMPart <|-- LMDocumentPart
        click LMPart href "../LMPart/"

      LMDocumentPart : citations





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



      LMDocumentPart : context

      LMDocumentPart : data

      LMDocumentPart : file_id

      LMDocumentPart : metadata





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



      LMDocumentPart : mimetype

      LMDocumentPart : part_type

      LMDocumentPart : path

      LMDocumentPart : source





        LMDocumentPart --> "0..1" Any : source
        click Any href "../Any/"



      LMDocumentPart : title

      LMDocumentPart : url

Inheritance

Slots

Name Cardinality and Range Description Inheritance
mimetype 0..1
MimeType
IANA media type for the payload direct
data 0..1
String
Base64-encoded inline 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
source 0..1
Any
Document source payload direct
citations *
LMCitationPart
Citations returned by the model direct
title 0..1
String
Human-readable title or display name direct
context 0..1
String
Additional context attached to a document direct
metadata 0..1
Any
Opaque key/value metadata passed alongside an object LMPart
part_type 1
String
Discriminator for the LMPart subclass LMPart

In Subsets

Identifier and Mapping Information

Schema Source

Mappings

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

LinkML Source

Direct

name: LMDocumentPart
description: Semantic source/document content, optionally citation-enabled.
in_subset:
- lm_contract
from_schema: https://w3id.org/lmodel/dspy
is_a: LMPart
slots:
- mimetype
- data
- url
- file_id
- path
- source
- citations
- title
- context
slot_usage:
  part_type:
    name: part_type
    ifabsent: string(document)
    equals_string: document
  mimetype:
    name: mimetype
    ifabsent: string(application/pdf)

Induced

name: LMDocumentPart
description: Semantic source/document content, optionally citation-enabled.
in_subset:
- lm_contract
from_schema: https://w3id.org/lmodel/dspy
is_a: LMPart
slot_usage:
  part_type:
    name: part_type
    ifabsent: string(document)
    equals_string: document
  mimetype:
    name: mimetype
    ifabsent: string(application/pdf)
attributes:
  mimetype:
    name: mimetype
    description: IANA media type for the payload.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    ifabsent: string(application/pdf)
    owner: LMDocumentPart
    domain_of:
    - Audio
    - File
    - Document
    - LMSourcePart
    - LMDocumentPart
    range: MimeType
  data:
    name: data
    description: Base64-encoded inline payload.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMDocumentPart
    domain_of:
    - Audio
    - File
    - Document
    - LMSourcePart
    - LMDocumentPart
    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: LMDocumentPart
    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: LMDocumentPart
    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: LMDocumentPart
    domain_of:
    - Document
    - LMSourcePart
    - LMDocumentPart
    range: string
  source:
    name: source
    description: Document source payload.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMDocumentPart
    domain_of:
    - LMDocumentPart
    range: Any
  citations:
    name: citations
    description: Citations returned by the model.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMDocumentPart
    domain_of:
    - Document
    - LMDocumentPart
    range: LMCitationPart
    multivalued: true
    inlined: true
    inlined_as_list: true
  title:
    name: title
    description: Human-readable title or display name.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    slot_uri: dct:title
    owner: LMDocumentPart
    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: LMDocumentPart
    domain_of:
    - Document
    - LMDocumentPart
    range: string
  metadata:
    name: metadata
    description: Opaque key/value metadata passed alongside an object.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: LMDocumentPart
    domain_of:
    - ToolResult
    - Citation
    - LMPart
    - LMMessage
    - LMToolSpec
    - LMRequest
    - LMUsage
    - LMOutput
    - LMResponse
    range: Any
  part_type:
    name: part_type
    description: Discriminator for the LMPart subclass. One of the ``LMPartType``
      permissible values.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    ifabsent: string(document)
    owner: LMDocumentPart
    domain_of:
    - LMPart
    range: string
    required: true
    equals_string: document