Skip to content

Class: Embeddings

Embedding-based nearest-neighbour retriever (dspy.Embeddings).

URI: dspy:Embeddings

 classDiagram
    class Embeddings
    click Embeddings href "../Embeddings/"
      Retriever <|-- Embeddings
        click Retriever href "../Retriever/"


      Embeddings <|-- EmbeddingsWithScores
        click EmbeddingsWithScores href "../EmbeddingsWithScores/"


      Embeddings : callbacks

      Embeddings : compiled

      Embeddings : corpus

      Embeddings : description

      Embeddings : embedder





        Embeddings --> "0..1" Embedder : embedder
        click Embedder href "../Embedder/"



      Embeddings : history





        Embeddings --> "*" LMHistoryEntry : history
        click LMHistoryEntry href "../LMHistoryEntry/"



      Embeddings : id

      Embeddings : k

      Embeddings : name

      Embeddings : predictors





        Embeddings --> "*" Predictor : predictors
        click Predictor href "../Predictor/"



      Embeddings : sub_modules





        Embeddings --> "*" Module : sub_modules
        click Module href "../Module/"

Inheritance

Slots

Name Cardinality and Range Description Inheritance
embedder 0..1
Embedder		 direct
corpus *
String		 In-memory document corpus direct
k 0..1
Integer		 Top-k retrieval depth Retriever
compiled 0..1
Boolean		 Whether the module has been compiled by a teleprompter Module
callbacks *
String		 Dotted import paths of callbacks registered on the module Module
history *
LMHistoryEntry		 Per-module call history of LM requests / responses Module
predictors *
Predictor		 Predictor children of a composite Module (named_predictors()) Module
sub_modules *
Module		 Nested Module children of a composite Module Module
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/retrievers/embeddings.py']
dspy_source_urls ['https://github.com/stanfordnlp/dspy/blob/main/dspy/retrievers/embeddings.py']

Schema Source

Mappings

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

LinkML Source

Direct

name: Embeddings
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/retrievers/embeddings.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/retrievers/embeddings.py
description: Embedding-based nearest-neighbour retriever (``dspy.Embeddings``).
in_subset:
- retrievers
from_schema: https://w3id.org/lmodel/dspy
is_a: Retriever
slots:
- embedder
- corpus

Induced

name: Embeddings
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/retrievers/embeddings.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/retrievers/embeddings.py
description: Embedding-based nearest-neighbour retriever (``dspy.Embeddings``).
in_subset:
- retrievers
from_schema: https://w3id.org/lmodel/dspy
is_a: Retriever
attributes:
  embedder:
    name: embedder
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Embeddings
    domain_of:
    - KNN
    - KNNFewShot
    - Embeddings
    range: Embedder
    inlined: true
  corpus:
    name: corpus
    description: In-memory document corpus.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Embeddings
    domain_of:
    - Embeddings
    range: string
    multivalued: true
  k:
    name: k
    description: Top-k retrieval depth.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Embeddings
    domain_of:
    - Retriever
    range: integer
    minimum_value: 1
  compiled:
    name: compiled
    description: Whether the module has been compiled by a teleprompter.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    ifabsent: boolean(False)
    owner: Embeddings
    domain_of:
    - Module
    range: boolean
  callbacks:
    name: callbacks
    description: Dotted import paths of callbacks registered on the module.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Embeddings
    domain_of:
    - BaseLM
    - Adapter
    - Module
    - Settings
    range: string
    multivalued: true
  history:
    name: history
    description: Per-module call history of LM requests / responses.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Embeddings
    domain_of:
    - BaseLM
    - Module
    range: LMHistoryEntry
    multivalued: true
    inlined: true
    inlined_as_list: true
  predictors:
    name: predictors
    description: Predictor children of a composite Module (named_predictors()).
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Embeddings
    domain_of:
    - Module
    range: Predictor
    multivalued: true
    inlined: true
    inlined_as_list: true
  sub_modules:
    name: sub_modules
    description: Nested Module children of a composite Module.
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Embeddings
    domain_of:
    - Module
    range: Module
    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: Embeddings
    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: Embeddings
    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: Embeddings
    domain_of:
    - NamedThing
    - LMToolSpec
    range: string