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.3.2.tar.gz (8.7 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.3.2-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: raggify_client-0.3.2.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","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.3.2.tar.gz
Algorithm Hash digest
SHA256 8c8e836cdfae43c050af1a986b1a9c1b130dfea18e41fba97721a31eeaaecc54
MD5 90da1f70a37f580eaf3689b255c849d0
BLAKE2b-256 ece18f67867b69d25025fef0903af648d312aca07f76faaf323e7aef32881a58

See more details on using hashes here.

File details

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

File metadata

  • Download URL: raggify_client-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","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.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a50a8102a691cae5d2be1ae39ba122a525587fe50f9f57ae89c52cf04fb5a921
MD5 963683c2f6497d77cf27cc6efa9a09fe
BLAKE2b-256 f2ba9debd35882f09d2362df8466e2386a281e8f3d0a6732d518c683ebfbedd9

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