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

Class TextOnlyBaseChunkCreate

java.lang.Object

com.sap.ai.sdk.grounding.model.TextOnlyBaseChunkCreate

public class TextOnlyBaseChunkCreate
extends Object

Schema for a text-only chunk.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TextOnlyBaseChunkCreate.Builder	Builder helper class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TextOnlyBaseChunkCreate	addMetadataItem(VectorKeyValueListPair metadataItem)	Add one metadata instance to this TextOnlyBaseChunkCreate.
TextOnlyBaseChunkCreate	content(String content)	Set the content of this TextOnlyBaseChunkCreate instance and return the same instance.
static TextOnlyBaseChunkCreate.Builder	create()	Create a type-safe, fluent-api builder object to construct a new TextOnlyBaseChunkCreate 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 TextOnlyBaseChunkCreate.
List<VectorKeyValueListPair>	getMetadata()	Get metadata
int	hashCode()
TextOnlyBaseChunkCreate	metadata(List<VectorKeyValueListPair> metadata)	Set the metadata of this TextOnlyBaseChunkCreate instance and return the same instance.
void	setContent(String content)	Set the content of this TextOnlyBaseChunkCreate instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this TextOnlyBaseChunkCreate instance.
void	setMetadata(List<VectorKeyValueListPair> metadata)	Set the metadata of this TextOnlyBaseChunkCreate instance.
Map<String,Object>	toMap()	Get the value of all properties of this TextOnlyBaseChunkCreate instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TextOnlyBaseChunkCreate

protected TextOnlyBaseChunkCreate()

Default constructor for TextOnlyBaseChunkCreate.

Method Details

content

@Nonnull
public TextOnlyBaseChunkCreate content(@Nonnull
 String content)

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

Parameters:

content - The content of this TextOnlyBaseChunkCreate

Returns:

The same instance of this TextOnlyBaseChunkCreate class

getContent

@Nonnull
public String getContent()

Get content

Returns:

content The content of this TextOnlyBaseChunkCreate instance.

setContent

public void setContent(@Nonnull
 String content)

Set the content of this TextOnlyBaseChunkCreate instance.

Parameters:

content - The content of this TextOnlyBaseChunkCreate

metadata

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

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

Parameters:

metadata - The metadata of this TextOnlyBaseChunkCreate

Returns:

The same instance of this TextOnlyBaseChunkCreate class

addMetadataItem

@Nonnull
public TextOnlyBaseChunkCreate addMetadataItem(@Nonnull
 VectorKeyValueListPair metadataItem)

Add one metadata instance to this TextOnlyBaseChunkCreate.

Parameters:

metadataItem - The metadata that should be added

Returns:

The same instance of type TextOnlyBaseChunkCreate

getMetadata

@Nonnull
public List<VectorKeyValueListPair> getMetadata()

Get metadata

Returns:

metadata The metadata of this TextOnlyBaseChunkCreate instance.

setMetadata

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

Set the metadata of this TextOnlyBaseChunkCreate instance.

Parameters:

metadata - The metadata of this TextOnlyBaseChunkCreate

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the TextOnlyBaseChunkCreate.

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

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