Class LLMModuleResultStreaming
java.lang.Object
com.sap.ai.sdk.orchestration.model.LLMModuleResultStreaming
Output of LLM module. Follows the OpenAI spec.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceBuilder helper class.static interfaceBuilder helper class.static interfaceBuilder helper class.static interfaceBuilder helper class.static interfaceBuilder helper class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDefault constructor for LLMModuleResultStreaming. -
Method Summary
Modifier and TypeMethodDescriptionSet the _object of thisLLMModuleResultStreaminginstance and return the same instance.addChoicesItem(LLMChoiceStreaming choicesItem) Add one choices instance to thisLLMModuleResultStreaming.addCitationsItem(Citation citationsItem) Add one citations instance to thisLLMModuleResultStreaming.choices(List<LLMChoiceStreaming> choices) Set the choices of thisLLMModuleResultStreaminginstance and return the same instance.Set the citations of thisLLMModuleResultStreaminginstance and return the same instance.create()Create a type-safe, fluent-api builder object to construct a newLLMModuleResultStreaminginstance with all required arguments.Set the created of thisLLMModuleResultStreaminginstance and return the same instance.booleanChoicesList of citations associated with the response.Unix timestampgetCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theLLMModuleResultStreaming.getId()ID of the responsegetModel()Model nameObject typeSystem fingerprintgetUsage()Get usageinthashCode()Set the id of thisLLMModuleResultStreaminginstance and return the same instance.Set the model of thisLLMModuleResultStreaminginstance and return the same instance.voidsetChoices(List<LLMChoiceStreaming> choices) Set the choices of thisLLMModuleResultStreaminginstance.voidsetCitations(List<Citation> citations) Set the citations of thisLLMModuleResultStreaminginstance.voidsetCreated(Integer created) Set the created of thisLLMModuleResultStreaminginstance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisLLMModuleResultStreaminginstance.voidSet the id of thisLLMModuleResultStreaminginstance.voidSet the model of thisLLMModuleResultStreaminginstance.voidSet the _object of thisLLMModuleResultStreaminginstance.voidsetSystemFingerprint(String systemFingerprint) Set the systemFingerprint of thisLLMModuleResultStreaminginstance.voidsetUsage(TokenUsage usage) Set the usage of thisLLMModuleResultStreaminginstance.systemFingerprint(String systemFingerprint) Set the systemFingerprint of thisLLMModuleResultStreaminginstance and return the same instance.toMap()Get the value of all properties of thisLLMModuleResultStreaminginstance including unrecognized properties.toString()usage(TokenUsage usage) Set the usage of thisLLMModuleResultStreaminginstance and return the same instance.
-
Constructor Details
-
LLMModuleResultStreaming
protected LLMModuleResultStreaming()Default constructor for LLMModuleResultStreaming.
-
-
Method Details
-
id
Set the id of thisLLMModuleResultStreaminginstance and return the same instance.- Parameters:
id- ID of the response- Returns:
- The same instance of this
LLMModuleResultStreamingclass
-
getId
ID of the response- Returns:
- id The id of this
LLMModuleResultStreaminginstance.
-
setId
Set the id of thisLLMModuleResultStreaminginstance.- Parameters:
id- ID of the response
-
_object
Set the _object of thisLLMModuleResultStreaminginstance and return the same instance.- Parameters:
_object- Object type- Returns:
- The same instance of this
LLMModuleResultStreamingclass
-
getObject
Object type- Returns:
- _object The _object of this
LLMModuleResultStreaminginstance.
-
setObject
Set the _object of thisLLMModuleResultStreaminginstance.- Parameters:
_object- Object type
-
created
Set the created of thisLLMModuleResultStreaminginstance and return the same instance.- Parameters:
created- Unix timestamp- Returns:
- The same instance of this
LLMModuleResultStreamingclass
-
getCreated
Unix timestamp- Returns:
- created The created of this
LLMModuleResultStreaminginstance.
-
setCreated
Set the created of thisLLMModuleResultStreaminginstance.- Parameters:
created- Unix timestamp
-
model
Set the model of thisLLMModuleResultStreaminginstance and return the same instance.- Parameters:
model- Model name- Returns:
- The same instance of this
LLMModuleResultStreamingclass
-
getModel
Model name- Returns:
- model The model of this
LLMModuleResultStreaminginstance.
-
setModel
Set the model of thisLLMModuleResultStreaminginstance.- Parameters:
model- Model name
-
systemFingerprint
Set the systemFingerprint of thisLLMModuleResultStreaminginstance and return the same instance.- Parameters:
systemFingerprint- System fingerprint- Returns:
- The same instance of this
LLMModuleResultStreamingclass
-
getSystemFingerprint
System fingerprint- Returns:
- systemFingerprint The systemFingerprint of this
LLMModuleResultStreaminginstance.
-
setSystemFingerprint
Set the systemFingerprint of thisLLMModuleResultStreaminginstance.- Parameters:
systemFingerprint- System fingerprint
-
choices
Set the choices of thisLLMModuleResultStreaminginstance and return the same instance.- Parameters:
choices- Choices- Returns:
- The same instance of this
LLMModuleResultStreamingclass
-
addChoicesItem
Add one choices instance to thisLLMModuleResultStreaming.- Parameters:
choicesItem- The choices that should be added- Returns:
- The same instance of type
LLMModuleResultStreaming
-
getChoices
Choices- Returns:
- choices The choices of this
LLMModuleResultStreaminginstance.
-
setChoices
Set the choices of thisLLMModuleResultStreaminginstance.- Parameters:
choices- Choices
-
usage
Set the usage of thisLLMModuleResultStreaminginstance and return the same instance.- Parameters:
usage- The usage of thisLLMModuleResultStreaming- Returns:
- The same instance of this
LLMModuleResultStreamingclass
-
getUsage
Get usage- Returns:
- usage The usage of this
LLMModuleResultStreaminginstance.
-
setUsage
Set the usage of thisLLMModuleResultStreaminginstance.- Parameters:
usage- The usage of thisLLMModuleResultStreaming
-
citations
Set the citations of thisLLMModuleResultStreaminginstance and return the same instance.- Parameters:
citations- List of citations associated with the response.- Returns:
- The same instance of this
LLMModuleResultStreamingclass
-
addCitationsItem
Add one citations instance to thisLLMModuleResultStreaming.- Parameters:
citationsItem- The citations that should be added- Returns:
- The same instance of type
LLMModuleResultStreaming
-
getCitations
List of citations associated with the response.- Returns:
- citations The citations of this
LLMModuleResultStreaminginstance.
-
setCitations
Set the citations of thisLLMModuleResultStreaminginstance.- Parameters:
citations- List of citations associated with the response.
-
getCustomFieldNames
Get the names of the unrecognizable properties of theLLMModuleResultStreaming.- 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 thisLLMModuleResultStreaminginstance.- 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 thisLLMModuleResultStreaminginstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisLLMModuleResultStreaminginstance. 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 newLLMModuleResultStreaminginstance with all required arguments.
-
toMap()instead.