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.0.tar.gz (12.4 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.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: moorcheh_edge-0.1.0.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.6

File hashes

Hashes for moorcheh_edge-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c940bf2359cdb34fc04e075a270535e9fcfde595f26e04b2b8463639c5594ee0
MD5 8ce5a4d1f2e121b27d54d9116449cf87
BLAKE2b-256 ba369632573834ec88a43e9fd33fc549a5de15c1b8cdbc77314a696c66aad044

See more details on using hashes here.

File details

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

File metadata

  • Download URL: moorcheh_edge-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.6

File hashes

Hashes for moorcheh_edge-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2393914b6701333f9acf38d29d288c27a6a43c2a27ab7eb339a42ba8cda4e0cf
MD5 f9be9fae8a27f3a0ef4818f1a97e1fd7
BLAKE2b-256 be822f15c49828d342c4314518dd6ca9431b541042089616d80867aa79b1366a

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