com.microsoft.semantickernel.data.textsearch.TextSearch Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of semantickernel-api Show documentation

Defines the public interface for the Semantic Kernel

There is a newer version: 1.3.0

// Copyright (c) Microsoft. All rights reserved.
package com.microsoft.semantickernel.data.textsearch;

import reactor.core.publisher.Mono;

public interface TextSearch {

    /**
     * Perform a search for content related to the specified query and return String values representing the search results.
     *
     * @param query   The text to search for.
     * @param options The search options.
     * @return The search results.
     */
    Mono> searchAsync(String query, TextSearchOptions options);

    /**
     * Perform a search for content related to the specified query and return TextSearchResult values representing the search results.
     *
     * @param query   The text to search for.
     * @param options The search options.
     * @return The search results.
     */
    Mono> getTextSearchResultsAsync(String query,
        TextSearchOptions options);

    /**
     * Perform a search for content related to the specified query and return Object values representing the search results.
     *
     * @param query   The text to search for.
     * @param options The search options.
     * @return The search results.
     */
    Mono> getSearchResultsAsync(String query,
        TextSearchOptions options);
}