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

Class CreateChatCompletionStreamResponse

java.lang.Object

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

All Implemented Interfaces:

ChatCompletionsCreate200Response

public class CreateChatCompletionStreamResponse
extends Object
implements ChatCompletionsCreate200Response

Represents a streamed chunk of a chat completion response returned by model, based on the provided input.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CreateChatCompletionStreamResponse.ObjectEnum	The object type, which is always `chat.completion.chunk`.

Constructor Summary

Constructors

Constructor	Description
CreateChatCompletionStreamResponse()

Method Summary

Modifier and Type	Method	Description
CreateChatCompletionStreamResponse	_object(CreateChatCompletionStreamResponse.ObjectEnum _object)	Set the _object of this CreateChatCompletionStreamResponse instance and return the same instance.
CreateChatCompletionStreamResponse	addChoicesItem(CreateChatCompletionStreamResponseChoicesInner choicesItem)	Add one choices instance to this CreateChatCompletionStreamResponse.
CreateChatCompletionStreamResponse	choices(List<CreateChatCompletionStreamResponseChoicesInner> choices)	Set the choices of this CreateChatCompletionStreamResponse instance and return the same instance.
CreateChatCompletionStreamResponse	created(Integer created)	Set the created of this CreateChatCompletionStreamResponse instance and return the same instance.
boolean	equals(Object o)
List<CreateChatCompletionStreamResponseChoicesInner>	getChoices()	A list of chat completion choices.
Integer	getCreated()	The Unix timestamp (in seconds) of when the chat completion was created.
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the CreateChatCompletionStreamResponse.
String	getId()	A unique identifier for the chat completion.
String	getModel()	The model to generate the completion.
CreateChatCompletionStreamResponse.ObjectEnum	getObject()	The object type, which is always `chat.completion.chunk`.
String	getSystemFingerprint()	This fingerprint represents the backend configuration that the model runs with.
int	hashCode()
CreateChatCompletionStreamResponse	id(String id)	Set the id of this CreateChatCompletionStreamResponse instance and return the same instance.
CreateChatCompletionStreamResponse	model(String model)	Set the model of this CreateChatCompletionStreamResponse instance and return the same instance.
void	setChoices(List<CreateChatCompletionStreamResponseChoicesInner> choices)	Set the choices of this CreateChatCompletionStreamResponse instance.
void	setCreated(Integer created)	Set the created of this CreateChatCompletionStreamResponse instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this CreateChatCompletionStreamResponse instance.
void	setId(String id)	Set the id of this CreateChatCompletionStreamResponse instance.
void	setModel(String model)	Set the model of this CreateChatCompletionStreamResponse instance.
void	setObject(CreateChatCompletionStreamResponse.ObjectEnum _object)	Set the _object of this CreateChatCompletionStreamResponse instance.
void	setSystemFingerprint(String systemFingerprint)	Set the systemFingerprint of this CreateChatCompletionStreamResponse instance.
CreateChatCompletionStreamResponse	systemFingerprint(String systemFingerprint)	Set the systemFingerprint of this CreateChatCompletionStreamResponse instance and return the same instance.
Map<String,Object>	toMap()	Get the value of all properties of this CreateChatCompletionStreamResponse instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CreateChatCompletionStreamResponse

public CreateChatCompletionStreamResponse()

Method Details

id

@Nonnull
public CreateChatCompletionStreamResponse id(@Nonnull
 String id)

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

Parameters:

id - A unique identifier for the chat completion. Each chunk has the same ID.

Returns:

The same instance of this CreateChatCompletionStreamResponse class

getId

@Nonnull
public String getId()

A unique identifier for the chat completion. Each chunk has the same ID.

Returns:

id The id of this CreateChatCompletionStreamResponse instance.

setId

public void setId(@Nonnull
 String id)

Set the id of this CreateChatCompletionStreamResponse instance.

Parameters:

id - A unique identifier for the chat completion. Each chunk has the same ID.

choices

@Nonnull
public CreateChatCompletionStreamResponse choices(@Nonnull
 List<CreateChatCompletionStreamResponseChoicesInner> choices)

Set the choices of this CreateChatCompletionStreamResponse instance and return the same instance.

Parameters:

choices - A list of chat completion choices. Can contain more than one elements if `n` is greater than 1.

Returns:

The same instance of this CreateChatCompletionStreamResponse class

addChoicesItem

@Nonnull
public CreateChatCompletionStreamResponse addChoicesItem(@Nonnull
 CreateChatCompletionStreamResponseChoicesInner choicesItem)

Add one choices instance to this CreateChatCompletionStreamResponse.

Parameters:

choicesItem - The choices that should be added

Returns:

The same instance of type CreateChatCompletionStreamResponse

getChoices

@Nonnull
public List<CreateChatCompletionStreamResponseChoicesInner> getChoices()

A list of chat completion choices. Can contain more than one elements if `n` is greater than 1.

Returns:

choices The choices of this CreateChatCompletionStreamResponse instance.

setChoices

public void setChoices(@Nonnull
 List<CreateChatCompletionStreamResponseChoicesInner> choices)

Set the choices of this CreateChatCompletionStreamResponse instance.

Parameters:

choices - A list of chat completion choices. Can contain more than one elements if `n` is greater than 1.

created

@Nonnull
public CreateChatCompletionStreamResponse created(@Nonnull
 Integer created)

Set the created of this CreateChatCompletionStreamResponse instance and return the same instance.

Parameters:

created - The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.

Returns:

The same instance of this CreateChatCompletionStreamResponse class

getCreated

@Nonnull
public Integer getCreated()

The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.

Returns:

created The created of this CreateChatCompletionStreamResponse instance.

setCreated

public void setCreated(@Nonnull
 Integer created)

Set the created of this CreateChatCompletionStreamResponse instance.

Parameters:

created - The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.

model

@Nonnull
public CreateChatCompletionStreamResponse model(@Nonnull
 String model)

Set the model of this CreateChatCompletionStreamResponse instance and return the same instance.

Parameters:

model - The model to generate the completion.

Returns:

The same instance of this CreateChatCompletionStreamResponse class

getModel

@Nonnull
public String getModel()

The model to generate the completion.

Returns:

model The model of this CreateChatCompletionStreamResponse instance.

setModel

public void setModel(@Nonnull
 String model)

Set the model of this CreateChatCompletionStreamResponse instance.

Parameters:

model - The model to generate the completion.

systemFingerprint

@Nonnull
public CreateChatCompletionStreamResponse systemFingerprint(@Nullable
 String systemFingerprint)

Set the systemFingerprint of this CreateChatCompletionStreamResponse instance and return the same instance.

Parameters:

systemFingerprint - This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.

Returns:

The same instance of this CreateChatCompletionStreamResponse class

getSystemFingerprint

@Nonnull
public String getSystemFingerprint()

This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.

Returns:

systemFingerprint The systemFingerprint of this CreateChatCompletionStreamResponse instance.

setSystemFingerprint

public void setSystemFingerprint(@Nullable
 String systemFingerprint)

Set the systemFingerprint of this CreateChatCompletionStreamResponse instance.

Parameters:

systemFingerprint - This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.

_object

@Nonnull
public CreateChatCompletionStreamResponse _object(@Nonnull
 CreateChatCompletionStreamResponse.ObjectEnum _object)

Set the _object of this CreateChatCompletionStreamResponse instance and return the same instance.

Parameters:

_object - The object type, which is always `chat.completion.chunk`.

Returns:

The same instance of this CreateChatCompletionStreamResponse class

getObject

@Nonnull
public CreateChatCompletionStreamResponse.ObjectEnum getObject()

The object type, which is always `chat.completion.chunk`.

Returns:

_object The _object of this CreateChatCompletionStreamResponse instance.

setObject

public void setObject(@Nonnull
 CreateChatCompletionStreamResponse.ObjectEnum _object)

Set the _object of this CreateChatCompletionStreamResponse instance.

Parameters:

_object - The object type, which is always `chat.completion.chunk`.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the CreateChatCompletionStreamResponse.

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