A framework for writing Unstract Tools/Apps
Project description
Unstract
No-code LLM Platform to launch APIs and ETL Pipelines to structure unstructured documents
Unstract SDK
The unstract-sdk
package helps with developing tools that are meant to be run on the Unstract platform. This includes
modules to help with tool development and execution, caching, making calls to LLMs / vectorDBs / embeddings .etc.
They also contain helper methods/classes to aid with other tasks such as indexing and auditing the LLM calls.
Installation
- The below libraries need to be installed to run the SDK
-
Linux
sudo apt install build-essential pkg-config libmagic-dev tesseract-ocr pandoc
-
Mac
brew install pkg-config libmagic pandoc tesseract-ocr
-
Tools
Create a scaffolding for a new tool
Example
unstract-tool-gen --command NEW --tool-name <name of tool> \
--location ~/path_to_repository/unstract-tools/ --overwrite false
Supported commands:
NEW
- Create a new tool
Environment variables required for all Tools
Variable | Description |
---|---|
PLATFORM_SERVICE_HOST |
The host in which the platform service is running |
PLATFORM_SERVICE_PORT |
The port in which the service is listening |
PLATFORM_SERVICE_API_KEY |
The API key for the platform |
TOOL_DATA_DIR |
The directory in the filesystem which has contents for tool execution |
Llama Index support
Unstract SDK 0.3.2 uses the following version of Llama Index Version 0.9.28 as on January 14th, 2024
Environment variables required for various LLMs (deprecated)
- Azure OpenAI
OPENAI_API_KEY
OPENAI_API_BASE
OPENAI_API_VERSION
OPENAI_API_ENGINE
OPENAI_API_MODEL
Documentation generation
Follow this README.md for generating 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
unstract_sdk-0.24.0.tar.gz
(56.3 kB
view hashes)
Built Distribution
Close
Hashes for unstract_sdk-0.24.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbbfdb814d48b2a0a0914ca9328bcea0ad26acf34ca9348f64c822949c80dcc1 |
|
MD5 | e6626340df28f2a6b76dd2cf094ef758 |
|
BLAKE2b-256 | 280668d6459d23aa16a190c6a5ce703aa59add546eeb3d8a59a69a1ea85ae7ea |