Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 2.27 KB

README.md

File metadata and controls

72 lines (51 loc) · 2.27 KB
Raw

jAMALL

jAMALL allows you to swap JSON into YAML for the benefit of LLMs and back again.

Additionally, it will store the content of incoming and outgoing JSON/YAML blocks into python objects.

Features

  • Automatic Detection of JSON: The ConvertFromJson class automatically detects JSON objects within the provided text, even if they are nested or formatted in various ways.
  • Conversion to YAML: Converts detected JSON objects to YAML, preserving the structure and data types.
  • Markdown Code Block Support: Encloses the YAML converted text in markdown code blocks, making it ready for documentation or markdown-based platforms.

By using the ConvertFromJson class, developers can streamline the process of converting JSON to YAML, enhancing the readability and usability of data when interacting with LLMs or for documentation purposes.

Quickstart

(not yet on pypi, but you can install it from github)

## Install from github
pip install git+
pip install git+https://github.com/lumpenspace/jamall.git

Usage

The ConvertFromJson class converts JSON objects within a string to YAML format, and vice versa.

This conversion is particularly useful when working with LLMs (Large Language Models), as it allows for the easy interchange of data formats in a more human-readable form.

from jamall import ConvertFromJson

messages=[{**message, "content": ConvertFromJson.from_text(message)} for message in messages];

client.chat_completion(
    messages=messages,
)

API

ConvertFromJson

The ConvertFromJson class provides the following methods:

from_text(text: str) -> str

Creates an instance of ConvertFromJson from a given text.

This method automatically detects JSON objects within the text, converts them to YAML, and stores both the original text and the converted text. Args:

  • text (str): The text containing JSON objects to be converted.

Returns:

  • ConvertFromJson (str): An instance of ConvertFromJson with the original and converted text.

original_text -> str

The original text containing JSON objects.

__str__() -> str

Converts the stored JSON objects to YAML format and returns the result as a string.

__repr__() -> str

Returns the string representation of the class instance.