Package com.sap.ai.sdk.grounding.model

Class VectorPerFilterSearchResult

java.lang.Object

com.sap.ai.sdk.grounding.model.VectorPerFilterSearchResult

public class VectorPerFilterSearchResult
extends Object

VectorPerFilterSearchResult

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VectorPerFilterSearchResult.Builder	Builder helper class.
static interface	VectorPerFilterSearchResult.Builder1	Builder helper class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VectorPerFilterSearchResult()	Default constructor for VectorPerFilterSearchResult.

Method Summary

Modifier and Type	Method	Description
VectorPerFilterSearchResult	addResultsItem(DocumentsChunk resultsItem)	Add one results instance to this VectorPerFilterSearchResult.
static VectorPerFilterSearchResult.Builder	create()	Create a type-safe, fluent-api builder object to construct a new VectorPerFilterSearchResult instance with all required arguments.
boolean	equals(Object o)
VectorPerFilterSearchResult	filterId(String filterId)	Set the filterId of this VectorPerFilterSearchResult instance and return the same instance.
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the VectorPerFilterSearchResult.
String	getFilterId()	Get filterId
List<DocumentsChunk>	getResults()	Get results
int	hashCode()
VectorPerFilterSearchResult	results(List<DocumentsChunk> results)	Set the results of this VectorPerFilterSearchResult instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this VectorPerFilterSearchResult instance.
void	setFilterId(String filterId)	Set the filterId of this VectorPerFilterSearchResult instance.
void	setResults(List<DocumentsChunk> results)	Set the results of this VectorPerFilterSearchResult instance.
Map<String,Object>	toMap()	Get the value of all properties of this VectorPerFilterSearchResult instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

VectorPerFilterSearchResult

protected VectorPerFilterSearchResult()

Default constructor for VectorPerFilterSearchResult.

Method Details

filterId

@Nonnull
public VectorPerFilterSearchResult filterId(@Nonnull
 String filterId)

Set the filterId of this VectorPerFilterSearchResult instance and return the same instance.

Parameters:

filterId - The filterId of this VectorPerFilterSearchResult

Returns:

The same instance of this VectorPerFilterSearchResult class

getFilterId

@Nonnull
public String getFilterId()

Get filterId

Returns:

filterId The filterId of this VectorPerFilterSearchResult instance.

setFilterId

public void setFilterId(@Nonnull
 String filterId)

Set the filterId of this VectorPerFilterSearchResult instance.

Parameters:

filterId - The filterId of this VectorPerFilterSearchResult

results

@Nonnull
public VectorPerFilterSearchResult results(@Nonnull
 List<DocumentsChunk> results)

Set the results of this VectorPerFilterSearchResult instance and return the same instance.

Parameters:

results - The results of this VectorPerFilterSearchResult

Returns:

The same instance of this VectorPerFilterSearchResult class

addResultsItem

@Nonnull
public VectorPerFilterSearchResult addResultsItem(@Nonnull
 DocumentsChunk resultsItem)

Add one results instance to this VectorPerFilterSearchResult.

Parameters:

resultsItem - The results that should be added

Returns:

The same instance of type VectorPerFilterSearchResult

getResults

@Nonnull
public List<DocumentsChunk> getResults()

Get results

Returns:

results The results of this VectorPerFilterSearchResult instance.

setResults

public void setResults(@Nonnull
 List<DocumentsChunk> results)

Set the results of this VectorPerFilterSearchResult instance.

Parameters:

results - The results of this VectorPerFilterSearchResult

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the VectorPerFilterSearchResult.

Returns:

The set of properties names

getCustomField

@Nullable
@Deprecated
public Object getCustomField(@Nonnull
 String name)
                      throws NoSuchElementException

Deprecated.

Use toMap() instead.

Get the value of an unrecognizable property of this VectorPerFilterSearchResult instance.

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

NoSuchElementException - If no property with the given name could be found.

toMap

@Nonnull
public Map<String,Object> toMap()

Get the value of all properties of this VectorPerFilterSearchResult instance including unrecognized properties.

Returns:

The map of all properties

setCustomField

public void setCustomField(@Nonnull
 String customFieldName,
 @Nullable
 Object customFieldValue)

Set an unrecognizable property of this VectorPerFilterSearchResult instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

customFieldName - The name of the property

customFieldValue - The value of the property

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

create

public static VectorPerFilterSearchResult.Builder create()

Create a type-safe, fluent-api builder object to construct a new VectorPerFilterSearchResult instance with all required arguments.