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.1.tar.gz (8.6 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.1-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: raggify_client-0.3.1.tar.gz
  • Upload date:
  • Size: 8.6 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.1.tar.gz
Algorithm Hash digest
SHA256 884801c0841745f856147366b2160663a9805ac41a174ecb0ea2a08da5bca79d
MD5 1698ada05f8b3ee4280dfd49317b040c
BLAKE2b-256 279115676a9c3805bade8b9ee30c1d70dd146c5528c29dbc96a58af6733658db

See more details on using hashes here.

File details

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

File metadata

  • Download URL: raggify_client-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 11.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 528752ef54a7c37ece503187ed758406485f1b28f9c12d5b29882c38bd969983
MD5 c0cdb71829fe600cb8a45a60a5765a4e
BLAKE2b-256 c259aa81e7cdc069d22b5a376ba80d21442e060349f7377a571b7474ff8c0199

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