Package com.sap.ai.sdk.grounding.model
Class VectorDocumentKeyValueListPair
java.lang.Object
com.sap.ai.sdk.grounding.model.VectorDocumentKeyValueListPair
VectorDocumentKeyValueListPair
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceBuilder helper class.static interfaceBuilder helper class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDefault constructor for VectorDocumentKeyValueListPair. -
Method Summary
Modifier and TypeMethodDescriptionaddValueItem(String valueItem) Add one value instance to thisVectorDocumentKeyValueListPair.create()Create a type-safe, fluent-api builder object to construct a newVectorDocumentKeyValueListPairinstance with all required arguments.booleangetCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theVectorDocumentKeyValueListPair.getKey()Get keyGet matchModegetValue()Get valueinthashCode()Set the key of thisVectorDocumentKeyValueListPairinstance and return the same instance.matchMode(FilterMatchModeEnum matchMode) Set the matchMode of thisVectorDocumentKeyValueListPairinstance and return the same instance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisVectorDocumentKeyValueListPairinstance.voidSet the key of thisVectorDocumentKeyValueListPairinstance.voidsetMatchMode(FilterMatchModeEnum matchMode) Set the matchMode of thisVectorDocumentKeyValueListPairinstance.voidSet the value of thisVectorDocumentKeyValueListPairinstance.toMap()Get the value of all properties of thisVectorDocumentKeyValueListPairinstance including unrecognized properties.toString()Set the value of thisVectorDocumentKeyValueListPairinstance and return the same instance.
-
Constructor Details
-
VectorDocumentKeyValueListPair
protected VectorDocumentKeyValueListPair()Default constructor for VectorDocumentKeyValueListPair.
-
-
Method Details
-
key
Set the key of thisVectorDocumentKeyValueListPairinstance and return the same instance.- Parameters:
key- The key of thisVectorDocumentKeyValueListPair- Returns:
- The same instance of this
VectorDocumentKeyValueListPairclass
-
getKey
Get key- Returns:
- key The key of this
VectorDocumentKeyValueListPairinstance.
-
setKey
Set the key of thisVectorDocumentKeyValueListPairinstance.- Parameters:
key- The key of thisVectorDocumentKeyValueListPair
-
value
Set the value of thisVectorDocumentKeyValueListPairinstance and return the same instance.- Parameters:
value- The value of thisVectorDocumentKeyValueListPair- Returns:
- The same instance of this
VectorDocumentKeyValueListPairclass
-
addValueItem
Add one value instance to thisVectorDocumentKeyValueListPair.- Parameters:
valueItem- The value that should be added- Returns:
- The same instance of type
VectorDocumentKeyValueListPair
-
getValue
Get value- Returns:
- value The value of this
VectorDocumentKeyValueListPairinstance.
-
setValue
Set the value of thisVectorDocumentKeyValueListPairinstance.- Parameters:
value- The value of thisVectorDocumentKeyValueListPair
-
matchMode
Set the matchMode of thisVectorDocumentKeyValueListPairinstance and return the same instance.- Parameters:
matchMode- The matchMode of thisVectorDocumentKeyValueListPair- Returns:
- The same instance of this
VectorDocumentKeyValueListPairclass
-
getMatchMode
Get matchMode- Returns:
- matchMode The matchMode of this
VectorDocumentKeyValueListPairinstance.
-
setMatchMode
Set the matchMode of thisVectorDocumentKeyValueListPairinstance.- Parameters:
matchMode- The matchMode of thisVectorDocumentKeyValueListPair
-
getCustomFieldNames
Get the names of the unrecognizable properties of theVectorDocumentKeyValueListPair.- Returns:
- The set of properties names
-
getCustomField
@Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException Deprecated.UsetoMap()instead.Get the value of an unrecognizable property of thisVectorDocumentKeyValueListPairinstance.- 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
Get the value of all properties of thisVectorDocumentKeyValueListPairinstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisVectorDocumentKeyValueListPairinstance. 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 propertycustomFieldValue- The value of the property
-
equals
-
hashCode
public int hashCode() -
toString
-
create
Create a type-safe, fluent-api builder object to construct a newVectorDocumentKeyValueListPairinstance with all required arguments.
-
toMap()instead.