Skip to main content

Python client and SDK for moorcheh-edge — on-device vector search

Project description

moorcheh-edge

Python package and CLI for running moorcheh-edge locally and calling its API.

  • CLI: moorcheh-edge
  • Package: moorcheh-edge
  • Python import: moorcheh_edge

Requires Docker (Docker Desktop or Docker Engine).

Install

pip install moorcheh-edge

For local development:

pip install -e .

Quick start

Start the local edge runtime:

moorcheh-edge up

Default API:

http://localhost:8080

Default data directory:

~/.moorcheh-edge/data

Check health/status:

moorcheh-edge status

Stop the runtime:

moorcheh-edge down

Commands

  • moorcheh-edge up
  • moorcheh-edge down
  • moorcheh-edge status
  • moorcheh-edge upload-vectors --vectors-file payload.json
  • moorcheh-edge search --query-vector-json "[...]" --top-k 5
  • moorcheh-edge delete --ids-json "[\"item-1\"]"

All API commands accept --base-url, for example:

moorcheh-edge status --base-url http://localhost:8081
moorcheh-edge upload-vectors --base-url http://localhost:8081 --vectors-file payload.json

Examples

Upload vectors from a JSON file:

{
  "vectors": [
    {
      "id": "item-1",
      "vector": [0.01, -0.02, "... 1024 floats total ..."]
    }
  ]
}
moorcheh-edge upload-vectors --vectors-file payload.json

Search with a vector query:

moorcheh-edge search --query-vector-json "[0.1, 0.2, ... 1024 floats total ...]" --top-k 5

Delete items:

moorcheh-edge delete --ids-json "[\"item-1\",\"item-2\"]"

Notes

  • moorcheh-edge is vector-only
  • vectors must be length 1024
  • the edge server has a hardcoded 10,000 item cap
  • the client intentionally does not expose custom data-dir or quota settings
  • up exposes only --server-image and --server-port

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

moorcheh_edge-0.1.1.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

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

moorcheh_edge-0.1.1-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: moorcheh_edge-0.1.1.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for moorcheh_edge-0.1.1.tar.gz
Algorithm Hash digest
SHA256 366897a71b53346c5350cca007686877806b0f8b725c2d247a650c992105ccc3
MD5 eff4d1c0c7a87c46ac43bbf15ddc9293
BLAKE2b-256 7d19b9cef91c7570f4e9000b9cf2c1be910086f4a2f086ba2bf18d3c2330c534

See more details on using hashes here.

File details

Details for the file moorcheh_edge-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: moorcheh_edge-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 16.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for moorcheh_edge-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0f7b7a7b26faea09a691ea0e338bae644268734803dbc50a0414648a02925734
MD5 9588543104e0810077431a63a14b5235
BLAKE2b-256 fe391e28c6fda8b5942ac3c0ee728b3817713206a1d23c8cf220f98e3b9a3ee9

See more details on using hashes here.

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