Skip to content

.Net: feat: Modernize samples and documentation for ITextSearch<TRecord> interface (microsoft#10456) #13194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: feature-text-search-linq
Choose a base branch
from
Open

.Net: feat: Modernize samples and documentation for ITextSearch<TRecord> interface (microsoft#10456) #13194

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
209836a
feat: Add generic ITextSearch<TRecord> demonstration to GettingStarte…
alzarei Sep 28, 2025
b0042f4
feat: Add LINQ filtering example to text search sample
alzarei Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 106 additions & 0 deletions dotnet/samples/GettingStartedWithTextSearch/Step1_Web_Search.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,4 +127,110 @@ public async Task SearchForTextSearchResultsAsync()
Console.WriteLine($"Link: {result.Link}");
}
}

/// <summary>
/// Show how to use the new generic <see cref="ITextSearch{TRecord}"/> interface with LINQ filtering for type-safe searches.
/// This demonstrates the modernized text search functionality introduced in Issue #10456.
/// </summary>
/// <remarks>
/// This example shows the intended pattern for the new generic interfaces.
/// Currently demonstrates the concept using examples from the existing connectors in this sample suite:
/// - BingTextSearch and GoogleTextSearch (this file)
/// - VectorStoreTextSearch (Step4_Search_With_VectorStore.cs)
/// </remarks>
[Fact]
public Task SearchWithLinqFilteringAsync()
{
// This example demonstrates the NEW generic interface pattern with LINQ filtering
// that provides compile-time type safety and IntelliSense support

Console.WriteLine("\n--- Type-Safe Search with Generic Interface and LINQ Filtering ---\n");
Console.WriteLine("This demonstrates the modernized ITextSearch<TRecord> pattern from Issue #10456");
Console.WriteLine("Key benefits:");
Console.WriteLine("- Compile-time type safety (no runtime errors from property name typos)");
Console.WriteLine("- IntelliSense support for filtering properties");
Console.WriteLine("- LINQ expressions for complex filtering logic");
Console.WriteLine("- Better developer experience with strongly-typed search results");
Console.WriteLine();

Console.WriteLine("=== Connectors Available in This Sample Suite ===");
Console.WriteLine();

Console.WriteLine("1. VectorStoreTextSearch<TRecord> (Step4_Search_With_VectorStore.cs)");
Console.WriteLine(" [OK] Already implements ITextSearch<TRecord> with LINQ filtering:");
Console.WriteLine(" var vectorSearch = new VectorStoreTextSearch<DataModel>(collection);");
Console.WriteLine(" var options = new TextSearchOptions<DataModel>");
Console.WriteLine(" {");
Console.WriteLine(" Filter = record => record.Tag == \"Technology\" && record.Title.Contains(\"AI\")");
Console.WriteLine(" };");
Console.WriteLine(" var results = await vectorSearch.GetSearchResultsAsync(query, options);");
Console.WriteLine();

if (this.UseBingSearch)
{
Console.WriteLine("2. BingTextSearch (this file - BingSearchAsync())");
Console.WriteLine(" [PLANNED] Pattern for future generic interface (once PR3 is merged):");
Console.WriteLine(" var bingSearch = new BingTextSearch(apiKey);");
Console.WriteLine(" var options = new TextSearchOptions<BingWebPage>");
Console.WriteLine(" {");
Console.WriteLine(" Top = 4,");
Console.WriteLine(" Filter = page => page.Name.Contains(\"Microsoft\") && page.Snippet.Contains(\"AI\")");
Console.WriteLine(" };");
Console.WriteLine(" var results = await ((ITextSearch<BingWebPage>)bingSearch).GetSearchResultsAsync(query, options);");
Console.WriteLine(" // Type-safe access: page.Name, page.Snippet, page.Url, page.DateLastCrawled");
}
else
{
Console.WriteLine("2. BingTextSearch (set UseBingSearch = true to see example)");
}

Console.WriteLine();
Console.WriteLine("3. GoogleTextSearch (this file - GoogleSearchAsync())");
Console.WriteLine(" [PLANNED] Pattern for future generic interface (once PR4 is merged):");
Console.WriteLine(" // Note: GoogleWebPage is a conceptual type pending PR4 implementation");
Console.WriteLine(" // The actual Google API currently uses: Google.Apis.CustomSearchAPI.v1.Data.Result");
Console.WriteLine(" var googleSearch = new GoogleTextSearch(searchEngineId, apiKey);");
Console.WriteLine(" var options = new TextSearchOptions<GoogleWebPage>");
Console.WriteLine(" {");
Console.WriteLine(" Top = 4,");
Console.WriteLine(" Filter = page => page.Title.Contains(\"AI\") && page.DisplayLink.EndsWith(\".com\")");
Console.WriteLine(" };");
Console.WriteLine(" var results = await ((ITextSearch<GoogleWebPage>)googleSearch).GetSearchResultsAsync(query, options);");
Console.WriteLine(" // Type-safe access: page.Title, page.Snippet, page.DisplayLink, page.Link");
Console.WriteLine();

Console.WriteLine("=== Key Technical Benefits ===");
Console.WriteLine();
Console.WriteLine("[OK] Compile-time validation - no more runtime property name errors");
Console.WriteLine("[OK] IntelliSense support - IDE shows available properties for each connector");
Console.WriteLine("[OK] Type safety - strongly typed search results and filtering");
Console.WriteLine("[OK] LINQ expressions - familiar &&, ||, Contains(), StartsWith(), comparisons, etc.");
Console.WriteLine("[OK] 100% backward compatibility - existing ITextSearch code unchanged");
Console.WriteLine();

Console.WriteLine("=== Example LINQ Filtering Patterns ===");
Console.WriteLine();
Console.WriteLine("// Bing: Filter web pages by content and metadata");
Console.WriteLine("Filter = page => page.Name.Contains(\"Microsoft\") && page.DateLastCrawled > DateTime.Now.AddDays(-7)");
Console.WriteLine();
Console.WriteLine("// Google: Filter search results by domain and content");
Console.WriteLine("Filter = result => result.Title.Contains(\"AI\") && result.DisplayLink.EndsWith(\".edu\")");
Console.WriteLine();
Console.WriteLine("// Vector Store: Filter custom record types with complex logic");
Console.WriteLine("Filter = record => record.Category == \"Technology\" && record.Score > 0.75 && record.Tags.Any(t => t == \"AI\")");
Console.WriteLine();

Console.WriteLine("The VectorStoreTextSearch already demonstrates this pattern in Step4!");
Console.WriteLine("See Step4_Search_With_VectorStore.cs for working generic interface examples.");
Console.WriteLine();
Console.WriteLine("This modernization is part of the structured PR series for Issue #10456:");
Console.WriteLine("PR1: Core generic interfaces [OK]");
Console.WriteLine("PR2: VectorStoreTextSearch implementation [OK]");
Console.WriteLine("PR3: BingTextSearch connector (future) [PLANNED]");
Console.WriteLine("PR4: GoogleTextSearch connector (future) [PLANNED]");
Console.WriteLine("PR5: TavilyTextSearch & BraveTextSearch connectors (future) [PLANNED]");
Console.WriteLine("PR6: Samples and documentation (this PR) [OK]");

return Task.CompletedTask;
}
}
Loading