Skip to main content

client tool for raggify, a llama index based library for building multimodal RAG systems

Project description

Raggify Client

Tests codecov

Image

Raggify Client is a lightweight library that extracts only the REST API client portion from Raggify, a comprehensive library that includes server modules.

For details on the Raggify library, please refer to this page.

🚀 How to Install

To install, run:

pip install raggify-client

raggify-client requires a raggify server to be running on the backend. You can specify server host and port in /etc/raggify-client/config.yaml.

host: localhost
port: 8000
topk: 20
log_level: DEBUG

The default config.yaml is generated when raggify-client is run for the first time.

raggify-cilent --help

📚 Use As Library

Assuming the Raggify server is already running, the following program can be executed, for example:

import json

from raggify_client import RestAPIClient

client = RestAPIClient(host="localhost", port=8000)

print(json.dumps(client.status(), indent=2))

client.ingest_url("http://some.site.com")

⌨️ Use As CLI

Assuming the Raggify server is already running, you can execute commands such as the following:

Image

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

raggify_client-0.1.4.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

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

raggify_client-0.1.4-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file raggify_client-0.1.4.tar.gz.

File metadata

  • Download URL: raggify_client-0.1.4.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.15 {"installer":{"name":"uv","version":"0.9.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for raggify_client-0.1.4.tar.gz
Algorithm Hash digest
SHA256 ce67f24fa65b93ab0a45b25ecc5e58417bb7a281edf8aa0c57e1bd7846bf5cdd
MD5 454d7a6f4a69ca3ee9d5454fa0742a29
BLAKE2b-256 5940e93ca3e41ee803107f390d6554c5a2b82ba3099e9f045f75a04d763ce1ef

See more details on using hashes here.

File details

Details for the file raggify_client-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: raggify_client-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.15 {"installer":{"name":"uv","version":"0.9.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for raggify_client-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 78da6bc510f9710affbad28b7e49f1b8360d9cf21e8892868840c599ed19410d
MD5 cde1d2267647773193f72789c62b3356
BLAKE2b-256 1731b4bb416ca4dc846b4e576ec7ea77eb5af9f52b4fcf19cb0385e9486b45a0

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