Skip to content

Class: Embedder

Text embedding model (dspy.Embedder).

URI: dspy:Embedder

 classDiagram
    class Embedder
    click Embedder href "../Embedder/"
      NamedThing <|-- Embedder
        click NamedThing href "../NamedThing/"

      Embedder : batch_size

      Embedder : caching

      Embedder : default_kwargs





        Embedder --> "0..1" Any : default_kwargs
        click Any href "../Any/"



      Embedder : description

      Embedder : embedding_model

      Embedder : id

      Embedder : name

Inheritance

Slots

Name Cardinality and Range Description Inheritance
embedding_model 0..1
String		 Embedding model identifier (LiteLLM name or callable path) direct
batch_size 0..1
Integer		 direct
caching 0..1
Boolean		 direct
default_kwargs 0..1
Any		 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

Usages

used by used in type used
KNN embedder range Embedder
KNNFewShot embedder range Embedder
Embeddings embedder range Embedder
EmbeddingsWithScores embedder range Embedder

In Subsets

Aliases

  • embedding_model
  • vectorizer

Identifier and Mapping Information

Annotations

property value
dspy_source_paths ['dspy/clients/embedding.py']
dspy_source_urls ['https://github.com/stanfordnlp/dspy/blob/main/dspy/clients/embedding.py']

Schema Source

Mappings

Mapping Type Mapped Value
self dspy:Embedder
native dspy:Embedder
related iso42001:DataResourceCategory
close iso22989:NLPComponentType

LinkML Source

Direct

name: Embedder
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/clients/embedding.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/clients/embedding.py
description: Text embedding model (``dspy.Embedder``).
in_subset:
- clients
from_schema: https://w3id.org/lmodel/dspy
aliases:
- embedding_model
- vectorizer
close_mappings:
- iso22989:NLPComponentType
related_mappings:
- iso42001:DataResourceCategory
is_a: NamedThing
slots:
- embedding_model
- batch_size
- caching
- default_kwargs

Induced

name: Embedder
annotations:
  dspy_source_paths:
    tag: dspy_source_paths
    value:
    - dspy/clients/embedding.py
  dspy_source_urls:
    tag: dspy_source_urls
    value:
    - https://github.com/stanfordnlp/dspy/blob/main/dspy/clients/embedding.py
description: Text embedding model (``dspy.Embedder``).
in_subset:
- clients
from_schema: https://w3id.org/lmodel/dspy
aliases:
- embedding_model
- vectorizer
close_mappings:
- iso22989:NLPComponentType
related_mappings:
- iso42001:DataResourceCategory
is_a: NamedThing
attributes:
  embedding_model:
    name: embedding_model
    description: Embedding model identifier (LiteLLM name or callable path).
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Embedder
    domain_of:
    - Embedder
    range: string
  batch_size:
    name: batch_size
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    ifabsent: int(200)
    owner: Embedder
    domain_of:
    - Embedder
    range: integer
    minimum_value: 1
  caching:
    name: caching
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    ifabsent: boolean(True)
    owner: Embedder
    domain_of:
    - Embedder
    range: boolean
  default_kwargs:
    name: default_kwargs
    from_schema: https://w3id.org/lmodel/dspy
    rank: 1000
    owner: Embedder
    domain_of:
    - Embedder
    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: Embedder
    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: Embedder
    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: Embedder
    domain_of:
    - NamedThing
    - LMToolSpec
    range: string