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

Uploaded Python 3

File details

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

File metadata

  • Download URL: raggify_client-0.3.5.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.5.tar.gz
Algorithm Hash digest
SHA256 29b5d6a850d7fa96ef089adc839d1ff533a695b3f5da1d56638faed0f2695acd
MD5 45bf367357601f1db47a26414b749474
BLAKE2b-256 afd9037da732d6496cafbdec872e78d7f12d5cd0f75d7ad7d819cc474f1c2123

See more details on using hashes here.

File details

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

File metadata

  • Download URL: raggify_client-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 11.4 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8d18236ea6ba40f35dac933b255cccc12ed874008f8f3f06c0fe1091013641d9
MD5 d232ec60318f58bad5b8d2f8542a33d6
BLAKE2b-256 76cda7ede88a90a1d7a721361a03229c0822b62c5c3a93dd1685793eee0b9bb8

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