Skip to content

Class: File

Arbitrary file payload (dspy.File).

URI: dspy:File

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

      File : data

      File : description

      File : filename

      File : id

      File : mimetype

      File : name

      File : 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
filename 0..1
String
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/file.py']
dspy_source_urls ['https://github.com/stanfordnlp/dspy/blob/main/dspy/adapters/types/file.py']

Schema Source

Mappings

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

LinkML Source

Direct

name: File
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/adapters/types/file.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/adapters/types/file.py
description: Arbitrary file payload (``dspy.File``).
in_subset:
- custom_types
from_schema: https://w3id.org/lmodel/dspy
is_a: Type
slots:
- data
- mimetype
- url
- filename

Induced

name: File
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/adapters/types/file.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/adapters/types/file.py
description: Arbitrary file payload (``dspy.File``).
in_subset:
- custom_types
from_schema: https://w3id.org/lmodel/dspy
is_a: Type
attributes:
  data:
    name: data
    description: Base64-encoded inline payload.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: File
    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: File
    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: File
    domain_of:
    - Image
    - Audio
    - File
    - Citation
    - Document
    - LMSourcePart
    - LMDocumentPart
    - LMCitationPart
    range: string
  filename:
    name: filename
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: File
    domain_of:
    - File
    - LMBinaryPart
    range: string
  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: File
    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: File
    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: File
    domain_of:
    - NamedThing
    - LMToolSpec
    range: string