Skip to main content

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

Project description

Raggify Client

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.0.tar.gz (7.4 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.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for raggify_client-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1c290a156fca4b260138657a8bc42125b33fe01dd2ad49c40ba115a35b1af119
MD5 f0affd89b526e49ae30a263912745243
BLAKE2b-256 bcc3d84d69e7d53060203bc99fe7964d5674a9eef3f8742802f4e2738cdea7d6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for raggify_client-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 59f5a9da921468fa901d9ef2b830cac1a8016b355d869afc4a89b1a60ec34203
MD5 91dc3adcc5941368411d448513e27397
BLAKE2b-256 b62057a115a88d2945b9fb239642e50ab793a2f6e99034c6d1f1dc220f24131c

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