Package com.sap.ai.sdk.foundationmodels.openai.generated.model

Class ChatCompletionStreamResponseDelta

java.lang.Object

com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionStreamResponseDelta

public class ChatCompletionStreamResponseDelta
extends Object

A chat completion delta generated by streamed model responses.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChatCompletionStreamResponseDelta.RoleEnum	The role of the author of this message.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionStreamResponseDelta()

Method Summary

Modifier and Type	Method	Description
ChatCompletionStreamResponseDelta	addToolCallsItem(ChatCompletionMessageToolCallChunk toolCallsItem)	Add one toolCalls instance to this ChatCompletionStreamResponseDelta.
ChatCompletionStreamResponseDelta	content(String content)	Set the content of this ChatCompletionStreamResponseDelta instance and return the same instance.
boolean	equals(Object o)
ChatCompletionStreamResponseDelta	functionCall(ChatCompletionStreamResponseDeltaFunctionCall functionCall)	Set the functionCall of this ChatCompletionStreamResponseDelta instance and return the same instance.
String	getContent()	The contents of the chunk message.
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ChatCompletionStreamResponseDelta.
ChatCompletionStreamResponseDeltaFunctionCall	getFunctionCall()	Deprecated.
String	getRefusal()	The refusal message generated by the model.
ChatCompletionStreamResponseDelta.RoleEnum	getRole()	The role of the author of this message.
List<ChatCompletionMessageToolCallChunk>	getToolCalls()	Get toolCalls
int	hashCode()
ChatCompletionStreamResponseDelta	refusal(String refusal)	Set the refusal of this ChatCompletionStreamResponseDelta instance and return the same instance.
ChatCompletionStreamResponseDelta	role(ChatCompletionStreamResponseDelta.RoleEnum role)	Set the role of this ChatCompletionStreamResponseDelta instance and return the same instance.
void	setContent(String content)	Set the content of this ChatCompletionStreamResponseDelta instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ChatCompletionStreamResponseDelta instance.
void	setFunctionCall(ChatCompletionStreamResponseDeltaFunctionCall functionCall)	Set the functionCall of this ChatCompletionStreamResponseDelta instance.
void	setRefusal(String refusal)	Set the refusal of this ChatCompletionStreamResponseDelta instance.
void	setRole(ChatCompletionStreamResponseDelta.RoleEnum role)	Set the role of this ChatCompletionStreamResponseDelta instance.
void	setToolCalls(List<ChatCompletionMessageToolCallChunk> toolCalls)	Set the toolCalls of this ChatCompletionStreamResponseDelta instance.
Map<String,Object>	toMap()	Get the value of all properties of this ChatCompletionStreamResponseDelta instance including unrecognized properties.
ChatCompletionStreamResponseDelta	toolCalls(List<ChatCompletionMessageToolCallChunk> toolCalls)	Set the toolCalls of this ChatCompletionStreamResponseDelta instance and return the same instance.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ChatCompletionStreamResponseDelta

public ChatCompletionStreamResponseDelta()

Method Details

content

@Nonnull
public ChatCompletionStreamResponseDelta content(@Nullable
 String content)

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

Parameters:

content - The contents of the chunk message.

Returns:

The same instance of this ChatCompletionStreamResponseDelta class

getContent

@Nullable
public String getContent()

The contents of the chunk message.

Returns:

content The content of this ChatCompletionStreamResponseDelta instance.

setContent

public void setContent(@Nullable
 String content)

Set the content of this ChatCompletionStreamResponseDelta instance.

Parameters:

content - The contents of the chunk message.

functionCall

@Nonnull
public ChatCompletionStreamResponseDelta functionCall(@Nullable
 ChatCompletionStreamResponseDeltaFunctionCall functionCall)

Set the functionCall of this ChatCompletionStreamResponseDelta instance and return the same instance.

Parameters:

functionCall - The functionCall of this ChatCompletionStreamResponseDelta

Returns:

The same instance of this ChatCompletionStreamResponseDelta class

getFunctionCall

@Deprecated
@Nonnull
public ChatCompletionStreamResponseDeltaFunctionCall getFunctionCall()

Deprecated.

Get functionCall

Returns:

functionCall The functionCall of this ChatCompletionStreamResponseDelta instance.

setFunctionCall

public void setFunctionCall(@Nullable
 ChatCompletionStreamResponseDeltaFunctionCall functionCall)

Set the functionCall of this ChatCompletionStreamResponseDelta instance.

Parameters:

functionCall - The functionCall of this ChatCompletionStreamResponseDelta

toolCalls

@Nonnull
public ChatCompletionStreamResponseDelta toolCalls(@Nullable
 List<ChatCompletionMessageToolCallChunk> toolCalls)

Set the toolCalls of this ChatCompletionStreamResponseDelta instance and return the same instance.

Parameters:

toolCalls - The toolCalls of this ChatCompletionStreamResponseDelta

Returns:

The same instance of this ChatCompletionStreamResponseDelta class

addToolCallsItem

@Nonnull
public ChatCompletionStreamResponseDelta addToolCallsItem(@Nonnull
 ChatCompletionMessageToolCallChunk toolCallsItem)

Add one toolCalls instance to this ChatCompletionStreamResponseDelta.

Parameters:

toolCallsItem - The toolCalls that should be added

Returns:

The same instance of type ChatCompletionStreamResponseDelta

getToolCalls

@Nonnull
public List<ChatCompletionMessageToolCallChunk> getToolCalls()

Get toolCalls

Returns:

toolCalls The toolCalls of this ChatCompletionStreamResponseDelta instance.

setToolCalls

public void setToolCalls(@Nullable
 List<ChatCompletionMessageToolCallChunk> toolCalls)

Set the toolCalls of this ChatCompletionStreamResponseDelta instance.

Parameters:

toolCalls - The toolCalls of this ChatCompletionStreamResponseDelta

role

@Nonnull
public ChatCompletionStreamResponseDelta role(@Nullable
 ChatCompletionStreamResponseDelta.RoleEnum role)

Set the role of this ChatCompletionStreamResponseDelta instance and return the same instance.

Parameters:

role - The role of the author of this message.

Returns:

The same instance of this ChatCompletionStreamResponseDelta class

getRole

@Nonnull
public ChatCompletionStreamResponseDelta.RoleEnum getRole()

The role of the author of this message.

Returns:

role The role of this ChatCompletionStreamResponseDelta instance.

setRole

public void setRole(@Nullable
 ChatCompletionStreamResponseDelta.RoleEnum role)

Set the role of this ChatCompletionStreamResponseDelta instance.

Parameters:

role - The role of the author of this message.

refusal

@Nonnull
public ChatCompletionStreamResponseDelta refusal(@Nullable
 String refusal)

Set the refusal of this ChatCompletionStreamResponseDelta instance and return the same instance.

Parameters:

refusal - The refusal message generated by the model.

Returns:

The same instance of this ChatCompletionStreamResponseDelta class

getRefusal

@Nullable
public String getRefusal()

The refusal message generated by the model.

Returns:

refusal The refusal of this ChatCompletionStreamResponseDelta instance.

setRefusal

public void setRefusal(@Nullable
 String refusal)

Set the refusal of this ChatCompletionStreamResponseDelta instance.

Parameters:

refusal - The refusal message generated by the model.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ChatCompletionStreamResponseDelta.

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 ChatCompletionStreamResponseDelta 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 ChatCompletionStreamResponseDelta 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 ChatCompletionStreamResponseDelta 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