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.
- 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
-
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
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 |
Unstract SDK 0.3.2 uses the following version of Llama Index Version 0.9.28 as on January 14th, 2024
- Azure OpenAI
OPENAI_API_KEY
OPENAI_API_BASE
OPENAI_API_VERSION
OPENAI_API_ENGINE
OPENAI_API_MODEL
Follow this README.md for generating documentation.