implemented a new Google Search with the Text Search interface

python/samples/concepts/search/google_text_search_as_plugin.py

@@ -0,0 +1,138 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+
+from collections.abc import Coroutine
+from typing import Any
+
+from semantic_kernel import Kernel
+from semantic_kernel.connectors.ai.function_choice_behavior import FunctionChoiceBehavior
+from semantic_kernel.connectors.ai.open_ai import (
+    OpenAIChatCompletion,
+    OpenAIChatPromptExecutionSettings,
+)
+from semantic_kernel.connectors.search.google import GoogleSearch
+from semantic_kernel.contents import ChatHistory
+from semantic_kernel.filters.filter_types import FilterTypes
+from semantic_kernel.filters.functions.function_invocation_context import FunctionInvocationContext
+from semantic_kernel.functions import KernelArguments, KernelParameterMetadata, KernelPlugin
+
+kernel = Kernel()
+kernel.add_service(OpenAIChatCompletion(service_id="chat"))
+kernel.add_plugin(
+    KernelPlugin.from_text_search_with_search(
+        GoogleSearch(),
+        plugin_name="google",
+        description="Get details about Semantic Kernel concepts.",
+        parameters=[
+            KernelParameterMetadata(
+                name="query",
+                description="The search query.",
+                type="str",
+                is_required=True,
+                type_object=str,
+            ),
+            KernelParameterMetadata(
+                name="top",
+                description="The number of results to return.",
+                type="int",
+                is_required=False,
+                default_value=2,
+                type_object=int,
+            ),
+            KernelParameterMetadata(
+                name="skip",
+                description="The number of results to skip.",
+                type="int",
+                is_required=False,
+                default_value=0,
+                type_object=int,
+            ),
+            KernelParameterMetadata(
+                name="siteSearch",
+                description="The site to search.",
+                default_value="https://github.com/",
+                type="str",
+                is_required=False,
+                type_object=str,
+            ),
+        ],
+    )
+)
+chat_function = kernel.add_function(
+    prompt="{{$chat_history}}{{$user_input}}",
+    plugin_name="ChatBot",
+    function_name="Chat",
+)
+execution_settings = OpenAIChatPromptExecutionSettings(
+    service_id="chat",
+    max_tokens=2000,
+    temperature=0.7,
+    top_p=0.8,
+    function_choice_behavior=FunctionChoiceBehavior.Auto(auto_invoke=True),
+)
+
+history = ChatHistory()
+system_message = """
+You are a chat bot, specialized in Semantic Kernel, Microsoft LLM orchestration SDK.
+Assume questions are related to that, and use the Bing search plugin to find answers.
+"""
+history.add_system_message(system_message)
+history.add_user_message("Hi there, who are you?")
+history.add_assistant_message("I am Mosscap, a chat bot. I'm trying to figure out what people need.")
+
+arguments = KernelArguments(settings=execution_settings)
+
+
+@kernel.filter(filter_type=FilterTypes.FUNCTION_INVOCATION)
+async def log_google_filter(context: FunctionInvocationContext, next: Coroutine[FunctionInvocationContext, Any, None]):
+    if context.function.plugin_name == "google":
+        print("Calling Google search with arguments:")
+        if "query" in context.arguments:
+            print(f'  Query: "{context.arguments["query"]}"')
+        if "top" in context.arguments:
+            print(f'  Top: "{context.arguments["top"]}"')
+        if "skip" in context.arguments:
+            print(f'  Skip: "{context.arguments["skip"]}"')
+        await next(context)
+        print("Google search completed.")
+    else:
+        await next(context)
+
+
+async def chat() -> bool:
+    try:
+        user_input = input("User:> ")
+    except KeyboardInterrupt:
+        print("\n\nExiting chat...")
+        return False
+    except EOFError:
+        print("\n\nExiting chat...")
+        return False
+
+    if user_input == "exit":
+        print("\n\nExiting chat...")
+        return False
+    arguments["user_input"] = user_input
+    arguments["chat_history"] = history
+    result = await kernel.invoke(chat_function, arguments=arguments)
+    print(f"Mosscap:> {result}")
+    history.add_user_message(user_input)
+    history.add_assistant_message(str(result))
+    return True
+
+
+async def main():
+    chatting = True
+    print(
+        "Welcome to the chat bot!\
+        \n  Type 'exit' to exit.\
+        \n  Try to find out more about the inner workings of Semantic Kernel."
+    )
+    while chatting:
+        chatting = await chat()
+
+
+if __name__ == "__main__":
+    import asyncio
+
+    asyncio.run(main())

python/semantic_kernel/connectors/search/bing/bing_search.py

@@ -9,13 +9,13 @@
 from pydantic import ValidationError
 
 from semantic_kernel.connectors.search.bing.bing_search_response import BingSearchResponse
+from semantic_kernel.connectors.search.bing.bing_search_settings import BingSettings
 from semantic_kernel.connectors.search.bing.bing_web_page import BingWebPage
 from semantic_kernel.connectors.search.bing.const import (
     DEFAULT_CUSTOM_URL,
     DEFAULT_URL,
     QUERY_PARAMETERS,
 )
-from semantic_kernel.connectors.search_engine.bing_connector_settings import BingSettings
 from semantic_kernel.data.filter_clauses.any_tags_equal_to_filter_clause import AnyTagsEqualTo
 from semantic_kernel.data.filter_clauses.equal_to_filter_clause import EqualTo
 from semantic_kernel.data.kernel_search_results import KernelSearchResults
@@ -47,7 +47,7 @@ def __init__(
         env_file_path: str | None = None,
         env_file_encoding: str | None = None,
     ) -> None:
-        """Initializes a new instance of the BingConnector class.
+        """Initializes a new instance of the Bing Search class.
 
         Args:
             api_key: The Bing Search API key. If provided, will override

python/semantic_kernel/connectors/search/google/__init__.py

@@ -0,0 +1,11 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+from semantic_kernel.connectors.search.google.google_search import GoogleSearch
+from semantic_kernel.connectors.search.google.google_search_response import GoogleSearchResponse
+from semantic_kernel.connectors.search.google.google_search_result import GoogleSearchResult
+
+__all__ = [
+    "GoogleSearch",
+    "GoogleSearchResponse",
+    "GoogleSearchResult",
+]

python/semantic_kernel/connectors/search/google/const.py

@@ -0,0 +1,50 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+
+from typing import Final
+
+CUSTOM_SEARCH_URL: Final[str] = "https://www.googleapis.com/customsearch/v1"
+
+# For more info on this list: https://developers.google.com/custom-search/v1/reference/rest/v1/cse/list
+QUERY_PARAMETERS: Final[list[str]] = [
+    # Country, Restricts search results to documents originating in a particular country.
+    # You may use Boolean operators in the cr parameter's value.
+    "cr",
+    # Date Restrict, Restricts results to URLs based on date. Supported values include:
+    # d[number]: requests results from the specified number of past days.
+    # w[number]: requests results from the specified number of past weeks.
+    # m[number]: requests results from the specified number of past months.
+    # y[number]: requests results from the specified number of past years.
+    "dateRestrict",
+    # exactTerms, Identifies a phrase that all documents in the search results must contain.
+    "exactTerms",
+    # excludeTerms, Identifies a word or phrase that should not appear in any documents in the search results.
+    "excludeTerms",
+    # fileType, Restricts results to files of a specified extension. A list of file types indexable by Google
+    # can be found in Search Console Help Center: https://support.google.com/webmasters/answer/35287
+    "fileType",
+    # filter, Controls turning on or off the duplicate content filter.
+    "filter",
+    # gl, Geolocation of end user. The gl parameter value is a two-letter country code. The gl parameter boosts search
+    # results whose country of origin matches the parameter value.
+    # See the Country Codes page for a list of valid values.
+    "gl",
+    # highRange, Specifies the ending value for a search range.
+    "highRange",
+    # hl, Sets the user interface language.
+    "hl",
+    # linkSite, Specifies that all search results should contain a link to a particular URL.
+    "linkSite",
+    # Language of the result. Restricts the search to documents written in a particular language (e.g., lr=lang_ja).
+    "lr",
+    # or Terms, Provides additional search terms to check for in a document, where each document in the search results
+    # must contain at least one of the additional search terms.
+    "orTerms",
+    # rights, Filters based on licensing. Supported values include:
+    # cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived
+    "rights",
+    # siteSearch, Specifies all search results should be pages from a given site.
+    "siteSearch",
+    # siteSearchFilter, Controls whether to include or exclude results from the site named in the siteSearch parameter.
+    "siteSearchFilter",
+]