// Copyright (c) Microsoft. All rights reserved. using System.Text.Json; using Microsoft.SemanticKernel.Data; using Microsoft.SemanticKernel.Plugins.Web.Tavily; namespace Search; /// /// This example shows how to create and use a . /// public class Tavily_TextSearch(ITestOutputHelper output) : BaseTest(output) { #pragma warning disable CS0618 // Suppress obsolete warnings for legacy TextSearchOptions/TextSearchFilter usage /// /// Show how to create a and use it to perform a text search. /// [Fact] public async Task UsingTavilyTextSearch() { // Create a logging handler to output HTTP requests and responses LoggingHandler handler = new(new HttpClientHandler(), this.Output); using HttpClient httpClient = new(handler); // Create an ITextSearch instance using Tavily search var textSearch = new TavilyTextSearch(apiKey: TestConfiguration.Tavily.ApiKey, options: new() { HttpClient = httpClient, IncludeRawContent = true }); var query = "What is the Semantic Kernel?"; // Search and return results as a string items KernelSearchResults stringResults = await textSearch.SearchAsync(query, new() { Top = 4 }); Console.WriteLine("--- String Results ---\n"); await foreach (string result in stringResults.Results) { Console.WriteLine(result); WriteHorizontalRule(); } // Search and return results as TextSearchResult items KernelSearchResults textResults = await textSearch.GetTextSearchResultsAsync(query, new() { Top = 4 }); Console.WriteLine("\n--- Text Search Results ---\n"); await foreach (TextSearchResult result in textResults.Results) { Console.WriteLine($"Name: {result.Name}"); Console.WriteLine($"Value: {result.Value}"); Console.WriteLine($"Link: {result.Link}"); WriteHorizontalRule(); } // Search and return s results as TavilySearchResult items KernelSearchResults fullResults = await textSearch.GetSearchResultsAsync(query, new() { Top = 4 }); Console.WriteLine("\n--- Tavily Web Page Results ---\n"); await foreach (TavilySearchResult result in fullResults.Results) { Console.WriteLine($"Name: {result.Title}"); Console.WriteLine($"Content: {result.Content}"); Console.WriteLine($"Url: {result.Url}"); Console.WriteLine($"RawContent: {result.RawContent}"); Console.WriteLine($"Score: {result.Score}"); WriteHorizontalRule(); } } /// /// Show how to create a and use it to perform a text search which returns an answer. /// [Fact] public async Task UsingTavilyTextSearchToGetAnAnswer() { // Create a logging handler to output HTTP requests and responses LoggingHandler handler = new(new HttpClientHandler(), this.Output); using HttpClient httpClient = new(handler); // Create an ITextSearch instance using Tavily search var textSearch = new TavilyTextSearch(apiKey: TestConfiguration.Tavily.ApiKey, options: new() { HttpClient = httpClient, IncludeAnswer = true }); var query = "What is the Semantic Kernel?"; // Search and return results as a string items KernelSearchResults stringResults = await textSearch.SearchAsync(query, new() { Top = 1 }); Console.WriteLine("--- String Results ---\n"); await foreach (string result in stringResults.Results) { Console.WriteLine(result); WriteHorizontalRule(); } } /// /// Show how to create a and use it to perform a text search. /// [Fact] public async Task UsingTavilyTextSearchAndIncludeEverything() { // Create a logging handler to output HTTP requests and responses LoggingHandler handler = new(new HttpClientHandler(), this.Output); using HttpClient httpClient = new(handler); // Create an ITextSearch instance using Tavily search var textSearch = new TavilyTextSearch( apiKey: TestConfiguration.Tavily.ApiKey, options: new() { HttpClient = httpClient, IncludeRawContent = true, IncludeImages = true, IncludeImageDescriptions = true, IncludeAnswer = true, }); var query = "What is the Semantic Kernel?"; // Search and return s results as TavilySearchResult items KernelSearchResults fullResults = await textSearch.GetSearchResultsAsync(query, new() { Top = 4, Skip = 0 }); Console.WriteLine("\n--- Tavily Web Page Results ---\n"); await foreach (TavilySearchResult result in fullResults.Results) { Console.WriteLine($"Name: {result.Title}"); Console.WriteLine($"Content: {result.Content}"); Console.WriteLine($"Url: {result.Url}"); Console.WriteLine($"RawContent: {result.RawContent}"); Console.WriteLine($"Score: {result.Score}"); WriteHorizontalRule(); } } /// /// Show how to create a with a custom mapper and use it to perform a text search. /// [Fact] public async Task UsingTavilyTextSearchWithACustomMapperAsync() { // Create a logging handler to output HTTP requests and responses LoggingHandler handler = new(new HttpClientHandler(), this.Output); using HttpClient httpClient = new(handler); // Create an ITextSearch instance using Tavily search var textSearch = new TavilyTextSearch(apiKey: TestConfiguration.Tavily.ApiKey, options: new() { HttpClient = httpClient, StringMapper = new TestTextSearchStringMapper(), }); var query = "What is the Semantic Kernel?"; // Search with TextSearchResult textResult type KernelSearchResults stringResults = await textSearch.SearchAsync(query, new() { Top = 2 }); Console.WriteLine("--- Serialized JSON Results ---"); await foreach (string result in stringResults.Results) { Console.WriteLine(result); WriteHorizontalRule(); } } /// /// Show how to create a with a custom mapper and use it to perform a text search. /// [Fact] public async Task UsingTavilyTextSearchWithAnIncludeDomainFilterAsync() { // Create a logging handler to output HTTP requests and responses LoggingHandler handler = new(new HttpClientHandler(), this.Output); using HttpClient httpClient = new(handler); // Create an ITextSearch instance using Tavily search var textSearch = new TavilyTextSearch(apiKey: TestConfiguration.Tavily.ApiKey, options: new() { HttpClient = httpClient, StringMapper = new TestTextSearchStringMapper(), }); var query = "What is the Semantic Kernel?"; // Search with TextSearchResult textResult type TextSearchOptions searchOptions = new() { Top = 4, Filter = new TextSearchFilter().Equality("include_domain", "devblogs.microsoft.com") }; KernelSearchResults textResults = await textSearch.GetTextSearchResultsAsync(query, searchOptions); Console.WriteLine("--- Microsoft Developer Blogs Results ---"); await foreach (TextSearchResult result in textResults.Results) { Console.WriteLine(result.Link); WriteHorizontalRule(); } } #pragma warning restore CS0618 /// /// Show how to use enhanced LINQ filtering with TavilyTextSearch for type-safe searches with Title.Contains() support. /// [Fact] public async Task UsingTavilyTextSearchWithLinqFilteringAsync() { // Create a logging handler to output HTTP requests and responses LoggingHandler handler = new(new HttpClientHandler(), this.Output); using HttpClient httpClient = new(handler); // Create an ITextSearch instance for type-safe LINQ filtering ITextSearch textSearch = new TavilyTextSearch(apiKey: TestConfiguration.Tavily.ApiKey, options: new() { HttpClient = httpClient }); var query = "Semantic Kernel AI"; // Example 1: Filter results by title content using Contains Console.WriteLine("——— Example 1: Title Contains Filter ———\n"); var titleContainsOptions = new TextSearchOptions { Top = 2, Filter = page => page.Title != null && page.Title.Contains("Kernel") }; var titleResults = await textSearch.SearchAsync(query, titleContainsOptions); await foreach (string result in titleResults.Results) { Console.WriteLine(result); WriteHorizontalRule(); } // Example 2: Compound AND filtering (title contains + NOT contains) Console.WriteLine("\n——— Example 2: Compound Filter (Title Contains + Exclusion) ———\n"); var compoundOptions = new TextSearchOptions { Top = 2, Filter = page => page.Title != null && page.Title.Contains("AI") && page.Content != null && !page.Content.Contains("deprecated") }; var compoundResults = await textSearch.SearchAsync(query, compoundOptions); await foreach (string result in compoundResults.Results) { Console.WriteLine(result); WriteHorizontalRule(); } // Example 3: Get full results with LINQ filtering Console.WriteLine("\n——— Example 3: Full Results with Title Filter ———\n"); var fullResultsOptions = new TextSearchOptions { Top = 2, Filter = page => page.Title != null && page.Title.Contains("Semantic") }; var fullResults = await textSearch.GetSearchResultsAsync(query, fullResultsOptions); await foreach (TavilyWebPage page in fullResults.Results) { Console.WriteLine($"Title: {page.Title}"); Console.WriteLine($"Content: {page.Content}"); Console.WriteLine($"URL: {page.Url}"); Console.WriteLine($"Score: {page.Score}"); WriteHorizontalRule(); } // Example 4: Complex compound filtering with multiple conditions Console.WriteLine("\n——— Example 4: Complex Compound Filter (Title + Content + URL) ———\n"); var complexOptions = new TextSearchOptions { Top = 2, Filter = page => page.Title != null && page.Title.Contains("Kernel") && page.Content != null && page.Content.Contains("AI") && page.Url != null && page.Url.ToString().Contains("microsoft") }; var complexResults = await textSearch.GetSearchResultsAsync(query, complexOptions); await foreach (TavilyWebPage page in complexResults.Results) { Console.WriteLine($"Title: {page.Title}"); Console.WriteLine($"URL: {page.Url}"); Console.WriteLine($"Score: {page.Score}"); WriteHorizontalRule(); } } #region private /// /// Test mapper which converts an arbitrary search result to a string using JSON serialization. /// private sealed class TestTextSearchStringMapper : ITextSearchStringMapper { /// public string MapFromResultToString(object result) { return JsonSerializer.Serialize(result); } } #endregion }