isage-middleware 0.2.4.3__cp311-none-any.whl

sage/middleware/operators/tools/image_captioner.py

@@ -0,0 +1,104 @@
+import os
+import time
+
+from sage.libs.foundation.tools.tool import BaseTool
+
+try:
+    from isagellm import UnifiedInferenceClient
+except ImportError:
+    UnifiedInferenceClient = None  # Optional: isagellm not installed
+
+
+class ImageCaptioner(BaseTool):
+    def __init__(self, model_name: str = "meta-llama/Llama-2-13b-chat-hf"):
+        super().__init__(
+            tool_name="image_captioner",
+            tool_description="A tool that can generate captions for images ",
+            input_types={
+                "image_path": "The path to the image to caption",
+                "prompt": "The prompt to generate the caption",
+            },
+            demo_commands=[
+                {
+                    "command": 'execution = tool.execute(image="path/to/image.png")',
+                    "description": "Generate a caption for an image using the default prompt and model.",
+                },
+                {
+                    "command": 'execution = tool.execute(image="path/to/image.png", prompt="A beautiful landscape")',
+                    "description": "Generate a caption for an image using a custom prompt and model.",
+                },
+            ],
+            require_llm_engine=True,  # This tool requires an LLM engine
+        )
+        # Store additional metadata and model configuration as instance variables
+        self.tool_version = "1.0.0"
+        self.limitation = "The Image_Captioner_Tool provides general image descriptions but has limitations: 1) May make mistakes in complex scenes, counting, attribute detection, and understanding object relationships. 2) Might not generate comprehensive captions, especially for images with multiple objects or abstract concepts. 3) Performance varies with image complexity. 4) Struggles with culturally specific or domain-specific content. 5) May overlook details or misinterpret object relationships. For precise descriptions, consider: using it with other tools for context/verification, as an initial step before refinement, or in multi-step processes for ambiguity resolution. Verify critical information with specialized tools or human expertise when necessary."
+        self.model_name = model_name
+        print(f"ImageCaptioner initialized with model: {model_name}")
+
+    def execute(self, image_path: str):
+        try:
+            if not self.model_name:
+                raise ValueError(
+                    "Model name is not set. Please set the model name using set_model_name() before executing the tool."
+                )
+
+            # Construct the messages parameter for UnifiedInferenceClient
+            messages = [
+                {"role": "system", "content": "You are an image captioning assistant."},
+                {
+                    "role": "user",
+                    "content": f"Generate a caption for the image at path: {image_path}",
+                },
+            ]
+
+            # Use auto-detection for best available LLM service
+            client = UnifiedInferenceClient.create()
+
+            # Retry mechanism for connection errors
+            max_retries = 5
+            retry_delay = 3  # seconds
+
+            for attempt in range(max_retries):
+                try:
+                    response = client.chat(messages)
+                    return response
+                except ConnectionError as e:
+                    print(f"Connection error on attempt {attempt + 1}: {e}")
+                    if attempt < max_retries - 1:
+                        print(f"Retrying in {retry_delay} seconds...")
+                        time.sleep(retry_delay)
+                    else:
+                        raise
+        except Exception as e:
+            print(f"Error in ImageCaptioner: {e}")
+            return None
+
+
+if __name__ == "__main__":
+    import json
+
+    # Get the directory of the current script
+    script_dir = os.path.dirname(os.path.abspath(__file__))
+
+    # Example usage of the Image_Captioner_Tool
+    # tool = Image_Captioner_Tool()
+    tool = ImageCaptioner(model_name="meta-llama/Llama-2-13b-chat-hf")
+
+    # Get tool metadata
+    metadata = tool.get_metadata()
+    print(metadata)
+
+    # Construct the full path to the image using the script's directory
+    relative_image_path = "examples/baseball.png"
+    image_path = os.path.join(script_dir, relative_image_path)
+
+    # Execute the tool with default prompt
+    try:
+        execution = tool.execute(image_path=image_path)
+        print("Generated Caption:")
+        print(json.dumps(execution, indent=4))
+    except Exception as e:
+        print(f"Execution failed: {e}")
+
+    print("Done!")

sage/middleware/operators/tools/nature_news_fetcher.py

@@ -0,0 +1,224 @@
+import logging
+import os
+import random
+import time
+
+import requests
+from bs4 import BeautifulSoup, Tag
+
+from sage.libs.foundation.tools.tool import BaseTool
+
+# Initialize logger
+logger = logging.getLogger(__name__)
+logging.basicConfig(level=logging.INFO)
+
+
+class Nature_News_Fetcher_Tool(BaseTool):
+    def __init__(self):
+        super().__init__(
+            tool_name="Nature_News_Fetcher_Tool",
+            tool_description="A tool that fetches the latest news articles from Nature.",
+            input_types={
+                "num_articles": "int - The number of articles to fetch (default: 100).",
+                "max_pages": "int - The maximum number of pages to fetch (default: 5).",
+            },
+            output_type="list - A list of dictionaries containing information about the latest Nature news articles.",
+            demo_commands=[
+                {
+                    "command": "execution = tool.execute()",
+                    "description": "Fetch the latest 100 news articles from Nature.",
+                },
+                {
+                    "command": "execution = tool.execute(num_articles=50, max_pages=3)",
+                    "description": "Fetch the latest 50 news articles from Nature, searching up to 3 pages.",
+                },
+            ],
+        )
+        self.tool_version = "1.0.0"
+        self.base_url = "https://www.nature.com/nature/articles"
+        # 控制每次抓取后的等待时间，可在测试中覆盖
+        self.sleep_time = 1
+
+    def fetch_page(self, page_number):
+        """
+        Fetches a single page of news articles from Nature's website.
+
+        Parameters:
+            page_number (int): The page number to fetch.
+
+        Returns:
+            str: The HTML content of the page.
+        """
+        params = {
+            "searchType": "journalSearch",
+            "sort": "PubDate",
+            "type": "news",
+            "page": str(page_number),
+        }
+        user_agents = [
+            "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36",
+            "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36",
+            "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36",
+        ]
+        headers = {"User-Agent": random.choice(user_agents)}
+        response = requests.get(self.base_url, params=params, headers=headers)
+        response.raise_for_status()
+        return response.text
+
+    def parse_articles(self, html_content):
+        """
+        Parses the HTML content and extracts article information.
+
+        Parameters:
+            html_content (str): The HTML content of the page.
+
+        Returns:
+            list: A list of dictionaries containing article information.
+        """
+        soup = BeautifulSoup(html_content, "html.parser")
+        articles_section = soup.find("section", id="new-article-list")
+        if not isinstance(articles_section, Tag):
+            return []
+
+        articles = []
+        for article in articles_section.find_all("article", class_="c-card"):  # type: ignore
+            if not isinstance(article, Tag):
+                continue
+
+            title_elem = article.find("h3", class_="c-card__title")  # type: ignore
+            title = title_elem.text.strip() if isinstance(title_elem, Tag) else "No title found"
+
+            url_elem = title_elem.find("a") if isinstance(title_elem, Tag) else None  # type: ignore
+            url = (
+                "https://www.nature.com" + str(url_elem["href"])
+                if isinstance(url_elem, Tag) and url_elem.has_attr("href")
+                else "No URL found"
+            )
+
+            description_elem = article.find("div", {"data-test": "article-description"})  # type: ignore
+            description = (
+                description_elem.text.strip()
+                if isinstance(description_elem, Tag)
+                else "No description available"
+            )
+
+            authors_elem = article.find("ul", {"data-test": "author-list"})  # type: ignore
+            authors = (
+                [
+                    author.text.strip()
+                    for author in authors_elem.find_all("li")
+                    if isinstance(author, Tag)
+                ]
+                if isinstance(authors_elem, Tag)
+                else ["No authors found"]
+            )
+
+            date_elem = article.find("time")  # type: ignore
+            date = (
+                date_elem["datetime"]
+                if isinstance(date_elem, Tag) and date_elem.has_attr("datetime")
+                else "No date found"
+            )
+
+            image_elem = article.find("img")  # type: ignore
+            image_url = (
+                image_elem["src"]
+                if isinstance(image_elem, Tag) and image_elem.has_attr("src")
+                else "No image found"
+            )
+
+            articles.append(
+                {
+                    "title": title,
+                    "url": url,
+                    "description": description,
+                    "authors": authors,
+                    "date": date,
+                    "image_url": image_url,
+                }
+            )
+
+        return articles
+
+    def execute(self, num_articles=100, max_pages=5):
+        """
+        Fetches the latest news articles from Nature's website.
+
+        Parameters:
+            num_articles (int): The number of articles to fetch.
+            max_pages (int): The maximum number of pages to fetch.
+
+        Returns:
+            list: A list of dictionaries containing article information.
+        """
+        all_articles = []
+        page_number = 1
+
+        try:
+            while len(all_articles) < num_articles and page_number <= max_pages:
+                html_content = self.fetch_page(page_number)
+                page_articles = self.parse_articles(html_content)
+
+                if not page_articles:
+                    logger.info(f"No articles found on page {page_number}. Stopping fetch.")
+                    break  # No more articles found
+
+                all_articles.extend(page_articles)
+                page_number += 1
+                # 只有在还需抓取下一页时才 sleep
+                if len(all_articles) < num_articles and page_number <= max_pages:
+                    time.sleep(self.sleep_time)  # Be polite to the server
+
+            return all_articles[:num_articles]
+        except requests.exceptions.RequestException as e:
+            logger.error(f"Network error occurred: {e}")
+            return [{"error": f"Network error: {str(e)}"}]
+        except Exception as e:
+            logger.error(f"An unexpected error occurred: {e}")
+            return [{"error": f"Unexpected error: {str(e)}"}]
+
+    def get_metadata(self):
+        """
+        Returns the metadata for the Nature_News_Fetcher_Tool.
+
+        Returns:
+            dict: A dictionary containing the tool's metadata.
+        """
+        if hasattr(super(), "get_metadata"):
+            metadata = super().get_metadata()
+        else:
+            metadata = {}
+        return metadata
+
+
+if __name__ == "__main__":
+    # Get the directory of the current script
+    script_dir = os.path.dirname(os.path.abspath(__file__))
+
+    # Example usage of the Nature_News_Fetcher_Tool
+    tool = Nature_News_Fetcher_Tool()
+
+    # Get tool metadata
+    metadata = tool.get_metadata()
+    print(metadata)
+
+    import json
+
+    # Execute the tool to fetch the latest 10 articles (for demonstration purposes)
+    try:
+        execution = tool.execute(num_articles=10, max_pages=1)
+        print(json.dumps(execution, indent=4))
+        print("\nExecution Result:")
+        print(f"Number of articles fetched: {len(execution)}")
+        print("\nSample articles:")
+        for i, article in enumerate(execution[:10], 1):
+            print(f"\n{i}. Title: {article['title']}")
+            print(f"   URL: {article['url']}")
+            print(f"   Description: {article['description'][:100]}...")  # Show first 100 characters
+            print(f"   Authors: {', '.join(article['authors'])}")
+            print(f"   Date: {article['date']}")
+            print(f"   Image URL: {article['image_url']}")
+    except Exception as e:
+        print(f"Execution failed: {e}")
+
+    print("Done!")