glean-agent-toolkit 0.2.0__py3-none-any.whl

glean/agent_toolkit/tools/web_search.py

@@ -0,0 +1,38 @@
+"""Web Search tool for searching the internet."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from glean.agent_toolkit.decorators import tool_spec
+from glean.agent_toolkit.tools._common import run_tool
+from glean.api_client import models
+
+
+@tool_spec(
+    name="web_search",
+    description=(
+        "Can search for up-to-date external information from the web. Closely evaluate the "
+        "instructions below for the user query to decide whether to use web search. If you think "
+        "the scenarios are contradictory, do not use web search unless there is clear user intent."
+        "\n"
+        "INSTRUCTIONS:\n"
+        "Examples of when to use this tool:\n"
+        "- User Intent: Use this tool if the user is asking you to search the web, look online, "
+        "provide links/sources, or explicitly looking for current external information (outside "
+        "of the company) like weather, news, latest updates/plans, or financial data.\n"
+        "- Freshness: Use this tool if you need up-to-date information on time-dependent topics "
+        "or any time you would otherwise refuse to answer a question because your knowledge might "
+        "be out of date.\n"
+        "- Niche Information: If the answer would likely change based on detailed information not "
+        "widely known or understood (which might be found on the internet), use web sources "
+        "directly rather than relying on the distilled knowledge from pretraining.\n"
+        "- Do NOT use this tool for programming related queries. You already know enough about "
+        "those.\n"
+        "- Do NOT use this tool for queries seeking general ideas, which may not benefit from "
+        "specific information."
+    ),
+)
+def web_search(parameters: dict[str, models.ToolsCallParameter]) -> dict[str, Any]:
+    """Search the web for up-to-date external information."""
+    return run_tool("Web Browser", parameters)

glean_agent_toolkit-0.2.0.dist-info/METADATA

@@ -0,0 +1,320 @@
+Metadata-Version: 2.4
+Name: glean-agent-toolkit
+Version: 0.2.0
+Summary: AI Agent toolkit for adapting Glean's enterprise tools across multiple frameworks
+Project-URL: Source Code, https://github.com/gleanwork/glean-agent-toolkit
+Author-email: Steve Calvert <steve.calvert@glean.com>
+License: MIT
+License-File: LICENSE
+Requires-Python: <4.0,>=3.10
+Requires-Dist: glean-api-client<1.0,>=0.6.0
+Requires-Dist: pydantic<3.0,>=2.7
+Provides-Extra: adk
+Requires-Dist: google-adk<1.0,>=0.1.0; extra == 'adk'
+Provides-Extra: codespell
+Requires-Dist: codespell<3.0,>=2.2.6; extra == 'codespell'
+Provides-Extra: crewai
+Requires-Dist: crewai<1.0,>=0.28.0; extra == 'crewai'
+Provides-Extra: dev
+Requires-Dist: commitizen<5.0,>=4.4.1; extra == 'dev'
+Requires-Dist: pip-audit<3.0,>=2.6.0; extra == 'dev'
+Requires-Dist: vcrpy<7.0,>=6.0.2; extra == 'dev'
+Provides-Extra: langchain
+Requires-Dist: langchain<1.0,>=0.1.0; extra == 'langchain'
+Provides-Extra: lint
+Requires-Dist: ruff<1.0,>=0.5; extra == 'lint'
+Provides-Extra: openai
+Requires-Dist: openai-agents<1.0,>=0.0.11; extra == 'openai'
+Requires-Dist: openai<2.0,>=1.0.0; extra == 'openai'
+Provides-Extra: test
+Requires-Dist: crewai<1.0,>=0.28.0; extra == 'test'
+Requires-Dist: google-adk<1.0,>=0.1.0; extra == 'test'
+Requires-Dist: langchain<1.0,>=0.1.0; extra == 'test'
+Requires-Dist: openai-agents<1.0,>=0.0.11; extra == 'test'
+Requires-Dist: openai<2.0,>=1.0.0; extra == 'test'
+Requires-Dist: pytest-asyncio<1.0,>=0.23.2; extra == 'test'
+Requires-Dist: pytest-cov<6.0,>=4.1.0; extra == 'test'
+Requires-Dist: pytest-httpx<1.0,>=0.35.0; extra == 'test'
+Requires-Dist: pytest<9.0,>=7.4.3; extra == 'test'
+Provides-Extra: typing
+Requires-Dist: pyright<2.0,>=1.1.370; extra == 'typing'
+Description-Content-Type: text/markdown
+
+# Glean Agent Toolkit
+
+The Glean Agent Toolkit makes it easy to integrate Glean's powerful search and knowledge discovery capabilities into your AI agents. Use our pre-built tools with popular agent frameworks like OpenAI Assistants, LangChain, CrewAI, and Google's Agent Development Kit (ADK), or adapt your own custom tools for cross-framework use.
+
+## Key Features
+
+* **Production-Ready Glean Tools:** Instantly add capabilities like enterprise search, employee lookup, calendar search, Gmail search, and more to your agents.
+* **Framework Adapters:** Seamlessly convert Glean tools into formats compatible with major agent SDKs.
+* **Custom Tool Creation:** Define your own tools once using the `@tool_spec` decorator and use them across any supported framework.
+
+## Installation
+
+Install the base toolkit:
+
+```bash
+pip install glean-agent-toolkit
+```
+
+To include support for specific agent frameworks, install the relevant extras:
+
+```bash
+pip install glean-agent-toolkit[openai]
+pip install glean-agent-toolkit[adk]
+pip install glean-agent-toolkit[langchain]
+pip install glean-agent-toolkit[crewai]
+```
+
+You can also install all extras:
+
+```bash
+pip install glean-agent-toolkit[all]
+```
+
+Note: The `[openai]` extra installs the standard `openai` Python library, used for direct API interactions like Chat Completions or the Assistants API. The example below for the "OpenAI Agents SDK" uses a separate library, `openai-agents`, which you'll need to install independently: `pip install openai-agents`.
+
+## Prerequisites
+
+Before using any Glean tools, you'll need:
+
+1. **Glean API credentials**: Obtain these from your Glean administrator
+2. **Environment variables**:
+   ```bash
+   export GLEAN_API_TOKEN="your-api-token"
+   export GLEAN_INSTANCE="your-instance-name"
+   ```
+
+## Available Tools
+
+The toolkit comes with a suite of production-ready tools that connect to various Glean functionalities:
+
+* **`glean_search`**: Search your company's knowledge base for relevant documents and information
+* **`web_search`**: Search the public web for up-to-date external information
+* **`ai_web_search`**: Query Google Gemini for AI-powered web information
+* **`calendar_search`**: Find meetings and calendar events
+* **`employee_search`**: Search for employees by name, team, department, or expertise
+* **`code_search`**: Search your company's source code repositories
+* **`gmail_search`**: Search Gmail messages and conversations
+* **`outlook_search`**: Search Outlook mail and calendar items
+
+## Quick Start Examples
+
+### Using `glean_search` with Different Frameworks
+
+#### OpenAI Agents SDK
+
+```python
+import os
+from glean.agent_toolkit.tools import glean_search
+from agents import Agent, Runner
+
+# Ensure environment variables are set
+assert os.getenv("GLEAN_API_TOKEN"), "GLEAN_API_TOKEN must be set"
+assert os.getenv("GLEAN_INSTANCE"), "GLEAN_INSTANCE must be set"
+assert os.getenv("OPENAI_API_KEY"), "OPENAI_API_KEY must be set"
+
+# Create an agent with the Glean search tool
+agent = Agent(
+    name="KnowledgeAssistant",
+    instructions="You help users find information from the company knowledge base using Glean search.",
+    tools=[glean_search.func]  # Use the underlying function
+)
+
+# Run a search query
+result = Runner.run_sync(agent, "Find our Q4 planning documents")
+print(f"Search results: {result.final_output}")
+```
+
+#### LangChain
+
+```python
+import os
+from glean.agent_toolkit.tools import glean_search
+from langchain_openai import ChatOpenAI
+from langchain.agents import AgentExecutor, create_react_agent
+from langchain_core.prompts import ChatPromptTemplate
+
+# Ensure environment variables are set
+assert os.getenv("GLEAN_API_TOKEN"), "GLEAN_API_TOKEN must be set"
+assert os.getenv("GLEAN_INSTANCE"), "GLEAN_INSTANCE must be set"
+
+# Convert to LangChain tool format
+langchain_tool = glean_search.as_langchain_tool()
+
+llm = ChatOpenAI(model="gpt-4", temperature=0)
+tools = [langchain_tool]
+
+prompt_template = """You are a helpful assistant with access to company knowledge.
+Use the glean_search tool to find relevant information when users ask questions.
+
+Tools available:
+{tools}
+
+Use this format:
+Question: {input}
+Thought: I should search for information about this topic
+Action: {tool_names}
+Action Input: your search query
+Observation: the search results
+Thought: I can now provide a helpful response
+Final Answer: your response based on the search results
+
+Question: {input}
+{agent_scratchpad}"""
+
+prompt = ChatPromptTemplate.from_template(prompt_template)
+agent = create_react_agent(llm, tools, prompt)
+agent_executor = AgentExecutor(agent=agent, tools=tools, verbose=True)
+
+# Search for company information
+result = agent_executor.invoke({"input": "What is our vacation policy?"})
+print(result["output"])
+```
+
+#### CrewAI
+
+```python
+import os
+from glean.agent_toolkit.tools import glean_search
+from crewai import Agent, Task, Crew
+
+# Ensure environment variables are set
+assert os.getenv("GLEAN_API_TOKEN"), "GLEAN_API_TOKEN must be set"
+assert os.getenv("GLEAN_INSTANCE"), "GLEAN_INSTANCE must be set"
+
+# Convert to CrewAI tool format
+crewai_tool = glean_search.as_crewai_tool()
+
+# Create a research agent
+researcher = Agent(
+    role="Corporate Knowledge Researcher",
+    goal="Find and summarize relevant company information",
+    backstory="You are an expert at navigating company knowledge bases to find accurate, up-to-date information.",
+    tools=[crewai_tool],
+    verbose=True
+)
+
+# Create a research task
+research_task = Task(
+    description="Find information about our company's remote work policy and summarize the key points.",
+    expected_output="A clear summary of the remote work policy including eligibility, expectations, and guidelines.",
+    agent=researcher
+)
+
+# Execute the research
+crew = Crew(agents=[researcher], tasks=[research_task])
+result = crew.kickoff()
+print(result)
+```
+
+### Real-World Use Cases
+
+#### Employee Directory Search
+
+```python
+from glean.agent_toolkit.tools import employee_search
+
+# Find engineering team members
+engineering_team = employee_search.as_langchain_tool()
+
+# Example usage in an agent:
+# "Who are the senior engineers in the backend team?"
+# "Find Sarah Johnson's contact information"
+# "List all product managers in the San Francisco office"
+```
+
+#### Code Discovery
+
+```python
+from glean.agent_toolkit.tools import code_search
+
+# Search company codebases
+code_tool = code_search.as_langchain_tool()
+
+# Example queries:
+# "Find authentication middleware implementations"
+# "Show me recent changes to the payment processing module"
+# "Locate configuration files for the staging environment"
+```
+
+#### Email and Calendar Integration
+
+```python
+from glean.agent_toolkit.tools import gmail_search, calendar_search
+
+# Search emails and meetings
+gmail_tool = gmail_search.as_langchain_tool()
+calendar_tool = calendar_search.as_langchain_tool()
+
+# Example queries:
+# "Find emails about the product launch from last month"
+# "Show me my meetings with the design team this week"
+# "Search for messages containing budget discussions"
+```
+
+#### Web Research with Context
+
+```python
+from glean.agent_toolkit.tools import web_search, ai_web_search
+
+# External information gathering
+web_tool = web_search.as_langchain_tool()
+ai_web_tool = ai_web_search.as_langchain_tool()
+
+# Example queries:
+# "Latest industry trends in machine learning"
+# "Current market analysis for SaaS companies"
+# "Recent news about our competitors"
+```
+
+## Creating Custom Tools with `@tool_spec`
+
+Define your own tools that work across all supported frameworks:
+
+```python
+from glean.agent_toolkit import tool_spec
+from pydantic import BaseModel
+import requests
+
+class WeatherResponse(BaseModel):
+    temperature: float
+    condition: str
+    humidity: int
+    city: str
+
+@tool_spec(
+    name="get_current_weather",
+    description="Get current weather information for a specified city",
+    output_model=WeatherResponse
+)
+def get_weather(city: str, units: str = "celsius") -> WeatherResponse:
+    """Fetch current weather for a city."""
+    # Replace with actual weather API call
+    api_key = os.getenv("WEATHER_API_KEY")
+    response = requests.get(
+        f"https://api.weather.com/v1/current?key={api_key}&q={city}&units={units}"
+    )
+    data = response.json()
+    
+    return WeatherResponse(
+        temperature=data["temp"],
+        condition=data["condition"],
+        humidity=data["humidity"],
+        city=city
+    )
+
+# Use across frameworks
+openai_weather = get_weather.as_openai_tool()
+langchain_weather = get_weather.as_langchain_tool()
+crewai_weather = get_weather.as_crewai_tool()
+```
+
+## Contributing
+
+Interested in contributing? Check out our [Contributing Guide](CONTRIBUTING.md) for instructions on setting up the development environment and submitting changes.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE). 

glean_agent_toolkit-0.2.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+glean/agent_toolkit/__init__.py,sha256=4-Ad_YoKmttpEnvYS5HmGcbTmVilkQ5kci-9ripPhpU,681
+glean/agent_toolkit/decorators.py,sha256=CRphbndMjHdv8MAVg7IjVoEyHCS5bRl1R2UOCwAXRjY,8308
+glean/agent_toolkit/py.typed,sha256=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
+glean/agent_toolkit/registry.py,sha256=YixBYT4NpVexAucBY6nLH5WOYEzpxhVukp_sIYyWugA,1196
+glean/agent_toolkit/spec.py,sha256=PJpbDdpdIjbdeCG3wsNzQZ0PtazzIzt9e7hgUONo3FY,1389
+glean/agent_toolkit/adapters/__init__.py,sha256=lW--I7NeONJJYoled5myvvJXexh2aELu8izS4A4NfKw,652
+glean/agent_toolkit/adapters/adk.py,sha256=GCrpp0T5Zz6JDfe2zOlvVck_oJY5J4BTqjjHauJpCDo,2535
+glean/agent_toolkit/adapters/base.py,sha256=Hz8LqY-0uKMNC9WsyaLNw4ctw7WYdB15tOCs8ZV3qk0,750
+glean/agent_toolkit/adapters/crewai.py,sha256=35C61F1Bs4oCDk2Eq1OYFZqqj0Qt5nDuhnYICZux5ao,6493
+glean/agent_toolkit/adapters/langchain.py,sha256=UEzKi-EVq32mOXosSG-CS3lnlRy7eVjs5CMTqQ61hcQ,4792
+glean/agent_toolkit/adapters/openai.py,sha256=q6N5rzc9Y8ZUQxlOUy9om1xFtE8NRScohWqDf4I7rjI,4404
+glean/agent_toolkit/tools/__init__.py,sha256=1hnBzI_yR6oi6R2EAylJp-MwtfP_sR6Tqt_FkJVFDVc,1126
+glean/agent_toolkit/tools/_common.py,sha256=2b0l44O-7Wq40x0jmxSMlgK7bKPzKcaKQW7uYhQYqaE,994
+glean/agent_toolkit/tools/ai_web_search.py,sha256=wluXrAqB4IQW0bVavtNHk_niPMVuBEdd4Q6qpLIumpk,2151
+glean/agent_toolkit/tools/calendar_search.py,sha256=GXer9Cfrg4cA2iH5zYsXMe_QjnxBasfNIgx3Sooco5E,565
+glean/agent_toolkit/tools/code_search.py,sha256=QdF3_2SRF0151gtAAetk2Z816wp_tHzmhKZ3-6AlLHM,1006
+glean/agent_toolkit/tools/employee_search.py,sha256=heTHPEVJPZDLmZKLL18v8w-OQIJGrIwye56jHyrI0NU,1460
+glean/agent_toolkit/tools/glean_search.py,sha256=qV1ZtW5d-KituBTTMrTbRVoL8pd1AWYukNcb9cjbFvw,947
+glean/agent_toolkit/tools/gmail_search.py,sha256=KmKqXFSngz4TQD6wkD9IhzF2H12P-rI4OMl56eGGC-Y,765
+glean/agent_toolkit/tools/outlook_search.py,sha256=YBeFmY3BIso6UmROXZan_GukvJjWhiq9u2vOaPRNz5E,775
+glean/agent_toolkit/tools/web_search.py,sha256=hIcmgbPYxPoLPLeLAmfQpqlkm0g9xH7Bfr_iRaOXAMY,1925
+glean_agent_toolkit-0.2.0.dist-info/METADATA,sha256=PID5jnkBqfQrCzev6UdYMHHay3LoSyaxcoE6bFBNmf0,10574
+glean_agent_toolkit-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+glean_agent_toolkit-0.2.0.dist-info/licenses/LICENSE,sha256=RAfePGwatR5BOtlNhW60zAKWCeHVgtGpaGBqZQadXNQ,1062
+glean_agent_toolkit-0.2.0.dist-info/RECORD,,

glean_agent_toolkit-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

glean_agent_toolkit-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Glean
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.