{"id":31792746,"url":"https://github.com/graphlit/graphlit-tools-python","last_synced_at":"2025-10-10T17:16:24.719Z","repository":{"id":257680958,"uuid":"859016290","full_name":"graphlit/graphlit-tools-python","owner":"graphlit","description":"AI Agent Tools library for Graphlit Platform","archived":false,"fork":false,"pushed_at":"2025-01-14T20:59:27.000Z","size":177,"stargazers_count":20,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-24T21:43:08.486Z","etag":null,"topics":["agents","ai","ai-agents","crewai","crewai-tools","graphlit","llms","python","rag"],"latest_commit_sha":null,"homepage":"https://www.graphlit.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/graphlit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-17T23:45:05.000Z","updated_at":"2025-06-09T11:40:19.000Z","dependencies_parsed_at":"2024-10-26T03:28:47.532Z","dependency_job_id":"cf643a2a-dd3b-4a1e-a055-e56bacda30b6","html_url":"https://github.com/graphlit/graphlit-tools-python","commit_stats":null,"previous_names":["graphlit/graphlit-tools-python"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/graphlit/graphlit-tools-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphlit%2Fgraphlit-tools-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphlit%2Fgraphlit-tools-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphlit%2Fgraphlit-tools-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphlit%2Fgraphlit-tools-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/graphlit","download_url":"https://codeload.github.com/graphlit/graphlit-tools-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphlit%2Fgraphlit-tools-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279004825,"owners_count":26083784,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agents","ai","ai-agents","crewai","crewai-tools","graphlit","llms","python","rag"],"created_at":"2025-10-10T17:16:23.091Z","updated_at":"2025-10-10T17:16:24.688Z","avatar_url":"https://github.com/graphlit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![PyPI version](https://badge.fury.io/py/graphlit-tools.svg)](https://badge.fury.io/py/graphlit-tools)\r\n\r\n# Python Agent Tools for Graphlit Platform\r\n\r\n## Overview\r\n\r\nThe Graphlit Agent Tools for Python enables easy interaction with agent frameworks such as [CrewAI](https://crewai.com) or [Griptape](https://www.griptape.ai/), allowing developers to easily integrate the Graphlit service with agentic workflows. This document outlines the setup process and provides a basic example of using the tools.\r\n\r\n## Prerequisites\r\n\r\nBefore you begin, ensure you have the following:\r\n\r\n- Python 3.x installed on your system.\r\n- An active account on the [Graphlit Platform](https://portal.graphlit.dev) with access to the API settings dashboard.\r\n\r\n## Installation\r\n\r\nTo install the Graphlit Agent Tools with CrewAI, use pip:\r\n\r\n```bash\r\npip install graphlit-tools[crewai]\r\n```\r\n\r\nTo install the Graphlit Agent Tools with Griptape, use pip:\r\n\r\n```bash\r\npip install graphlit-tools[griptape]\r\n```\r\n\r\n### Using the Graphlit agent tools\r\n\r\nWe have example Google Colab notebooks using CrewAI, which provide an example for [analyzing the web marketing strategy of a company](https://colab.research.google.com/github/graphlit/graphlit-samples/blob/main/python/Notebook%20Examples/Graphlit_2024_12_07_CrewAI_Web_Marketing_Analyzer.ipynb), and for [structured data extraction of products from scraped web pages](https://colab.research.google.com/github/graphlit/graphlit-samples/blob/main/python/Notebook%20Examples/Graphlit_2024_12_08_CrewAI_Product_Data_Extraction.ipynb).\r\n\r\nOnce you have configured the Graphlit client, as shown below, you will pass the client to the tool constructor.\r\n\r\nFor use in CrewAI, you will need to convert the tool to the CrewAI tool schema with the `CrewAIConverter.from_tool()` function.  \r\n\r\nFor use in Griptape, you will need to convert the tool to the CrewAI tool schema with the `GriptapeConverter.from_tool()` function.\r\n\r\nWe will provide support for additional agent frameworks, such as LangGraph and AutoGen in future.\r\n\r\n#### CrewAI\r\n\r\n```python\r\nfrom graphlit_tools import WebSearchTool, CrewAIConverter\r\n\r\nweb_search_tool = CrewAIConverter.from_tool(WebSearchTool(graphlit))\r\n\r\nweb_search_agent = Agent(\r\n    role=\"Web Researcher\",\r\n    goal=\"Find the {company} website.\",\r\n    backstory=\"\",\r\n    verbose=True,\r\n    allow_delegation=False,\r\n    tools=[web_search_tool],\r\n)\r\n```\r\n\r\n#### Griptape\r\n\r\n```python\r\nfrom graphlit_tools import WebSearchTool, CrewAIConverter\r\n\r\nweb_search_tool = GriptapeConverter.from_tool(WebSearchTool(graphlit))\r\n\r\nweb_search_agent = Agent(\r\n    role=\"Web Researcher\",\r\n    goal=\"Find the {company} website.\",\r\n    backstory=\"\",\r\n    verbose=True,\r\n    allow_delegation=False,\r\n    tools=[web_search_tool],\r\n)\r\n```\r\n\r\n## Configuration\r\n\r\nThe Graphlit Client supports environment variables to be set for authentication and configuration:\r\n\r\n- `GRAPHLIT_ENVIRONMENT_ID`: Your environment ID.\r\n- `GRAPHLIT_ORGANIZATION_ID`: Your organization ID.\r\n- `GRAPHLIT_JWT_SECRET`: Your JWT secret for signing the JWT token.\r\n\r\nAlternately, you can pass these values with the constructor of the Graphlit client.\r\n\r\nYou can find these values in the API settings dashboard on the [Graphlit Platform](https://portal.graphlit.dev).\r\n\r\nFor example, to use Graphlit in a Google Colab notebook, you need to assign these properties as Colab secrets: GRAPHLIT_ORGANIZATION_ID, GRAPHLIT_ENVIRONMENT_ID and GRAPHLIT_JWT_SECRET.\r\n\r\n```python\r\nimport os\r\nfrom google.colab import userdata\r\nfrom graphlit import Graphlit\r\n\r\nos.environ['GRAPHLIT_ORGANIZATION_ID'] = userdata.get('GRAPHLIT_ORGANIZATION_ID')\r\nos.environ['GRAPHLIT_ENVIRONMENT_ID'] = userdata.get('GRAPHLIT_ENVIRONMENT_ID')\r\nos.environ['GRAPHLIT_JWT_SECRET'] = userdata.get('GRAPHLIT_JWT_SECRET')\r\n\r\ngraphlit = Graphlit()\r\n```\r\n\r\n### Setting Environment Variables\r\n\r\nTo set these environment variables on your system, use the following commands, replacing `your_value` with the actual values from your account.\r\n\r\nFor Unix/Linux/macOS:\r\n\r\n```bash\r\nexport GRAPHLIT_ENVIRONMENT_ID=your_environment_id_value\r\nexport GRAPHLIT_ORGANIZATION_ID=your_organization_id_value\r\nexport GRAPHLIT_JWT_SECRET=your_secret_key_value\r\n```\r\n\r\nFor Windows Command Prompt (CMD):\r\n\r\n```cmd\r\nset GRAPHLIT_ENVIRONMENT_ID=your_environment_id_value\r\nset GRAPHLIT_ORGANIZATION_ID=your_organization_id_value\r\nset GRAPHLIT_JWT_SECRET=your_secret_key_value\r\n```\r\n\r\nFor Windows PowerShell:\r\n\r\n```powershell\r\n$env:GRAPHLIT_ENVIRONMENT_ID=\"your_environment_id_value\"\r\n$env:GRAPHLIT_ORGANIZATION_ID=\"your_organization_id_value\"\r\n$env:GRAPHLIT_JWT_SECRET=\"your_secret_key_value\"\r\n```\r\n\r\n## Tools\r\n\r\n- [Content Ingestion](#content-ingestion)\r\n- [RAG](#rag)\r\n- [Data Retrieval](#data-retrieval)\r\n- [Content Generation](#content-generation)\r\n- [Image Description](#image-description)\r\n- [Data Extraction](#data-extraction)\r\n\r\n### Content Ingestion\r\n\r\n#### URLIngestTool: Graphlit URL ingest tool\r\n##### Description\r\nIngests content from URL.\r\nReturns extracted Markdown text and metadata from content.\r\nCan ingest individual Word documents, PDFs, audio recordings, videos, images, or any other unstructured data.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| url | str | URL of cloud-hosted file to be ingested into knowledge base |\r\n\r\n#### LocalIngestTool: Graphlit local file ingest tool\r\n##### Description\r\nIngests content from local file.\r\nReturns extracted Markdown text and metadata from content.\r\nCan ingest individual Word documents, PDFs, audio recordings, videos, images, or any other unstructured data.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| file_path | str | Path of local file to be ingested into knowledge base |\r\n\r\n#### WebScrapeTool: Graphlit web scrape tool\r\n##### Description\r\nScrapes web page into knowledge base.\r\nReturns Markdown text and metadata extracted from web page.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| url | str | URL of web page to be scraped and ingested into knowledge base |\r\n\r\n#### WebCrawlTool: Graphlit web crawl tool\r\n##### Description\r\nCrawls web pages from web site into knowledge base.\r\nReturns Markdown text and metadata extracted from web pages.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| url | str | URL of web site to be crawled and ingested into knowledge base |\r\n| search | Optional[str] | Text to search for within ingested web pages |\r\n| read_limit | Optional[int] | Maximum number of web pages from web site to be crawled |\r\n\r\n#### WebSearchTool: Graphlit web search tool\r\n##### Description\r\nAccepts search query text as string.\r\nPerforms web search based on search query.\r\nReturns Markdown text and metadata extracted from web pages.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| search | str | Text to search for within web pages across the Internet |\r\n| search_limit | Optional[int] | Maximum number of web pages to be returned from web search |\r\n\r\n#### WebMapTool: Graphlit web map tool\r\n##### Description\r\nAccepts web page URL as string.\r\nEnumerates the web pages at or beneath the provided URL using web sitemap.\r\nReturns list of mapped URIs from web site.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| url | str | URL of the web page to be mapped |\r\n\r\n#### RedditIngestTool: Graphlit Reddit ingest tool\r\n##### Description\r\nIngests posts from Reddit subreddit into knowledge base.\r\nReturns extracted Markdown text and metadata from Reddit posts.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| subreddit_name | str | Reddit subreddit name to be read and ingested into knowledge base |\r\n| search | Optional[str] | Text to search for within ingested posts |\r\n| read_limit | Optional[int] | Maximum number of posts from Reddit subreddit to be read, defaults to 10 |\r\n\r\n#### NotionIngestTool: Graphlit Notion ingest tool\r\n##### Description\r\nIngests pages from Notion database into knowledge base.\r\nReturns extracted Markdown text and metadata from Notion pages.\r\n\r\nRequires NOTION_API_KEY to be assigned as environment variable.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| search | Optional[str] | Text to search for within ingested pages |\r\n| read_limit | Optional[int] | Maximum number of pages from Notion database to be read, defaults to 10 |\r\n\r\n#### RSSIngestTool: Graphlit RSS ingest tool\r\n##### Description\r\nIngests posts from RSS feed into knowledge base.\r\nFor podcast RSS feeds, audio will be transcribed and ingested into knowledge base.\r\nReturns extracted or transcribed Markdown text and metadata from RSS posts.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| url | str | RSS URL to be read and ingested into knowledge base |\r\n| search | Optional[str] | Text to search for within ingested posts and/or transcripts |\r\n| read_limit | Optional[int] | Maximum number of posts from RSS feed to be read, defaults to 10 |\r\n\r\n#### MicrosoftEmailIngestTool: Graphlit Microsoft Email ingest tool\r\n##### Description\r\nIngests emails from Microsoft Email account into knowledge base.\r\nReturns extracted Markdown text and metadata from emails.\r\n\r\nRequires MICROSOFT_EMAIL_CLIENT_ID, MICROSOFT_EMAIL_CLIENT_SECRET and MICROSOFT_EMAIL_REFRESH_TOKEN to be assigned as environment variables.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| search | Optional[str] | Text to search for within ingested email |\r\n| read_limit | Optional[int] | Maximum number of emails from Microsoft Email account to be read, defaults to 10 |\r\n\r\n#### GoogleEmailIngestTool: Graphlit Google Email ingest tool\r\n##### Description\r\nIngests emails from Google Email account into knowledge base.\r\nReturns extracted Markdown text and metadata from emails.\r\n\r\nRequires GOOGLE_EMAIL_CLIENT_ID, GOOGLE_EMAIL_CLIENT_SECRET and GOOGLE_EMAIL_REFRESH_TOKEN to be assigned as environment variables.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| search | Optional[str] | Text to search for within ingested email |\r\n| read_limit | Optional[int] | Maximum number of emails from Google Email account to be read, defaults to 10 |\r\n\r\n#### GitHubIssueIngestTool: Graphlit GitHub Issue ingest tool\r\n##### Description\r\nIngests issues from GitHub repository into knowledge base.\r\nAccepts GitHub repository owner and repository name.\r\nFor example, for GitHub repository (https://github.com/openai/tiktoken), 'openai' is the repository owner, and 'tiktoken' is the repository name.\r\nReturns extracted Markdown text and metadata from issues.\r\n\r\nRequires GITHUB_PERSONAL_ACCESS_TOKEN to be assigned as environment variable.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| repository_name | str | GitHub repository name |\r\n| repository_owner | str | GitHub repository owner |\r\n| search | Optional[str] | Text to search for within ingested issues |\r\n| read_limit | Optional[int] | Maximum number of issues from GitHub repository to be read, defaults to 10 |\r\n\r\n#### JiraIssueIngestTool: Graphlit Jira ingest tool\r\n##### Description\r\nIngests issues from Atlassian Jira into knowledge base.\r\nAccepts Atlassian Jira server URL and project name.\r\nReturns extracted Markdown text and metadata from issues.\r\n\r\nRequires JIRA_TOKEN and JIRA_EMAIL to be assigned as environment variables.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| url | str | Atlassian Jira server URL |\r\n| project | str | Atlassian Jira project name |\r\n| search | Optional[str] | Text to search for within ingested issues |\r\n| read_limit | Optional[int] | Maximum number of issues from Jira project to be read, defaults to 10 |\r\n\r\n#### LinearIssueIngestTool: Graphlit Linear ingest tool\r\n##### Description\r\nIngests issues from Linear project into knowledge base.\r\nAccepts Linear project name.\r\nReturns extracted Markdown text and metadata from issues.\r\n\r\nRequires LINEAR_API_KEY to be assigned as environment variable.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| project | str | Linear project name |\r\n| search | Optional[str] | Text to search for within ingested issues |\r\n| read_limit | Optional[int] | Maximum number of issues from Linear project to be read, defaults to 10 |\r\n\r\n#### MicrosoftTeamsIngestTool: Graphlit Microsoft Teams ingest tool\r\n##### Description\r\nIngests messages from Microsoft Teams channel into knowledge base.\r\nReturns extracted Markdown text and metadata from messages.\r\n\r\nRequires MICROSOFT_TEAMS_CLIENT_ID, MICROSOFT_TEAMS_CLIENT_SECRET and MICROSOFT_TEAMS_REFRESH_TOKEN to be assigned as environment variables.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| team_name | str | Microsoft Teams team name |\r\n| channel_name | str | Microsoft Teams channel name |\r\n| search | Optional[str] | Text to search for within ingested messages |\r\n| read_limit | Optional[int] | Maximum number of messages from Microsoft Teams channel to be read, defaults to 10 |\r\n\r\n#### DiscordIngestTool: Graphlit Discord ingest tool\r\n##### Description\r\nIngests messages from Discord channel into knowledge base.\r\nAccepts Discord channel name.\r\nReturns extracted Markdown text and metadata from messages.\r\n\r\nRequires DISCORD_BOT_TOKEN to be assigned as environment variable.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| channel_name | str | Discord channel name |\r\n| search | Optional[str] | Text to search for within ingested messages |\r\n| read_limit | Optional[int] | Maximum number of messages from Discord channel to be read, defaults to 10 |\r\n\r\n#### SlackIngestTool: Graphlit Slack ingest tool\r\n##### Description\r\nIngests messages from Slack channel into knowledge base.\r\nAccepts Slack channel name.\r\nReturns extracted Markdown text and metadata from messages.\r\n\r\nRequires SLACK_BOT_TOKEN to be assigned as environment variable.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| channel_name | str | Slack channel name |\r\n| search | Optional[str] | Text to search for within ingested messages |\r\n| read_limit | Optional[int] | Maximum number of messages from Slack channel to be read, defaults to 10 |\r\n\r\n### RAG\r\n\r\n#### PromptTool: Graphlit RAG prompt tool\r\n##### Description\r\nAccepts user prompt as string.\r\nPrompts LLM with relevant content and returns completion from RAG pipeline. Returns Markdown text from LLM completion.\r\nUses vector embeddings and similarity search to retrieve relevant content from knowledge base.\r\nCan search through web pages, PDFs, audio transcripts, and other unstructured data.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| prompt | str | Text prompt which is provided to LLM for completion, via RAG pipeline |\r\n\r\n### Data Retrieval\r\n\r\n#### ContentRetrievalTool: Graphlit content retrieval tool\r\n##### Description\r\nAccepts search text as string.\r\nOptionally accepts a list of content types (i.e. FILE, PAGE, EMAIL, ISSUE, MESSAGE) for filtering the result set.\r\nRetrieves contents based on similarity search from knowledge base.\r\nReturns extracted Markdown text and metadata from contents relevant to the search text.\r\nCan search through web pages, PDFs, audio transcripts, Slack messages, emails, or any unstructured data ingested into the knowledge base.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| text | str | Text to search for within the knowledge base |\r\n| types | Optional[List[ContentTypes]] | List of content types (i.e. FILE, PAGE, EMAIL, ISSUE, MESSAGE) to be returned from knowledge base |\r\n| limit | Optional[int] | Number of contents to return from search query |\r\n\r\n#### PersonRetrievalTool: Graphlit person retrieval tool\r\n##### Description\r\nAccepts search text as string.\r\nRetrieves persons based on similarity search from knowledge base.\r\nReturns metadata from persons relevant to the search text.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| search | str | Text to search for within the knowledge base |\r\n| limit | Optional[int] | Number of persons to return from search query |\r\n\r\n#### OrganizationRetrievalTool: Graphlit organization retrieval tool\r\n##### Description\r\nAccepts search text as string.\r\nRetrieves organizations based on similarity search from knowledge base.\r\nReturns metadata from organizations relevant to the search text.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| search | str | Text to search for within the knowledge base |\r\n| limit | Optional[int] | Number of organizations to return from search query |\r\n\r\n### Image Description\r\n\r\n#### DescribeImageTool: Graphlit image description tool\r\n##### Description\r\nAccepts image URL as string.\r\nPrompts vision LLM and returns completion. Returns Markdown text from LLM completion.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| url | str | URL for image to be described with vision LLM |\r\n| prompt | str | Text prompt which is provided to vision LLM for completion |\r\n\r\n#### DescribeWebPageTool: Graphlit screenshot web page tool\r\n##### Description\r\nScreenshots web page from URL and describes web page with vision LLM.\r\nReturns Markdown description of screenshot and extracted Markdown text from image.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| url | str | URL of web page to screenshot and ingest into knowledge base |\r\n| prompt | Optional[str] | Text prompt which is provided to vision LLM for screenshot description |\r\n\r\n### Content Generation\r\n\r\n#### GenerateSummaryTool: Graphlit summary generation tool\r\n##### Description\r\nAccepts text as string.\r\nOptionally accepts text prompt to be provided to LLM for text summarization.\r\nReturns summary as text.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| text | str | Text to be summarized |\r\n| prompt | Optional[str] | Text prompt which is provided to LLM for text summarization |\r\n\r\n#### GenerateBulletsTool: Graphlit bullet points generation tool\r\n##### Description\r\nAccepts text as string.\r\nOptionally accepts the count of bullet points to be generated.\r\nReturns bullet points as text.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| text | str | Text to be summarized into bullet points |\r\n| count | Optional[int] | Number of bullet points to be generated |\r\n\r\n#### GenerateHeadlinesTool: Graphlit headlines generation tool\r\n##### Description\r\nAccepts text as string.\r\nOptionally accepts the count of headlines to be generated.\r\nReturns headlines as text.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| text | str | Text to be summarized into headlines |\r\n| count | Optional[int] | Number of headlines to be generated |\r\n\r\n#### GenerateSocialMediaPostsTool: : Graphlit social media posts generation tool\r\n##### Description\r\nAccepts text as string.\r\nOptionally accepts the count of social media posts to be generated.\r\nReturns social media posts as text.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| text | str | Text to be summarized into social media posts |\r\n| count | Optional[int] | Number of social media posts to be generated |\r\n\r\n#### GenerateQuestionsTool: Graphlit followup questions generation tool\r\n##### Description\r\nAccepts text as string.\r\nOptionally accepts the count of followup questions to be generated.\r\nReturns followup questions as text.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| text | str | Text to be summarized into followup questions |\r\n| count | Optional[int] | Number of followup questions to be generated |\r\n\r\n#### GenerateKeywordsTool: Graphlit keywords generation tool\r\n##### Description\r\nAccepts text as string.\r\nOptionally accepts the count of keywords to be generated.\r\nReturns keywords as text.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| text | str | Text to be summarized into keywords |\r\n| count | Optional[int] | Number of keywords to be generated |\r\n\r\n#### GenerateChaptersTool: Graphlit transcript chapters generation tool\r\n##### Description\r\nAccepts transcript as string.\r\nReturns chapters as text.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| text | str | Transcript to be summarized into chapters. Assumes transcript contains time-stamped text. |\r\n\r\n### Data Extraction\r\n\r\n#### ExtractURLTool: Graphlit JSON URL data extraction tool\r\n##### Description\r\nExtracts JSON data from ingested file using LLM.\r\nAccepts URL to be ingested, and JSON schema of Pydantic model to be extracted into. JSON schema needs be of type 'object' and include 'properties' and 'required' fields.\r\nReturns extracted JSON from file.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| uri | str | URL of cloud-hosted file to be ingested into knowledge base |\r\n| model_schema | str | Pydantic model JSON schema which describes the data which will be extracted. JSON schema needs be of type 'object' and include 'properties' and 'required' fields. |\r\n| prompt | Optional[str] | Text prompt which is provided to LLM to guide data extraction |\r\n\r\n#### ExtractWebPageTool: Graphlit JSON web page data extraction tool\r\n##### Description\r\nExtracts JSON data from ingested web page using LLM.\r\nAccepts URL to be scraped, and JSON schema of Pydantic model to be extracted into. JSON schema needs be of type 'object' and include 'properties' and 'required' fields.\r\nReturns extracted JSON from web page.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| uri | str | URL of web page to be scraped and ingested into knowledge base |\r\n| model_schema | str | Pydantic model JSON schema which describes the data which will be extracted. JSON schema needs be of type 'object' and include 'properties' and 'required' fields. |\r\n| prompt | Optional[str] | Text prompt which is provided to LLM to guide data extraction |\r\n\r\n#### ExtractTextTool: Graphlit JSON text data extraction tool\r\n##### Description\r\nExtracts JSON data from text using LLM.\r\nAccepts text to be scraped, and JSON schema of Pydantic model to be extracted into. JSON schema needs be of type 'object' and include 'properties' and 'required' fields.\r\nReturns extracted JSON from text.\r\n\r\n##### Parameters\r\n| Name | Type | Description |\r\n| ---- | ---- | ---- |\r\n| text | str | Text to be extracted with LLM |\r\n| model_schema | str | Pydantic model JSON schema which describes the data which will be extracted. JSON schema needs be of type 'object' and include 'properties' and 'required' fields. |\r\n| prompt | Optional[str] | Text prompt which is provided to LLM to guide data extraction |\r\n\r\n## Support\r\n\r\nPlease refer to the [Graphlit API Documentation](https://docs.graphlit.dev/).\r\n\r\nFor support with the Graphlit Agent Tools or to request an additional tool, please submit a [GitHub Issue](https://github.com/graphlit/graphlit-tools-python/issues).  \r\n\r\nFor further support with the Graphlit Platform, please join our [Discord](https://discord.gg/ygFmfjy3Qx) community.\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphlit%2Fgraphlit-tools-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgraphlit%2Fgraphlit-tools-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphlit%2Fgraphlit-tools-python/lists"}