Merge pull request #4 from JigsawStack/check

v0.1.2

Author: iamNarcisse

README.md

@@ -1,5 +1,32 @@
 # JigsawStack Python SDK
 
+The JigsawStack Python SDK allows you to interact with powerful AI services to build AI-powered applications.
+
+- 🧩 Powerful AI services all in one SDK
+- ⌨️ Fully typed parameters and responses
+- 📡 Built in Webhook support for long-running tasks
+- 📦 Built in file system for easy file uploads
+
+## Learn more
+
+To learn more about all available JigsawStack AI services, view the [Documentation](https://docs.jigsawstack.com) or [Website](https://jigsawstack.com).
+
+## All APIs
+
+| Category          | APIs                                              |
+| ----------------- | ------------------------------------------------- |
+| **👉 General**    | Translation, Summarization, Sentiment Analysis    |
+| **🌐 Web**        | AI Web Scraping, AI Web Search                    |
+| **🎵 Audio**      | Text to Speech, Speech to Text (Whisper large v3) |
+| **👀 Vision**     | vOCR, Object Detection                            |
+| **🧠 LLMs**       | Prompt Engine                                     |
+| **🖼️ Generative** | AI Image (SD, SDXL-Fast & more), HTML to Any      |
+| **🌍 Geo**        | Location search, Timezone, IP Geolocation & more  |
+| **✅ Validation** | Email, NSFW images, profanity & more              |
+| **📁 Store**      | Simple File Storage, KV Encryption store          |
+
+Learn more of about each category in the [API reference](https://docs.jigsawstack.com/api-reference)
+
 ## Installation
 
 To install JigsawStack Python SDK, simply execute the following command in a terminal:
@@ -10,30 +37,60 @@ pip install jigsawstack
 
 ## Setup
 
-First, you need to get an API key, which is available in the [JigsawStack Dashboard](https://jigsawstack.com).
+First, get your API key from the [JigsawStack Dashboard](https://jigsawstack.com/dashboard)
+
+Then, initialize the SDK:
 
 ```py
 from jigsawstack import JigsawStack
 
-import os
+jigsaw = JigsawStack(api_key="your-api-key")
+```
+
+## Usage
 
- ai = JigsawStack(api_key="your-api-key")
+AI Scraping Example:
+
+```py
+params = {
+ "url": "https://www.amazon.com/Cadbury-Mini-Caramel-Eggs-Bulk/dp/B0CWM99G5W",
+ "element_prompts": ["prices"]
+}
+result = jigsaw.web.ai_scrape(params)
 ```
 
-## Example
+Text To Speech Example:
 
 ```py
-import os
-from jigsawstack import JigsawStack
+params = {"text": "Hello, how are you doing?"}
+result = jigsaw.audio.text_to_speech(params)
+```
 
+Speech To Text Example:
 
-ai = JigsawStack(api_key="your-api-key")
+```py
+params = { "url": "https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Video%201737458382653833217.mp4?t=2024-03-22T09%3A50%3A49.894Z"}
+result = jigsaw.audio.speech_to_text(params)
+```
+
+VOCR:
 
+```py
 params = {
     "url": "https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Collabo%201080x842.jpg?t=2024-03-22T09%3A22%3A48.442Z"
 }
+result = jigsaw.vision.vocr(params)
+```
 
-result = ai.vision.vocr(params)
+## Community
 
-print(result)
-```
+Join JigsawStack community on [Discord](https://discord.gg/dj8fMBpnqd) to connect with other developers, share ideas, and get help with the SDK.
+
+## Related Projects
+
+- [Docs](https://docs.jigsawstack.com)
+- [Javascript SDK](https://github.com/JigsawStack/jigsawstack-js)
+
+## Contributing
+
+JigsawStack AI SDK is open-source and welcomes contributions. Please open an issue or submit a pull request with your changes. Make sure to be as descriptive as possible with your submissions, include examples if relevant.

jigsawstack/__init__.py

@@ -12,6 +12,8 @@
 from .sentiment import Sentiment
 from .validate import Validate
 from .summary import Summary
+from .geo import Geo
+from .prompt_engine import PromptEngine
 
 class JigsawStack:
     audio: Audio
@@ -26,6 +28,8 @@ class JigsawStack:
     validate: Validate
     summary: Summary
     search: Search
+    geo : Geo
+    prompt_engine: PromptEngine
     api_key: str
     api_url: str
 
@@ -58,6 +62,8 @@ def __init__(self, api_key: Union[str, None] = None, api_url: Union[str, None] =
         self.file = File(api_key=api_key, api_url=api_url)
         self.kv = KV(api_key=api_key, api_url=api_url)
         self.translate = Translate(api_key=api_key, api_url=api_url)
+        self.geo = Geo(api_key=api_key, api_url=api_url)
+        self.prompt_engine = PromptEngine(api_key=api_key, api_url=api_url)
 
 # Create a global instance of the Web class
 __all__ = ["JigsawStack"]

jigsawstack/audio.py

@@ -5,6 +5,18 @@
 from typing import Any, Dict, List, cast
 from typing_extensions import NotRequired, TypedDict
 
+
+class TextToSpeechParams(TypedDict):
+    text:str
+    accent: NotRequired[str]
+    speaker_clone_url: NotRequired[str]
+    speaker_clone_file_store_key: NotRequired[str]
+
+class TextToSpeechResponse(TypedDict):
+    success:bool
+    text: str
+    chunks : List[object]
+
 class SpeechToTextParams(TypedDict):
     url:str
     file_store_key : NotRequired[str]
@@ -27,4 +39,13 @@ def speech_to_text(self, params: SpeechToTextParams) -> SpeechToTextResponse:
             api_url=self.api_url,
             path=path, params=cast(Dict[Any, Any], params), verb="post"
         ).perform_with_content()
+        return resp
+    
+    def text_to_speech(self, params: TextToSpeechParams) -> TextToSpeechResponse:
+        path = "/ai/tts"
+        resp = Request(
+            api_key=self.api_key,
+            api_url=self.api_url,
+            path=path, params=cast(Dict[Any, Any], params), verb="post"
+        ).perform_with_content()
         return resp