mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 05:38:12 +00:00
a237ebabba
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
108 lines
3.9 KiB
Plaintext
108 lines
3.9 KiB
Plaintext
---
|
|
title: Google Serper Search
|
|
description: The `SerperDevTool` is designed to search the internet and return the most relevant results.
|
|
icon: google
|
|
mode: "wide"
|
|
---
|
|
|
|
# `SerperDevTool`
|
|
|
|
## Description
|
|
|
|
This tool is designed to perform a semantic search for a specified query from a text's content across the internet. It utilizes the [serper.dev](https://serper.dev) API
|
|
to fetch and display the most relevant search results based on the query provided by the user.
|
|
|
|
## Installation
|
|
|
|
To effectively use the `SerperDevTool`, follow these steps:
|
|
|
|
1. **Package Installation**: Confirm that the `crewai[tools]` package is installed in your Python environment.
|
|
2. **API Key Acquisition**: Acquire a `serper.dev` API key at https://serper.dev/ (free tier available).
|
|
3. **Environment Configuration**: Store your obtained API key in an environment variable named `SERPER_API_KEY` to facilitate its use by the tool.
|
|
|
|
To incorporate this tool into your project, follow the installation instructions below:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
## Example
|
|
|
|
The following example demonstrates how to initialize the tool and execute a search with a given query:
|
|
|
|
```python Code
|
|
from crewai_tools import SerperDevTool
|
|
|
|
# Initialize the tool for internet searching capabilities
|
|
tool = SerperDevTool()
|
|
```
|
|
|
|
## Parameters
|
|
|
|
The `SerperDevTool` comes with several parameters that will be passed to the API :
|
|
|
|
- **search_url**: The URL endpoint for the search API. (Default is `https://google.serper.dev/search`)
|
|
|
|
- **country**: Optional. Specify the country for the search results.
|
|
- **location**: Optional. Specify the location for the search results.
|
|
- **locale**: Optional. Specify the locale for the search results.
|
|
- **n_results**: Number of search results to return. Default is `10`.
|
|
|
|
The values for `country`, `location`, `locale` and `search_url` can be found on the [Serper Playground](https://serper.dev/playground).
|
|
|
|
## Example with Parameters
|
|
|
|
Here is an example demonstrating how to use the tool with additional parameters:
|
|
|
|
```python Code
|
|
from crewai_tools import SerperDevTool
|
|
|
|
tool = SerperDevTool(
|
|
search_url="https://google.serper.dev/scholar",
|
|
n_results=2,
|
|
)
|
|
|
|
print(tool.run(search_query="ChatGPT"))
|
|
|
|
# Using Tool: Search the internet
|
|
|
|
# Search results: Title: Role of chat gpt in public health
|
|
# Link: https://link.springer.com/article/10.1007/s10439-023-03172-7
|
|
# Snippet: … ChatGPT in public health. In this overview, we will examine the potential uses of ChatGPT in
|
|
# ---
|
|
# Title: Potential use of chat gpt in global warming
|
|
# Link: https://link.springer.com/article/10.1007/s10439-023-03171-8
|
|
# Snippet: … as ChatGPT, have the potential to play a critical role in advancing our understanding of climate
|
|
# ---
|
|
|
|
```
|
|
|
|
```python Code
|
|
from crewai_tools import SerperDevTool
|
|
|
|
tool = SerperDevTool(
|
|
country="fr",
|
|
locale="fr",
|
|
location="Paris, Paris, Ile-de-France, France",
|
|
n_results=2,
|
|
)
|
|
|
|
print(tool.run(search_query="Jeux Olympiques"))
|
|
|
|
# Using Tool: Search the internet
|
|
|
|
# Search results: Title: Jeux Olympiques de Paris 2024 - Actualités, calendriers, résultats
|
|
# Link: https://olympics.com/fr/paris-2024
|
|
# Snippet: Quels sont les sports présents aux Jeux Olympiques de Paris 2024 ? · Athlétisme · Aviron · Badminton · Basketball · Basketball 3x3 · Boxe · Breaking · Canoë ...
|
|
# ---
|
|
# Title: Billetterie Officielle de Paris 2024 - Jeux Olympiques et Paralympiques
|
|
# Link: https://tickets.paris2024.org/
|
|
# Snippet: Achetez vos billets exclusivement sur le site officiel de la billetterie de Paris 2024 pour participer au plus grand événement sportif au monde.
|
|
# ---
|
|
```
|
|
|
|
## Conclusion
|
|
|
|
By integrating the `SerperDevTool` into Python projects, users gain the ability to conduct real-time, relevant searches across the internet directly from their applications.
|
|
The updated parameters allow for more customized and localized search results. By adhering to the setup and usage guidelines provided, incorporating this tool into projects is streamlined and straightforward.
|