Skip to content

.Net: Net: feat: Modernize TavilyTextSearch and BraveTextSearch connectors with ITextSearch<TRecord> interface (microsoft#10456) #13191

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

Merged
westey-m merged 14 commits into from
Nov 21, 2025
Merged

.Net: Net: feat: Modernize TavilyTextSearch and BraveTextSearch connectors with ITextSearch<TRecord> interface (microsoft#10456) #13191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
16ec4db
Change ITextSearch<TRecord>.GetSearchResultsAsync to return KernelSea…
alzarei Oct 31, 2025
750e82b
t rebase --continue
alzarei Sep 28, 2025
33377ae
Enhance text search LINQ support with OR/NOT operators and improved e…
alzarei Oct 3, 2025
725f61c
fix: Resolve CA1056 code analysis violations in web search connectors
alzarei Oct 20, 2025
1db77fb
feat: Add C# 14 MemoryExtensions.Contains compatibility to text searc…
alzarei Oct 30, 2025
73f085f
feat: add generic interface tests and fix collection Contains excepti…
alzarei Oct 31, 2025
4caa829
Fix API type changes to return TRecord instead of object
alzarei Nov 3, 2025
9f4dec3
Correct approach: Revert unnecessary non-generic test changes and ren…
alzarei Nov 6, 2025
bcb307d
feat: Implement Title.Contains() support for Brave and Tavily text se…
alzarei Nov 6, 2025
1197762
fix: Remove trailing whitespace from SearchQueryFilterClause.cs
alzarei Nov 7, 2025
a3113a9
refactor: Make SearchQueryFilterClause internal with InternalsVisibleTo
alzarei Nov 12, 2025
a689b0c
refactor: Make SearchQueryFilterClause public (revert internal approach)
alzarei Nov 12, 2025
b637c59
Move SearchQueryFilterClause to Plugins.Web and make FilterClause con…
alzarei Nov 15, 2025
7d39c88
make FilterClause constructor protected to address CA1012 warning
alzarei Nov 19, 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
152 changes: 149 additions & 3 deletions dotnet/src/Plugins/Plugins.UnitTests/Web/Brave/BraveTextSearchTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Copyright (c) Microsoft. All rights reserved.

#pragma warning disable CS0618 // ITextSearch is obsolete
#pragma warning disable CS8602 // Dereference of a possibly null reference - for LINQ expression properties

using System;
using System.IO;
Expand Down Expand Up @@ -110,7 +111,7 @@ public async Task GetSearchResultsReturnsSuccessfullyAsync()
var resultList = await result.Results.ToListAsync();
Assert.NotNull(resultList);
Assert.Equal(10, resultList.Count);
foreach (BraveWebResult webPage in resultList)
foreach (BraveWebPage webPage in resultList.Cast<BraveWebPage>())
{
Assert.NotNull(webPage.Title);
Assert.NotNull(webPage.Description);
Expand Down Expand Up @@ -195,7 +196,7 @@ public async Task BuildsCorrectUriForEqualityFilterAsync(string paramName, objec

// Act
TextSearchOptions searchOptions = new() { Top = 5, Skip = 0, Filter = new TextSearchFilter().Equality(paramName, paramValue) };
KernelSearchResults<object> result = await textSearch.GetSearchResultsAsync("What is the Semantic Kernel?", searchOptions);
var result = await textSearch.GetSearchResultsAsync("What is the Semantic Kernel?", searchOptions);

// Assert
var requestUris = this._messageHandlerStub.RequestUris;
Expand Down Expand Up @@ -243,6 +244,151 @@ public void Dispose()
GC.SuppressFinalize(this);
}

#region Generic ITextSearch<BraveWebPage> Interface Tests

[Fact]
public async Task LinqSearchAsyncReturnsResultsSuccessfullyAsync()
{
// Arrange
this._messageHandlerStub.AddJsonResponse(File.ReadAllText(WhatIsTheSkResponseJson));
ITextSearch<BraveWebPage> textSearch = new BraveTextSearch(apiKey: "ApiKey", options: new() { HttpClient = this._httpClient });

// Act
var searchOptions = new TextSearchOptions<BraveWebPage>
{
Top = 4,
Skip = 0
};
KernelSearchResults<string> result = await textSearch.SearchAsync("What is the Semantic Kernel?", searchOptions);

// Assert - Verify basic generic interface functionality
Assert.NotNull(result);
Assert.NotNull(result.Results);
var resultList = await result.Results.ToListAsync();
Assert.NotEmpty(resultList);

// Verify the request was made correctly
var requestUris = this._messageHandlerStub.RequestUris;
Assert.Single(requestUris);
Assert.NotNull(requestUris[0]);
Assert.Contains("count=4", requestUris[0].AbsoluteUri);
}

[Fact]
public async Task LinqGetSearchResultsAsyncReturnsResultsSuccessfullyAsync()
{
// Arrange
this._messageHandlerStub.AddJsonResponse(File.ReadAllText(WhatIsTheSkResponseJson));
ITextSearch<BraveWebPage> textSearch = new BraveTextSearch(apiKey: "ApiKey", options: new() { HttpClient = this._httpClient });

// Act
var searchOptions = new TextSearchOptions<BraveWebPage>
{
Top = 3,
Skip = 0
};
KernelSearchResults<BraveWebPage> result = await textSearch.GetSearchResultsAsync("What is the Semantic Kernel?", searchOptions);

// Assert - Verify generic interface returns results
Assert.NotNull(result);
Assert.NotNull(result.Results);
var resultList = await result.Results.ToListAsync();
Assert.NotEmpty(resultList);
// Results are now strongly typed as BraveWebPage

// Verify the request was made correctly
var requestUris = this._messageHandlerStub.RequestUris;
Assert.Single(requestUris);
Assert.NotNull(requestUris[0]);
Assert.Contains("count=3", requestUris[0].AbsoluteUri);
}

[Fact]
public async Task LinqGetTextSearchResultsAsyncReturnsResultsSuccessfullyAsync()
{
// Arrange
this._messageHandlerStub.AddJsonResponse(File.ReadAllText(WhatIsTheSkResponseJson));
ITextSearch<BraveWebPage> textSearch = new BraveTextSearch(apiKey: "ApiKey", options: new() { HttpClient = this._httpClient });

// Act
var searchOptions = new TextSearchOptions<BraveWebPage>
{
Top = 5,
Skip = 0
};
KernelSearchResults<TextSearchResult> result = await textSearch.GetTextSearchResultsAsync("What is the Semantic Kernel?", searchOptions);

// Assert - Verify generic interface returns TextSearchResult objects
Assert.NotNull(result);
Assert.NotNull(result.Results);
var resultList = await result.Results.ToListAsync();
Assert.NotEmpty(resultList);
Assert.All(resultList, item => Assert.IsType<TextSearchResult>(item));

// Verify the request was made correctly
var requestUris = this._messageHandlerStub.RequestUris;
Assert.Single(requestUris);
Assert.NotNull(requestUris[0]);
Assert.Contains("count=5", requestUris[0].AbsoluteUri);
}

[Fact]
public async Task CollectionContainsFilterThrowsNotSupportedExceptionAsync()
{
// Arrange - Tests both Enumerable.Contains (C# 13-) and MemoryExtensions.Contains (C# 14+)
// The same code array.Contains() resolves differently based on C# language version:
// - C# 13 and earlier: Enumerable.Contains (LINQ extension method)
// - C# 14 and later: MemoryExtensions.Contains (span-based optimization due to "first-class spans")
// Our implementation handles both identically since Brave API has limited query operators
this._messageHandlerStub.AddJsonResponse(File.ReadAllText(WhatIsTheSkResponseJson));
ITextSearch<BraveWebPage> textSearch = new BraveTextSearch(apiKey: "ApiKey", options: new() { HttpClient = this._httpClient });
string[] sites = ["microsoft.com", "github.com"];

// Act & Assert - Verify that collection Contains pattern throws clear exception
var searchOptions = new TextSearchOptions<BraveWebPage>
{
Top = 5,
Skip = 0,
Filter = page => sites.Contains(page.Url!.ToString()) // Enumerable.Contains (C# 13-) or MemoryExtensions.Contains (C# 14+)
};

var exception = await Assert.ThrowsAsync<NotSupportedException>(async () =>
{
await textSearch.SearchAsync("test", searchOptions);
});

// Assert - Verify error message explains the limitation clearly
Assert.Contains("Collection Contains filters", exception.Message);
Assert.Contains("not supported", exception.Message);
}

[Fact]
public async Task StringContainsStillWorksWithLINQFiltersAsync()
{
// Arrange - Verify that String.Contains (instance method) still works
// String.Contains is NOT affected by C# 14 "first-class spans" - only arrays are
this._messageHandlerStub.AddJsonResponse(File.ReadAllText(WhatIsTheSkResponseJson));
ITextSearch<BraveWebPage> textSearch = new BraveTextSearch(apiKey: "ApiKey", options: new() { HttpClient = this._httpClient });

// Act - String.Contains should continue to work
var searchOptions = new TextSearchOptions<BraveWebPage>
{
Top = 5,
Skip = 0,
Filter = page => page.Title.Contains("Kernel") // String.Contains - instance method
};
KernelSearchResults<string> result = await textSearch.SearchAsync("Semantic Kernel tutorial", searchOptions);

// Assert - Verify String.Contains works correctly
var requestUris = this._messageHandlerStub.RequestUris;
Assert.Single(requestUris);
Assert.NotNull(requestUris[0]);
Assert.Contains("Kernel", requestUris[0].AbsoluteUri);
Assert.Contains("count=5", requestUris[0].AbsoluteUri);
}

#endregion

#region private
private const string WhatIsTheSkResponseJson = "./TestData/brave_what_is_the_semantic_kernel.json";
private const string SiteFilterSkResponseJson = "./TestData/brave_site_filter_what_is_the_semantic_kernel.json";
Expand Down Expand Up @@ -273,7 +419,7 @@ public TextSearchResult MapFromResultToTextSearchResult(object result)
{
if (result is not BraveWebResult webPage)
{
throw new ArgumentException("Result must be a BraveWebPage", nameof(result));
throw new ArgumentException("Result must be a BraveWebResult", nameof(result));
}

return new TextSearchResult(webPage.Description?.ToUpperInvariant() ?? string.Empty)
Expand Down
151 changes: 151 additions & 0 deletions dotnet/src/Plugins/Plugins.UnitTests/Web/Tavily/TavilyTextSearchTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Copyright (c) Microsoft. All rights reserved.

#pragma warning disable CS0618 // ITextSearch is obsolete
#pragma warning disable CS8602 // Dereference of a possibly null reference - for LINQ expression properties

using System;
using System.IO;
Expand Down Expand Up @@ -346,6 +347,156 @@ public void Dispose()
GC.SuppressFinalize(this);
}

#region Generic ITextSearch<TavilyWebPage> Interface Tests

[Fact]
public async Task LinqSearchAsyncReturnsResultsSuccessfullyAsync()
{
// Arrange
this._messageHandlerStub.AddJsonResponse(File.ReadAllText(SiteFilterDevBlogsResponseJson));
ITextSearch<TavilyWebPage> textSearch = new TavilyTextSearch(apiKey: "ApiKey", options: new() { HttpClient = this._httpClient });

// Act
var searchOptions = new TextSearchOptions<TavilyWebPage>
{
Top = 4,
Skip = 0
};
KernelSearchResults<string> result = await textSearch.SearchAsync("What is the Semantic Kernel?", searchOptions);

// Assert - Verify basic generic interface functionality
Assert.NotNull(result);
Assert.NotNull(result.Results);
var resultList = await result.Results.ToListAsync();
Assert.NotEmpty(resultList);

// Verify the request was made correctly
var requestContents = this._messageHandlerStub.RequestContents;
Assert.Single(requestContents);
Assert.NotNull(requestContents[0]);
var requestBodyJson = Encoding.UTF8.GetString(requestContents[0]!);
Assert.Contains("\"query\"", requestBodyJson);
Assert.Contains("\"max_results\":4", requestBodyJson);
}

[Fact]
public async Task LinqGetSearchResultsAsyncReturnsResultsSuccessfullyAsync()
{
// Arrange
this._messageHandlerStub.AddJsonResponse(File.ReadAllText(SiteFilterDevBlogsResponseJson));
ITextSearch<TavilyWebPage> textSearch = new TavilyTextSearch(apiKey: "ApiKey", options: new() { HttpClient = this._httpClient });

// Act
var searchOptions = new TextSearchOptions<TavilyWebPage>
{
Top = 3,
Skip = 0
};
KernelSearchResults<TavilyWebPage> result = await textSearch.GetSearchResultsAsync("What is the Semantic Kernel?", searchOptions);

// Assert - Verify generic interface returns results
Assert.NotNull(result);
Assert.NotNull(result.Results);
var resultList = await result.Results.ToListAsync();
Assert.NotEmpty(resultList);
// Results are now strongly typed as TavilyWebPage

// Verify the request was made correctly
var requestContents = this._messageHandlerStub.RequestContents;
Assert.Single(requestContents);
Assert.NotNull(requestContents[0]);
var requestBodyJson = Encoding.UTF8.GetString(requestContents[0]!);
Assert.Contains("\"max_results\":3", requestBodyJson);
}

[Fact]
public async Task LinqGetTextSearchResultsAsyncReturnsResultsSuccessfullyAsync()
{
// Arrange
this._messageHandlerStub.AddJsonResponse(File.ReadAllText(SiteFilterDevBlogsResponseJson));
ITextSearch<TavilyWebPage> textSearch = new TavilyTextSearch(apiKey: "ApiKey", options: new() { HttpClient = this._httpClient });

// Act
var searchOptions = new TextSearchOptions<TavilyWebPage>
{
Top = 5,
Skip = 0
};
KernelSearchResults<TextSearchResult> result = await textSearch.GetTextSearchResultsAsync("What is the Semantic Kernel?", searchOptions);

// Assert - Verify generic interface returns TextSearchResult objects
Assert.NotNull(result);
Assert.NotNull(result.Results);
var resultList = await result.Results.ToListAsync();
Assert.NotEmpty(resultList);
Assert.All(resultList, item => Assert.IsType<TextSearchResult>(item));

// Verify the request was made correctly
var requestContents = this._messageHandlerStub.RequestContents;
Assert.Single(requestContents);
Assert.NotNull(requestContents[0]);
var requestBodyJson = Encoding.UTF8.GetString(requestContents[0]!);
Assert.Contains("\"max_results\":5", requestBodyJson);
}

[Fact]
public async Task CollectionContainsFilterThrowsNotSupportedExceptionAsync()
{
// Arrange - Tests both Enumerable.Contains (C# 13-) and MemoryExtensions.Contains (C# 14+)
// The same code array.Contains() resolves differently based on C# language version:
// - C# 13 and earlier: Enumerable.Contains (LINQ extension method)
// - C# 14 and later: MemoryExtensions.Contains (span-based optimization due to "first-class spans")
// Our implementation handles both identically since Tavily API has limited query operators
this._messageHandlerStub.AddJsonResponse(File.ReadAllText(SiteFilterDevBlogsResponseJson));
ITextSearch<TavilyWebPage> textSearch = new TavilyTextSearch(apiKey: "ApiKey", options: new() { HttpClient = this._httpClient });
string[] domains = ["microsoft.com", "github.com"];

// Act & Assert - Verify that collection Contains pattern throws clear exception
var searchOptions = new TextSearchOptions<TavilyWebPage>
{
Top = 5,
Skip = 0,
Filter = page => domains.Contains(page.Url!.ToString()) // Enumerable.Contains (C# 13-) or MemoryExtensions.Contains (C# 14+)
};

var exception = await Assert.ThrowsAsync<NotSupportedException>(async () =>
{
await textSearch.SearchAsync("test", searchOptions);
});

// Assert - Verify error message explains the limitation clearly
Assert.Contains("Collection Contains filters", exception.Message);
Assert.Contains("not supported", exception.Message);
}

[Fact]
public async Task StringContainsStillWorksWithLINQFiltersAsync()
{
// Arrange - Verify that String.Contains (instance method) still works
// String.Contains is NOT affected by C# 14 "first-class spans" - only arrays are
this._messageHandlerStub.AddJsonResponse(File.ReadAllText(SiteFilterDevBlogsResponseJson));
ITextSearch<TavilyWebPage> textSearch = new TavilyTextSearch(apiKey: "ApiKey", options: new() { HttpClient = this._httpClient });

// Act - String.Contains should continue to work
var searchOptions = new TextSearchOptions<TavilyWebPage>
{
Top = 5,
Skip = 0,
Filter = page => page.Title.Contains("Kernel") // String.Contains - instance method
};
KernelSearchResults<string> result = await textSearch.SearchAsync("Semantic Kernel tutorial", searchOptions);

// Assert - Verify String.Contains works correctly
var requestContents = this._messageHandlerStub.RequestContents;
Assert.Single(requestContents);
Assert.NotNull(requestContents[0]);
var requestBodyJson = Encoding.UTF8.GetString(requestContents[0]!);
Assert.Contains("Kernel", requestBodyJson);
Assert.Contains("\"max_results\":5", requestBodyJson);
}

#endregion

#region private
private const string WhatIsTheSKResponseJson = "./TestData/tavily_what_is_the_semantic_kernel.json";
private const string SiteFilterDevBlogsResponseJson = "./TestData/tavily_site_filter_devblogs_microsoft.com.json";
Expand Down
Loading
Loading