Lang2Logic 1.2.0
A package for generating, validating, and utilizing Draft-7 JSON schemas with LangChain
License: CC0-1.0
Requires Python: >=3.7, <4
Keywords: language models,structured output


# Lang2Logic Python Package

## Introduction

Lang2Logic: Generating python objects with natural language.

## Overview

Lang2Logic is an innovative Python package designed for developers who need to translate natural language prompts into structured Python outputs. Utilizing advanced language processing algorithms, Lang2Logic simplifies generating Python code from verbal or written descriptions.

## Key Features

- **Natural Language to Python Conversion**: Converts natural language instructions into Python code, facilitating easier programming and automation.
- **Dynamic Schema Generation**: Automatically generates schema from natural language inputs, providing structured outputs like lists, dictionaries, etc.
- **Flexible API Integration**: User-friendly API for seamless integration with existing Python projects.

## Installation and Usage

```python
import os
from Lang2Logic.generator import Generator

# Initialize with API key
test_gen = Generator(os.environ.get("YOUR_API_KEY"))

# Generate schema from natural language
schema = test_gen.generate_schema("return a list of strings")

# The 'schema' here is an instance of the ResponseSchema class
```

### Using the ResponseSchema Class

The `ResponseSchema` class is designed to handle and manipulate JSON schemas. It can accept a JSON string, a dictionary, or another instance of itself to create or modify a schema.

#### Creating an Instance

```python
from Lang2Logic.response_schema import ResponseSchema

# Create a ResponseSchema instance from a dictionary
schema_dict = {"type": "object", "properties": {"name": {"type": "string"}}}
schema = ResponseSchema(schema_dict)

# Or from another ResponseSchema instance
another_schema = ResponseSchema(schema)
```

#### Getting Dictionary or JSON Representation

```python
# Get the schema as a dictionary
schema_dict = schema.to_dict()

# Convert the schema to a JSON string
schema_json = schema.to_json()
```

#### Saving Schema to a File

```python
# Save the schema to a JSON file
schema.save_to_json(key="mySchema", filepath="path/to/file.json")
```

### Automatic Schema Generation

```python
test_gen.generate("return a list of strings with 5 colors")
# The output is an instance of ResponseSchema
# Output: ["color1", "color2", "color3", "color4", "color5"]
```

### Example Usage

#### Classifying Decisions and Preferences

```python
schema = test_gen.generate_schema("return a dictionary with keys 'rational' and 'decision' (boolean)")

potential_buyers = []
for user in users_data_json["bios"]:
    decision = test_gen.generate(f"return true if this user might be interested in products related to rock climbing.\nUser Bio:\n{user['bio']}", schema)
    if decision["decision"]:
        potential_buyers.append(user)
```

## Roadmap

- **Function Generation**
- **Optimized Logic for Increased Accuracy**
- **Code Parsing and LLM integration tools**
- **Python Agents**

## Bug Reporting and Contributions

Found a bug or have a suggestion? Please contact [dylanpwilson2005@gmail.com](mailto:dylanpwilson2005@gmail.com).

## License

Lang2Logic is available under a Creative Commons license and may not be used for commercial purposes without explicit consent from the author.