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.1.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.1-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: darca_embeddings-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 90ee2136799a3e437768b0dea70177cc63fb097d23977432e2e7c88b6f269391
MD5 70da3052dfcf8915c671ad90df11725f
BLAKE2b-256 4a56137ea4b46e97e8629a13167766b758277113a159480a9dfb61940bced8b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for darca_embeddings-0.1.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for darca_embeddings-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 528211fb801cf915aded891577d7d031abf842b4aa26828a384a79a981bd03f1
MD5 51dead2c77d357b3a4afc240e88f1e94
BLAKE2b-256 c2006dc2cab7cf4b58cbd6ba9005fa5d8991a1efaf2479b5475210902399bcbb

See more details on using hashes here.

Provenance

The following attestation bundles were made for darca_embeddings-0.1.1-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