Skip to main content

Abstraction layer for embeddings.

Project description

Modular, backend-agnostic interface for generating text embeddings. Provides a consistent Pythonic API for embedding text using various underlying providers.

Build Status Deploy Status Codecov Black code style License PyPi GitHub Pages

Key Features

  • Unified Embedding Interface: Use one client class for multiple backends.

  • Default OpenAI Support: Integrates seamlessly with OpenAI’s Embedding API.

  • Extensible Design: Easy to add new backends (e.g., Hugging Face).

Quick Start

  1. Install (using Make + Poetry):

    make install
  2. Set your environment variables (for example, OPENAI_API_KEY for OpenAI).

  3. Use the embedding client:

    from darca_embeddings import EmbeddingClient
    
    client = EmbeddingClient()
    embedding = client.get_embedding("Hello World!")
    print(embedding)

Documentation

We use Sphinx for building documentation. See docs/source/ for the reST files. You can build the docs locally by:

make docs

Contributing

Contributions are welcome! See the CONTRIBUTING.rst for more details.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Author

Roel Kist

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

darca_embeddings-0.1.0.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

darca_embeddings-0.1.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file darca_embeddings-0.1.0.tar.gz.

File metadata

  • Download URL: darca_embeddings-0.1.0.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for darca_embeddings-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9dab613cc9e3411400b5fc37f79bcb2c8e8c74ec3830c2d44a0e24e73b4806ef
MD5 a126ff59da1237b2c56784702910b7a2
BLAKE2b-256 d4a05be364e7ccc7640d6274c90ca9c5179ab0a8ee49ef74b55941c2744f49aa

See more details on using hashes here.

Provenance

The following attestation bundles were made for darca_embeddings-0.1.0.tar.gz:

Publisher: cd.yml on roelkist/darca-embeddings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file darca_embeddings-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for darca_embeddings-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 da41b4be57912693234ca75ed19742d2b5b04389051e629a3de5209d7ca2782d
MD5 d3bfb6ba4cd08be0dae85349e11fa1f9
BLAKE2b-256 e7d31c4054823edc33615bf4aca6c74aead57cf78b671017e6c575aa53c822f5

See more details on using hashes here.

Provenance

The following attestation bundles were made for darca_embeddings-0.1.0-py3-none-any.whl:

Publisher: cd.yml on roelkist/darca-embeddings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page