.Net: Change the return type of ITextSearch to align with search abstractions in M.E.VD #11782
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…- Phase 1 (#11519) ### Motivation and Context 1. Change the return type of ITextSearch to align with search abstractions in M.E.VD 2. Make `top` a required parameter to align with search abstractions in M.E.VD ### Description <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [ ] The code builds clean without any errors or warnings - [ ] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [ ] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone 😄
### Motivation and Context 1. Update BraveTextSearch to use latest `ITextSearch` 2. Add integration tests ### Description <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [ ] The code builds clean without any errors or warnings - [ ] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [ ] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone 😄
markwallace-microsoft
added
.NET
markwallace-microsoft
temporarily deployed
to
integration
GitHub Actions
Inactive
markwallace-microsoft
temporarily deployed
to
integration
GitHub Actions
Inactive
markwallace-microsoft
had a problem deploying
to
integration
GitHub Actions
Failure
markwallace-microsoft
force-pushed
the
feature-itextsearch-alignment
branch
from
9bfab25 to
b45637a
Compare
markwallace-microsoft
had a problem deploying
to
integration
GitHub Actions
Failure
markwallace-microsoft
force-pushed
the
feature-itextsearch-alignment
branch
from
b45637a to
3d1f86f
Compare
markwallace-microsoft
had a problem deploying
to
integration
GitHub Actions
Failure
markwallace-microsoft
temporarily deployed
to
integration
GitHub Actions
Inactive
westey-m
reviewed
May 7, 2025
| /// <returns>A <see cref="KernelPlugin"/> instance with a Search operation that calls the provided <see cref="ITextSearch.SearchAsync(string, TextSearchOptions?, CancellationToken)"/>.</returns> | ||
| [RequiresUnreferencedCode("Uses reflection to handle various aspects of the function creation and invocation, making it incompatible with AOT scenarios.")] | ||
| [RequiresDynamicCode("Uses reflection to handle various aspects of the function creation and invocation, making it incompatible with AOT scenarios.")] | ||
| public static KernelPlugin CreateWithSearch(this ITextSearch textSearch, int top, string pluginName, string? description = null) |
There was a problem hiding this comment.
I've been struggling with these names, since they don't actually tell you what it's creating.
Since you call it on textsearch, it sounds like it's creating a textsearch, but that doesn't really make sense since you already have a textsearch instance.
The different overloads also don't really clearly tell me what I'm going to get. I always need to go and look at the code to try and figure out if I'm going to get back a string only or one of the other types.
Since we are introducing new methods this may be a good opportunity to revisit the naming.
An alternative naming scheme:
ToSearchPlugin
ToCitationSearchPlugin
ToProviderSearchPlugin
westey-m
approved these changes
May 7, 2025
markwallace-microsoft
had a problem deploying
to
integration
GitHub Actions
Failure
markwallace-microsoft
had a problem deploying
to
integration
GitHub Actions
Failure
markwallace-microsoft
had a problem deploying
to
integration
GitHub Actions
Failure
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
Description
Contribution Checklist