feature #952 [Agent][SerpApi] Add symfony/ai-serpapi-tool (OskarStark)

OskarStark · OskarStark · commit 5b730c315103 · 2025-11-23T00:03:58.000+01:00
This PR was squashed before being merged into the main branch. Discussion ---------- [Agent][SerpApi] Add `symfony/ai-serpapi-tool` | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | Docs? | no | Issues | -- | License | MIT ### Needs - [ ] A new repo `symfony/ai-serpapi-tool` - [ ] Add Packagist configuration - [ ] Create a new label `SerpAPI` - [x] Create a recipe in `symfony/recipes` - [ ] Merge the recipe symfony/recipes#1488 Commits ------- c21a43d [Agent][SerpApi] Add `symfony/ai-serpapi-tool`
diff --git a/demo/composer.json b/demo/composer.json
@@ -15,6 +15,7 @@
         "runtime/frankenphp-symfony": "^0.2.0",
         "symfony/ai-bundle": "@dev",
         "symfony/ai-openmeteo-tool": "@dev",
+        "symfony/ai-serpapi-tool": "@dev",
         "symfony/asset": "~7.3.0",
         "symfony/asset-mapper": "~7.3.0",
         "symfony/clock": "~7.3.0",
diff --git a/demo/config/packages/ai.yaml b/demo/config/packages/ai.yaml
@@ -107,7 +107,7 @@ services:
 
     # Symfony\AI\Agent\Toolbox\Tool\Clock: ~
     # Symfony\AI\Agent\Bridge\OpenMeteo\OpenMeteo: ~
-    # Symfony\AI\Agent\Toolbox\Tool\SerpApi:
+    # Symfony\AI\Agent\Bridge\SerpApi\SerpApi:
     #     $apiKey: '%env(SERP_API_KEY)%'
     Symfony\AI\Agent\Toolbox\Tool\Wikipedia: ~
     Symfony\AI\Agent\Toolbox\Tool\SimilaritySearch:
diff --git a/docs/bundles/ai-bundle.rst b/docs/bundles/ai-bundle.rst
@@ -779,6 +779,7 @@ The following tools can be installed as dedicated packages, no configuration is
     $ composer require symfony/ai-firecrawl-tool
     $ composer require symfony/ai-mapbox-tool
     $ composer require symfony/ai-openmeteo-tool
+    $ composer require symfony/ai-serpapi-tool
     $ composer require symfony/ai-tavily-tool
 
 For tools not available as dedicated packages (those in the ``Toolbox\Tool`` namespace), register them manually as services:
@@ -791,8 +792,6 @@ For tools not available as dedicated packages (those in the ``Toolbox\Tool`` nam
             autoconfigure: true
 
         Symfony\AI\Agent\Toolbox\Tool\Clock: ~
-        Symfony\AI\Agent\Toolbox\Tool\SerpApi:
-            $apiKey: '%env(SERP_API_KEY)%'
         Symfony\AI\Agent\Toolbox\Tool\SimilaritySearch: ~
         Symfony\AI\Agent\Toolbox\Tool\Wikipedia: ~
         Symfony\AI\Agent\Toolbox\Tool\YouTubeTranscriber: ~
diff --git a/examples/toolbox/serpapi.php b/examples/toolbox/serpapi.php
@@ -10,10 +10,10 @@
  */
 
 use Symfony\AI\Agent\Agent;
+use Symfony\AI\Agent\Bridge\SerpApi\SerpApi;
 use Symfony\AI\Agent\Toolbox\AgentProcessor;
 use Symfony\AI\Agent\Toolbox\Tool\Clock;
 use Symfony\AI\Agent\Toolbox\Tool\Scraper;
-use Symfony\AI\Agent\Toolbox\Tool\SerpApi;
 use Symfony\AI\Agent\Toolbox\Toolbox;
 use Symfony\AI\Platform\Bridge\OpenAi\PlatformFactory;
 use Symfony\AI\Platform\Message\Message;
diff --git a/src/agent/src/Bridge/SerpApi/.gitattributes b/src/agent/src/Bridge/SerpApi/.gitattributes
@@ -0,0 +1,3 @@
+/Tests export-ignore
+/phpunit.xml.dist export-ignore
+/.git* export-ignore
diff --git a/src/agent/src/Bridge/SerpApi/.github/PULL_REQUEST_TEMPLATE.md b/src/agent/src/Bridge/SerpApi/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,8 @@
+Please do not submit any Pull Requests here. They will be closed.
+---
+
+Please submit your PR here instead:
+https://github.com/symfony/ai
+
+This repository is what we call a "subtree split": a read-only subset of that main repository.
+We're looking forward to your PR there!
diff --git a/src/agent/src/Bridge/SerpApi/.github/close-pull-request.yml b/src/agent/src/Bridge/SerpApi/.github/close-pull-request.yml
@@ -0,0 +1,20 @@
+name: Close Pull Request
+
+on:
+  pull_request_target:
+    types: [opened]
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: superbrothers/close-pull-request@v3
+      with:
+        comment: |
+          Thanks for your Pull Request! We love contributions.
+
+          However, you should instead open your PR on the main repository:
+          https://github.com/symfony/ai
+
+          This repository is what we call a "subtree split": a read-only subset of that main repository.
+          We're looking forward to your PR there!
diff --git a/src/agent/src/Bridge/SerpApi/.gitignore b/src/agent/src/Bridge/SerpApi/.gitignore
@@ -0,0 +1,4 @@
+vendor/
+composer.lock
+phpunit.xml
+.phpunit.result.cache
diff --git a/src/agent/src/Bridge/SerpApi/CHANGELOG.md b/src/agent/src/Bridge/SerpApi/CHANGELOG.md
@@ -0,0 +1,7 @@
+CHANGELOG
+=========
+
+0.1
+---
+
+ * Add the bridge
diff --git a/src/agent/src/Bridge/SerpApi/LICENSE b/src/agent/src/Bridge/SerpApi/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2025-present Fabien Potencier
+
+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.
diff --git a/src/agent/src/Bridge/SerpApi/SerpApi.php b/src/agent/src/Bridge/SerpApi/SerpApi.php
@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\AI\Agent\Toolbox\Tool;
+namespace Symfony\AI\Agent\Bridge\SerpApi;
 
 use Symfony\AI\Agent\Toolbox\Attribute\AsTool;
 use Symfony\AI\Agent\Toolbox\Source\HasSourcesInterface;
diff --git a/src/agent/src/Bridge/SerpApi/Tests/SerpApiTest.php b/src/agent/src/Bridge/SerpApi/Tests/SerpApiTest.php
@@ -0,0 +1,60 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\AI\Agent\Bridge\SerpApi\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\AI\Agent\Bridge\SerpApi\SerpApi;
+use Symfony\Component\HttpClient\MockHttpClient;
+use Symfony\Component\HttpClient\Response\JsonMockResponse;
+
+final class SerpApiTest extends TestCase
+{
+    public function testReturnsSearchResults()
+    {
+        $result = JsonMockResponse::fromFile(__DIR__.'/fixtures/search-results.json');
+        $httpClient = new MockHttpClient($result);
+        $serpApi = new SerpApi($httpClient, 'test-api-key');
+
+        $results = $serpApi('symfony ai framework');
+
+        $this->assertCount(3, $results);
+        $this->assertArrayHasKey('title', $results[0]);
+        $this->assertSame('Symfony AI - Build AI-powered applications', $results[0]['title']);
+        $this->assertArrayHasKey('link', $results[0]);
+        $this->assertSame('https://symfony.com/ai', $results[0]['link']);
+        $this->assertArrayHasKey('content', $results[0]);
+        $this->assertSame('The Symfony AI component provides a unified interface to interact with various AI platforms and build intelligent applications.', $results[0]['content']);
+    }
+
+    public function testPassesCorrectParametersToApi()
+    {
+        $result = JsonMockResponse::fromFile(__DIR__.'/fixtures/search-results.json');
+        $httpClient = new MockHttpClient($result);
+        $serpApi = new SerpApi($httpClient, 'test-api-key');
+
+        $serpApi('test query');
+
+        $request = $result->getRequestUrl();
+        $this->assertStringContainsString('q=test%20query', $request);
+        $this->assertStringContainsString('api_key=test-api-key', $request);
+    }
+
+    public function testHandlesEmptyResults()
+    {
+        $httpClient = new MockHttpClient(new JsonMockResponse(['organic_results' => []]));
+        $serpApi = new SerpApi($httpClient, 'test-api-key');
+
+        $results = $serpApi('this should return nothing');
+
+        $this->assertEmpty($results);
+    }
+}
diff --git a/src/agent/src/Bridge/SerpApi/Tests/fixtures/search-results.json b/src/agent/src/Bridge/SerpApi/Tests/fixtures/search-results.json
@@ -0,0 +1,36 @@
+{
+  "search_metadata": {
+    "id": "test-search-id",
+    "status": "Success",
+    "created_at": "2025-01-22 00:00:00 UTC",
+    "processed_at": "2025-01-22 00:00:01 UTC",
+    "total_time_taken": 0.5
+  },
+  "search_parameters": {
+    "q": "symfony ai framework",
+    "engine": "google"
+  },
+  "organic_results": [
+    {
+      "position": 1,
+      "title": "Symfony AI - Build AI-powered applications",
+      "link": "https://symfony.com/ai",
+      "snippet": "The Symfony AI component provides a unified interface to interact with various AI platforms and build intelligent applications.",
+      "source": "Symfony"
+    },
+    {
+      "position": 2,
+      "title": "Getting Started with Symfony AI",
+      "link": "https://symfony.com/doc/ai/index.html",
+      "snippet": "Learn how to integrate AI capabilities into your Symfony applications with support for OpenAI, Anthropic, and more.",
+      "source": "Symfony Documentation"
+    },
+    {
+      "position": 3,
+      "title": "Symfony AI Platform Component",
+      "link": "https://github.com/symfony/ai",
+      "snippet": "A comprehensive AI integration framework for PHP applications, supporting multiple AI providers and models.",
+      "source": "GitHub"
+    }
+  ]
+}
diff --git a/src/agent/src/Bridge/SerpApi/composer.json b/src/agent/src/Bridge/SerpApi/composer.json
@@ -0,0 +1,41 @@
+{
+    "name": "symfony/ai-serpapi-tool",
+    "description": "SerpApi AI tool bridge for Symfony applications.",
+    "license": "MIT",
+    "type": "library",
+    "keywords": ["ai", "bridge", "serpapi", "agent", "tool"],
+    "authors": [
+        {
+            "name": "Christopher Hertel",
+            "email": "mail@christopher-hertel.de"
+        }
+    ],
+    "require": {
+        "php": ">=8.2",
+        "symfony/ai-agent": "@dev",
+        "symfony/http-client": "^7.3|^8.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^11.5.13"
+    },
+    "autoload": {
+        "psr-4": {
+            "Symfony\\AI\\Agent\\Bridge\\SerpApi\\": ""
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Symfony\\AI\\Agent\\Bridge\\SerpApi\\Tests\\": "Tests/"
+        }
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "thanks": {
+            "name": "symfony/ai",
+            "url": "https://github.com/symfony/ai"
+        }
+    },
+    "minimum-stability": "dev"
+}
diff --git a/src/agent/src/Bridge/SerpApi/phpunit.xml.dist b/src/agent/src/Bridge/SerpApi/phpunit.xml.dist
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.3/phpunit.xsd"
+         backupGlobals="false"
+         colors="true"
+         bootstrap="vendor/autoload.php"
+         failOnDeprecation="true"
+         failOnRisky="true"
+         failOnWarning="true"
+>
+    <php>
+        <ini name="error_reporting" value="-1" />
+    </php>
+
+    <testsuites>
+        <testsuite name="Symfony AI SerpApi Tool Test Suite">
+            <directory>./Tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <source ignoreSuppressionOfDeprecations="true">
+        <include>
+            <directory>./</directory>
+        </include>
+        <exclude>
+            <directory>./Resources</directory>
+            <directory>./Tests</directory>
+            <directory>./vendor</directory>
+        </exclude>
+    </source>
+</phpunit>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+/Tests export-ignore`
	`2`	`+/phpunit.xml.dist export-ignore`
	`3`	`+/.git* export-ignore`