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

Class TextOnlyBaseChunk

java.lang.Object

com.sap.ai.sdk.grounding.model.TextOnlyBaseChunk

public class TextOnlyBaseChunk
extends Object

Schema for a text-only chunk.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TextOnlyBaseChunk	addMetadataItem(VectorKeyValueListPair metadataItem)	Add one metadata instance to this TextOnlyBaseChunk.
TextOnlyBaseChunk	content(String content)	Set the content of this TextOnlyBaseChunk instance and return the same instance.
static TextOnlyBaseChunk.Builder	create()	Create a type-safe, fluent-api builder object to construct a new TextOnlyBaseChunk instance with all required arguments.
boolean	equals(Object o)
String	getContent()	Get content
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the TextOnlyBaseChunk.
UUID	getId()	Unique identifier of a chuk.
List<VectorKeyValueListPair>	getMetadata()	Get metadata
int	hashCode()
TextOnlyBaseChunk	id(UUID id)	Set the id of this TextOnlyBaseChunk instance and return the same instance.
TextOnlyBaseChunk	metadata(List<VectorKeyValueListPair> metadata)	Set the metadata of this TextOnlyBaseChunk instance and return the same instance.
void	setContent(String content)	Set the content of this TextOnlyBaseChunk instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this TextOnlyBaseChunk instance.
void	setId(UUID id)	Set the id of this TextOnlyBaseChunk instance.
void	setMetadata(List<VectorKeyValueListPair> metadata)	Set the metadata of this TextOnlyBaseChunk instance.
Map<String,Object>	toMap()	Get the value of all properties of this TextOnlyBaseChunk instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TextOnlyBaseChunk

protected TextOnlyBaseChunk()

Default constructor for TextOnlyBaseChunk.

Method Details

content

@Nonnull
public TextOnlyBaseChunk content(@Nonnull
 String content)

Set the content of this TextOnlyBaseChunk instance and return the same instance.

Parameters:

content - The content of this TextOnlyBaseChunk

Returns:

The same instance of this TextOnlyBaseChunk class

getContent

@Nonnull
public String getContent()

Get content

Returns:

content The content of this TextOnlyBaseChunk instance.

setContent

public void setContent(@Nonnull
 String content)

Set the content of this TextOnlyBaseChunk instance.

Parameters:

content - The content of this TextOnlyBaseChunk

metadata

@Nonnull
public TextOnlyBaseChunk metadata(@Nullable
 List<VectorKeyValueListPair> metadata)

Set the metadata of this TextOnlyBaseChunk instance and return the same instance.

Parameters:

metadata - The metadata of this TextOnlyBaseChunk

Returns:

The same instance of this TextOnlyBaseChunk class

addMetadataItem

@Nonnull
public TextOnlyBaseChunk addMetadataItem(@Nonnull
 VectorKeyValueListPair metadataItem)

Add one metadata instance to this TextOnlyBaseChunk.

Parameters:

metadataItem - The metadata that should be added

Returns:

The same instance of type TextOnlyBaseChunk

getMetadata

@Nonnull
public List<VectorKeyValueListPair> getMetadata()

Get metadata

Returns:

metadata The metadata of this TextOnlyBaseChunk instance.

setMetadata

public void setMetadata(@Nullable
 List<VectorKeyValueListPair> metadata)

Set the metadata of this TextOnlyBaseChunk instance.

Parameters:

metadata - The metadata of this TextOnlyBaseChunk

id

@Nonnull
public TextOnlyBaseChunk id(@Nonnull
 UUID id)

Set the id of this TextOnlyBaseChunk instance and return the same instance.

Parameters:

id - Unique identifier of a chuk.

Returns:

The same instance of this TextOnlyBaseChunk class

getId

@Nonnull
public UUID getId()

Unique identifier of a chuk.

Returns:

id The id of this TextOnlyBaseChunk instance.

setId

public void setId(@Nonnull
 UUID id)

Set the id of this TextOnlyBaseChunk instance.

Parameters:

id - Unique identifier of a chuk.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the TextOnlyBaseChunk.

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

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