.Net: Plugin ITextSearch.CreateWithGetSearchResults configurable with TextSearchOptions

[f-bourqui]

I want to create a plugin using CreateWithGetSearchResults on a VectorStoreTextSearch and I'd like to configure the TextSearchOptions.
Unfortunately, it's not available.

public static KernelPlugin CreateWithGetSearchResults(this ITextSearch textSearch, string pluginName, string? description = null)
{
    Verify.NotNull(textSearch);
    Verify.NotNull(pluginName);

    return KernelPluginFactory.CreateFromFunctions(pluginName, description, [textSearch.CreateGetSearchResults()]);
}

I would have expected to have this instead

public static KernelPlugin CreateWithGetSearchResults(this ITextSearch textSearch, string pluginName, string? description = null, TextSearchOptions? searchOptions = null)
{
    Verify.NotNull(textSearch);
    Verify.NotNull(pluginName);

    return KernelPluginFactory.CreateFromFunctions(pluginName, description, [textSearch.CreateGetSearchResults(searchOptions:searchOptions)]);
}

I first thought that it would be configurable while injecting it kernelBuilder.AddVectorStoreTextSearch by providing VectorStoreTextSearchOptions but that class is empty.

Does it make sense to add TextSearchOptions to CreateWithGetSearchResults or is it planned to do it with VectorStoreTextSearchOptions?

[markwallace-microsoft]

Hi @f-bourqui
you can skip the extension method and instead do this:

var plugin = KernelPluginFactory.CreateFromFunctions(pluginName, description, [textSearch.CreateGetSearchResults(searchOptions: yourSearchOptions)]);

[f-bourqui]

Yes, I did my own extension to it. By this issue, I also wanted to understand the intent of VectorStoreTextSearchOptions vs TextSearchOptions since one is empty.

[markwallace-microsoft]

So VectorStoreTextSearchOptions was added to the API as a placeholder for additional options. It is currently experimental so we may remove it if we don't find a use for it.