Package com.microsoft.semantickernel.data.vectorsearch

Class VectorSearchResults<Record>

java.lang.Object

com.microsoft.semantickernel.data.vectorsearch.VectorSearchResults<Record>

Type Parameters:

Record - The type of the search results.

public class VectorSearchResults<Record>
extends Object

The search results.

Constructor Summary

Constructors

Constructor	Description
VectorSearchResults(List<VectorSearchResult<Record>> results)	Creates a new instance of the VectorSearchResults class.
VectorSearchResults(List<VectorSearchResult<Record>> results, long totalCount, Map<String,Object> metadata)	Creates a new instance of the VectorSearchResults class.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getMetadata()	Gets the metadata associated with the search results.
List<VectorSearchResult<Record>>	getResults()	Gets the search results.
long	getTotalCount()	Gets the total count of search results.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VectorSearchResults

public VectorSearchResults(List<VectorSearchResult<Record>> results)

Creates a new instance of the VectorSearchResults class.

Parameters:

results - The search results.

VectorSearchResults

public VectorSearchResults(List<VectorSearchResult<Record>> results,
                           long totalCount,
                           Map<String,Object> metadata)

Creates a new instance of the VectorSearchResults class.

Parameters:

results - The search results.

totalCount - The total count of search results.

metadata - The metadata.

Method Detail

getTotalCount

public long getTotalCount()

Gets the total count of search results. This value represents the total number of results that are available for the current query and not the number of results being returned.

Returns:

The total count of search results.

getResults

public List<VectorSearchResult<Record>> getResults()

Gets the search results.

Returns:

The search results.

getMetadata

public Map<String,Object> getMetadata()

Gets the metadata associated with the search results.

Returns:

The metadata.