Python: Web search file search tools (#395)

* Add web and file search tools

* add tests

* PR comments

* Add tools support for chat and assistants clients

* fix code checks

* add tests for assistants client

* Add samples

* fix fn descriptions

* Add openai responses model id to environment variables

---------

Co-authored-by: Dmytro Struk <13853051+dmytrostruk@users.noreply.github.com>

python/samples/getting_started/agents/openai_assistants_client/openai_assistants_with_file_search.py

@@ -0,0 +1,53 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import asyncio
+from agent_framework import ChatClientAgent, HostedFileSearchTool, HostedVectorStoreContent
+from agent_framework.openai import OpenAIAssistantsClient
+
+# Helper functions
+
+async def create_vector_store(client: OpenAIAssistantsClient) -> tuple[str, HostedVectorStoreContent]:
+    """Create a vector store with sample documents."""
+    file = await client.client.files.create(
+        file=("todays_weather.txt", b"The weather today is sunny with a high of 75F."), purpose="user_data"
+    )
+    vector_store = await client.client.vector_stores.create(
+        name="knowledge_base",
+        expires_after={"anchor": "last_active_at", "days": 1},
+    )
+    result = await client.client.vector_stores.files.create_and_poll(vector_store_id=vector_store.id, file_id=file.id)
+    if result.last_error is not None:
+        raise Exception(f"Vector store file processing failed with status: {result.last_error.message}")
+
+    return file.id, HostedVectorStoreContent(vector_store_id=vector_store.id)
+
+
+async def delete_vector_store(client: OpenAIAssistantsClient, file_id: str, vector_store_id: str) -> None:
+    """Delete the vector store after using it."""
+
+    await client.client.vector_stores.delete(vector_store_id=vector_store_id)
+    await client.client.files.delete(file_id=file_id)
+
+
+async def main() -> None:
+    client = OpenAIAssistantsClient()
+    async with ChatClientAgent(
+        chat_client=client,
+        instructions="You are a helpful assistant that searches files in a knowledge base.",
+        tools=HostedFileSearchTool(),
+    ) as agent:
+        query = "What is the weather today? Do a file search to find the answer."
+        file_id, vector_store = await create_vector_store(client)
+
+        print(f"User: {query}")
+        print("Agent: ", end="", flush=True)
+        async for chunk in agent.run_streaming(
+            query,
+            tool_resources={"file_search": {"vector_store_ids": [vector_store.vector_store_id]}}
+        ):
+            if chunk.text:
+                print(chunk.text, end="", flush=True)
+        await delete_vector_store(client, file_id, vector_store.vector_store_id)
+
+if __name__ == "__main__":
+    asyncio.run(main())

python/samples/getting_started/agents/openai_chat_client/openai_chat_client_with_web_search.py

@@ -0,0 +1,39 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import asyncio
+from agent_framework import HostedWebSearchTool
+from agent_framework.openai import OpenAIChatClient
+
+async def main() -> None:
+    client = OpenAIChatClient(ai_model_id="gpt-4o-search-preview")
+
+    message = "What is the current weather? Do not ask for my current location."
+    # Test that the client will use the web search tool with location
+    additional_properties = {
+        "user_location": {
+            "country": "US",
+            "city": "Seattle",
+        }
+    }
+    stream = False
+    print(f"User: {message}")
+    if stream:
+        print("Assistant: ", end="")
+        async for chunk in client.get_streaming_response(
+            message,
+            tools=[HostedWebSearchTool(additional_properties=additional_properties)],
+            tool_choice="auto",
+        ):
+            if chunk.text:
+                print(chunk.text, end="")
+        print("")
+    else:
+        response = await client.get_response(
+            message,
+            tools=[HostedWebSearchTool(additional_properties=additional_properties)],
+            tool_choice="auto",
+        )
+        print(f"Assistant: {response}")
+
+if __name__ == "__main__":
+    asyncio.run(main())

python/samples/getting_started/agents/openai_responses_client/openai_responses_client_with_file_search.py

@@ -0,0 +1,60 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import asyncio
+from agent_framework import HostedFileSearchTool, HostedVectorStoreContent
+from agent_framework.openai import OpenAIResponsesClient
+
+# Helper functions
+
+async def create_vector_store(client: OpenAIResponsesClient) -> tuple[str, HostedVectorStoreContent]:
+    """Create a vector store with sample documents."""
+    file = await client.client.files.create(
+        file=("todays_weather.txt", b"The weather today is sunny with a high of 75F."), purpose="user_data"
+    )
+    vector_store = await client.client.vector_stores.create(
+        name="knowledge_base",
+        expires_after={"anchor": "last_active_at", "days": 1},
+    )
+    result = await client.client.vector_stores.files.create_and_poll(vector_store_id=vector_store.id, file_id=file.id)
+    if result.last_error is not None:
+        raise Exception(f"Vector store file processing failed with status: {result.last_error.message}")
+
+    return file.id, HostedVectorStoreContent(vector_store_id=vector_store.id)
+
+
+async def delete_vector_store(client: OpenAIResponsesClient, file_id: str, vector_store_id: str) -> None:
+    """Delete the vector store after using it."""
+
+    await client.client.vector_stores.delete(vector_store_id=vector_store_id)
+    await client.client.files.delete(file_id=file_id)
+
+
+async def main() -> None:
+    client = OpenAIResponsesClient()
+
+    message = "What is the weather today? Do a file search to find the answer."
+
+    stream = False
+    print(f"User: {message}")
+    file_id, vector_store = await create_vector_store(client)
+    if stream:
+        print("Assistant: ", end="")
+        async for chunk in client.get_streaming_response(
+            message,
+            tools=[HostedFileSearchTool(inputs=vector_store)],
+            tool_choice="auto",
+        ):
+            if chunk.text:
+                print(chunk.text, end="")
+        print("")
+    else:
+        response = await client.get_response(
+            message,
+            tools=[HostedFileSearchTool(inputs=vector_store)],
+            tool_choice="auto",
+        )
+        print(f"Assistant: {response}")
+    await delete_vector_store(client, file_id, vector_store.vector_store_id)
+
+if __name__ == "__main__":
+    asyncio.run(main())

python/samples/getting_started/agents/openai_responses_client/openai_responses_client_with_web_search.py

@@ -0,0 +1,39 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import asyncio
+from agent_framework import HostedWebSearchTool
+from agent_framework.openai import OpenAIResponsesClient
+
+async def main() -> None:
+    client = OpenAIResponsesClient()
+
+    message = "What is the current weather? Do not ask for my current location."
+    # Test that the client will use the web search tool with location
+    additional_properties = {
+        "user_location": {
+            "country": "US",
+            "city": "Seattle",
+        }
+    }
+    stream = False
+    print(f"User: {message}")
+    if stream:
+        print("Assistant: ", end="")
+        async for chunk in client.get_streaming_response(
+            message,
+            tools=[HostedWebSearchTool(additional_properties=additional_properties)],
+            tool_choice="auto",
+        ):
+            if chunk.text:
+                print(chunk.text, end="")
+        print("")
+    else:
+        response = await client.get_response(
+            message,
+            tools=[HostedWebSearchTool(additional_properties=additional_properties)],
+            tool_choice="auto",
+        )
+        print(f"Assistant: {response}")
+
+if __name__ == "__main__":
+    asyncio.run(main())