Skip to main content

A CLI application for ragbits - building blocks for rapid development of GenAI applications

Project description

Ragbits CLI

Ragbits CLI provides the ragbits command-line interface (CLI) tool that allows you to interact with Ragbits from the terminal. Other packages can extend the CLI by adding their own commands, so the exact set of available commands may vary depending on the installed packages.

Installation

To use the complete Ragbits stack, install the ragbits package:

pip install ragbits

Example Usage

The following example assumes that ragbits-core is installed and that the current ddirectory contains a song_prompt.py file with a prompt class named SongPrompt, as defined in the Quickstart Guide.

The example demonstrates how to execute the prompt using the ragbits CLI tool. The left side of the table shows the system and user prompts (rendered with placeholders replaced by the provided values), and the right side shows the generated response from the Large Language Model.

$ ragbits prompts exec song_prompt:SongPrompt --payload '{"subject": "unicorns", "age_group": 12, "genre": "pop"}'

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Question                               Answer                                ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ [{'role': 'system', 'content': 'You   │ (Verse 1)                             │
│ are a professional songwriter.        │ In a land of rainbows and glitter,    │
│ You only use language that is         │ Where flowers bloom and skies are     │
│ appropriate for children.'},           brighter,                             │
│ {'role': 'user', 'content': 'Write a  │ There's a magical creature so rare,   │
│ song about a unicorns for 12 years     With a horn that sparkles in the air. │
│ old pop fans.'}]                                                             │
│                                        (Chorus)                              │
│                                        Unicorns, unicorns, oh so divine,     │
│                                        With their mane that shines and eyes  │
│                                        that shine,                           │
│                                        Gallop through the meadows, so free,  │
│                                        In a world of wonder, just you and    │
│                                        me.                                   │
└───────────────────────────────────────┴───────────────────────────────────────┘

Documentation

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ragbits_cli-0.19.0.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.

ragbits_cli-0.19.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file ragbits_cli-0.19.0.tar.gz.

File metadata

  • Download URL: ragbits_cli-0.19.0.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for ragbits_cli-0.19.0.tar.gz
Algorithm Hash digest
SHA256 ba364f0669e730207c2672bba3d79a1158e23196e20507e2db40b84524d406a2
MD5 ccbc89257a706f40ca9cf5da2c1468eb
BLAKE2b-256 e459d4fcc1c3a999b81ca9fe7ea86e37ab8919db5dc470880a1fe93b85260086

See more details on using hashes here.

File details

Details for the file ragbits_cli-0.19.0-py3-none-any.whl.

File metadata

  • Download URL: ragbits_cli-0.19.0-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for ragbits_cli-0.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc67dbcdfbccea02ba6ef7ff22c3e6e8d4522f5f61090a6a93854a4202bd48f8
MD5 2affc7a43b239e44c3cfd0fc9ec5b9d6
BLAKE2b-256 6c994c68cd83e02bbb7afd9bed36a01aed5e74cab3a9be2b5417d7bb05ffa6a6

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