keyinfostruct extracts and structures key info from personal texts, highlighting main points, emotions, and suggested actions for better organization.
Project description
keyinfostruct
keyinfostruct is a lightweight Python package that extracts and structures key information from personal experience narratives (e.g., social‑media posts, messages).
It automatically identifies the main points, emotions, and suggested actions from free‑form text using an LLM and returns the data in a ready‑to‑use list.
Features
- One‑function API – just call
keyinfostruct(...). - Works out‑of‑the‑box with ChatLLM7 (default LLM).
- Plug‑and‑play with any LangChain‑compatible chat model (OpenAI, Anthropic, Google, etc.).
- Returns data that matches a strict regular‑expression pattern, guaranteeing predictable output.
Installation
pip install keyinfostruct
Quick Start
from keyinfostruct import keyinfostruct
user_input = """
I just posted on Instagram that I'm getting divorced.
Now I see a bot impersonating me and replying to my friends with weird messages.
I'm feeling angry and scared.
What should I do?
"""
# Use the default ChatLLM7 (API key is read from env LLM7_API_KEY)
response = keyinfostruct(user_input)
print(response)
# Example output:
# [
# "Event: announced divorce on Instagram",
# "Emotion: angry, scared",
# "Suggested Action: report impersonation, change passwords, inform friends"
# ]
Parameters
| Parameter | Type | Description |
|---|---|---|
user_input |
str |
The raw text you want to analyse. |
llm (optional) |
BaseChatModel |
Any LangChain chat model. If omitted, the package instantiates ChatLLM7 automatically. |
api_key (optional) |
str |
LLM7 API key. If not supplied, the function reads the environment variable LLM7_API_KEY. If that is also missing, a placeholder "None" is used (the request will fail unless you provide a real key). |
Using Your Own LLM
You can swap the default model for any LangChain‑compatible chat model.
OpenAI
from langchain_openai import ChatOpenAI
from keyinfostruct import keyinfostruct
llm = ChatOpenAI(model="gpt-4o-mini")
response = keyinfostruct(user_input, llm=llm)
Anthropic
from langchain_anthropic import ChatAnthropic
from keyinfostruct import keyinfostruct
llm = ChatAnthropic(model="claude-3-haiku-20240307")
response = keyinfostruct(user_input, llm=llm)
Google Generative AI
from langchain_google_genai import ChatGoogleGenerativeAI
from keyinfostruct import keyinfostruct
llm = ChatGoogleGenerativeAI(model="gemini-1.5-flash")
response = keyinfostruct(user_input, llm=llm)
API Key for LLM7
- Free tier: sufficient for most development and small‑scale usage.
- Higher limits: obtain an upgraded key from the LLM7 dashboard.
Set the key via environment variable:
export LLM7_API_KEY="your_llm7_api_key"
Or pass it directly:
response = keyinfostruct(user_input, api_key="your_llm7_api_key")
Free keys are available after registration at https://token.llm7.io/.
How It Works
keyinfostruct builds a LangChain message chain consisting of a system prompt, a human prompt (your user_input), and a regex pattern defined in keyinfostruct.prompts.
The helper llmatch runs the LLM, validates the output against the pattern, and returns the extracted list. If the LLM response does not satisfy the pattern, a RuntimeError is raised.
Contributing & Support
- Issues & feature requests: https://github.com/chigwell/keyinfostruct/issues
- Pull requests are welcome—please follow the repository’s contribution guidelines.
License
This project is licensed under the MIT License.
Author
Eugene Evstafev
Email: hi@euegne.plus
GitHub: chigwell
Happy structuring!
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file keyinfostruct-2025.12.22082410.tar.gz.
File metadata
- Download URL: keyinfostruct-2025.12.22082410.tar.gz
- Upload date:
- Size: 7.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
940f3aeed966ce6e08810387db297346ee470d73da7242ce11b5885867a9a11c
|
|
| MD5 |
240638644c115841de145eaa1dc8d8cc
|
|
| BLAKE2b-256 |
23b967840f67ce70acf3916215e1760c96ec2a757996385914723faa97e4cff3
|
File details
Details for the file keyinfostruct-2025.12.22082410-py3-none-any.whl.
File metadata
- Download URL: keyinfostruct-2025.12.22082410-py3-none-any.whl
- Upload date:
- Size: 8.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d09a7d64b3fa770bfc2a3b48a97e0c2f64584b2754508cb96186729a6e8cd787
|
|
| MD5 |
0e1c6b8b1dbdc1923543ad10f551b445
|
|
| BLAKE2b-256 |
10defc8313122f945c728e6b3967af2a020c961870f9fc1f4ab2ac5b302cbb8d
|