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

Class TextSearchRequest

java.lang.Object

com.sap.ai.sdk.grounding.model.TextSearchRequest

public class TextSearchRequest
extends Object

TextSearchRequest

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TextSearchRequest	addFiltersItem(VectorSearchFilter filtersItem)	Add one filters instance to this TextSearchRequest.
static TextSearchRequest.Builder	create()	Create a type-safe, fluent-api builder object to construct a new TextSearchRequest instance with all required arguments.
boolean	equals(Object o)
TextSearchRequest	filters(List<VectorSearchFilter> filters)	Set the filters of this TextSearchRequest 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 TextSearchRequest.
List<VectorSearchFilter>	getFilters()	Get filters
String	getQuery()	Query string
int	hashCode()
TextSearchRequest	query(String query)	Set the query of this TextSearchRequest instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this TextSearchRequest instance.
void	setFilters(List<VectorSearchFilter> filters)	Set the filters of this TextSearchRequest instance.
void	setQuery(String query)	Set the query of this TextSearchRequest instance.
Map<String,Object>	toMap()	Get the value of all properties of this TextSearchRequest instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TextSearchRequest

protected TextSearchRequest()

Default constructor for TextSearchRequest.

Method Details

query

@Nonnull
public TextSearchRequest query(@Nullable
 String query)

Set the query of this TextSearchRequest instance and return the same instance.

Parameters:

query - Query string

Returns:

The same instance of this TextSearchRequest class

getQuery

@Nullable
public String getQuery()

Query string

Returns:

query The query of this TextSearchRequest instance.

setQuery

public void setQuery(@Nullable
 String query)

Set the query of this TextSearchRequest instance.

Parameters:

query - Query string

filters

@Nonnull
public TextSearchRequest filters(@Nonnull
 List<VectorSearchFilter> filters)

Set the filters of this TextSearchRequest instance and return the same instance.

Parameters:

filters - The filters of this TextSearchRequest

Returns:

The same instance of this TextSearchRequest class

addFiltersItem

@Nonnull
public TextSearchRequest addFiltersItem(@Nonnull
 VectorSearchFilter filtersItem)

Add one filters instance to this TextSearchRequest.

Parameters:

filtersItem - The filters that should be added

Returns:

The same instance of type TextSearchRequest

getFilters

@Nonnull
public List<VectorSearchFilter> getFilters()

Get filters

Returns:

filters The filters of this TextSearchRequest instance.

setFilters

public void setFilters(@Nonnull
 List<VectorSearchFilter> filters)

Set the filters of this TextSearchRequest instance.

Parameters:

filters - The filters of this TextSearchRequest

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the TextSearchRequest.

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 TextSearchRequest 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 TextSearchRequest 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 TextSearchRequest 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 TextSearchRequest.Builder create()

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