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.2.tar.gz (7.8 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.2-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: raggify_client-0.1.2.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for raggify_client-0.1.2.tar.gz
Algorithm Hash digest
SHA256 451a90811d960aa429b53c8908e3778c2598d51ccd2339500ff7a7f2c49d3931
MD5 366903c27b6c429fca8abc94326c3864
BLAKE2b-256 a2d0b6e637a59de64b45bd090bea6734562a320933e30d3718342a31786f3f75

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for raggify_client-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 32b8d56fb2a930d8bb048786877fabba80580bf2b4ed01f03d19ec56a00ddc5a
MD5 65201669c44cc3428fd8bbbaf419ea39
BLAKE2b-256 74eb67a14f3a0c047e5cbc58f5f568b6cfb9c67aa9cec83d23cf2517fcf98bec

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