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

Class CreateChatCompletionResponseChoicesInner

java.lang.Object

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

public class CreateChatCompletionResponseChoicesInner
extends Object

CreateChatCompletionResponseChoicesInner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CreateChatCompletionResponseChoicesInner.FinishReasonEnum	The reason the model stopped generating tokens.

Constructor Summary

Constructors

Constructor	Description
CreateChatCompletionResponseChoicesInner()

Method Summary

Modifier and Type	Method	Description
CreateChatCompletionResponseChoicesInner	contentFilterResults(ContentFilterChoiceResults contentFilterResults)	Set the contentFilterResults of this CreateChatCompletionResponseChoicesInner instance and return the same instance.
boolean	equals(Object o)
CreateChatCompletionResponseChoicesInner	finishReason(CreateChatCompletionResponseChoicesInner.FinishReasonEnum finishReason)	Set the finishReason of this CreateChatCompletionResponseChoicesInner instance and return the same instance.
ContentFilterChoiceResults	getContentFilterResults()	Get contentFilterResults
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the CreateChatCompletionResponseChoicesInner.
CreateChatCompletionResponseChoicesInner.FinishReasonEnum	getFinishReason()	The reason the model stopped generating tokens.
Integer	getIndex()	The index of the choice in the list of choices.
CreateChatCompletionResponseChoicesInnerLogprobs	getLogprobs()	Get logprobs
ChatCompletionResponseMessage	getMessage()	Get message
int	hashCode()
CreateChatCompletionResponseChoicesInner	index(Integer index)	Set the index of this CreateChatCompletionResponseChoicesInner instance and return the same instance.
CreateChatCompletionResponseChoicesInner	logprobs(CreateChatCompletionResponseChoicesInnerLogprobs logprobs)	Set the logprobs of this CreateChatCompletionResponseChoicesInner instance and return the same instance.
CreateChatCompletionResponseChoicesInner	message(ChatCompletionResponseMessage message)	Set the message of this CreateChatCompletionResponseChoicesInner instance and return the same instance.
void	setContentFilterResults(ContentFilterChoiceResults contentFilterResults)	Set the contentFilterResults of this CreateChatCompletionResponseChoicesInner instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this CreateChatCompletionResponseChoicesInner instance.
void	setFinishReason(CreateChatCompletionResponseChoicesInner.FinishReasonEnum finishReason)	Set the finishReason of this CreateChatCompletionResponseChoicesInner instance.
void	setIndex(Integer index)	Set the index of this CreateChatCompletionResponseChoicesInner instance.
void	setLogprobs(CreateChatCompletionResponseChoicesInnerLogprobs logprobs)	Set the logprobs of this CreateChatCompletionResponseChoicesInner instance.
void	setMessage(ChatCompletionResponseMessage message)	Set the message of this CreateChatCompletionResponseChoicesInner instance.
Map<String,Object>	toMap()	Get the value of all properties of this CreateChatCompletionResponseChoicesInner instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CreateChatCompletionResponseChoicesInner

public CreateChatCompletionResponseChoicesInner()

Method Details

finishReason

@Nonnull
public CreateChatCompletionResponseChoicesInner finishReason(@Nonnull
 CreateChatCompletionResponseChoicesInner.FinishReasonEnum finishReason)

Set the finishReason of this CreateChatCompletionResponseChoicesInner instance and return the same instance.

Parameters:

finishReason - The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.

Returns:

The same instance of this CreateChatCompletionResponseChoicesInner class

getFinishReason

@Nonnull
public CreateChatCompletionResponseChoicesInner.FinishReasonEnum getFinishReason()

The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.

Returns:

finishReason The finishReason of this CreateChatCompletionResponseChoicesInner instance.

setFinishReason

public void setFinishReason(@Nonnull
 CreateChatCompletionResponseChoicesInner.FinishReasonEnum finishReason)

Set the finishReason of this CreateChatCompletionResponseChoicesInner instance.

Parameters:

finishReason - The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.

index

@Nonnull
public CreateChatCompletionResponseChoicesInner index(@Nonnull
 Integer index)

Set the index of this CreateChatCompletionResponseChoicesInner instance and return the same instance.

Parameters:

index - The index of the choice in the list of choices.

Returns:

The same instance of this CreateChatCompletionResponseChoicesInner class

getIndex

@Nonnull
public Integer getIndex()

The index of the choice in the list of choices.

Returns:

index The index of this CreateChatCompletionResponseChoicesInner instance.

setIndex

public void setIndex(@Nonnull
 Integer index)

Set the index of this CreateChatCompletionResponseChoicesInner instance.

Parameters:

index - The index of the choice in the list of choices.

message

@Nonnull
public CreateChatCompletionResponseChoicesInner message(@Nonnull
 ChatCompletionResponseMessage message)

Set the message of this CreateChatCompletionResponseChoicesInner instance and return the same instance.

Parameters:

message - The message of this CreateChatCompletionResponseChoicesInner

Returns:

The same instance of this CreateChatCompletionResponseChoicesInner class

getMessage

@Nonnull
public ChatCompletionResponseMessage getMessage()

Get message

Returns:

message The message of this CreateChatCompletionResponseChoicesInner instance.

setMessage

public void setMessage(@Nonnull
 ChatCompletionResponseMessage message)

Set the message of this CreateChatCompletionResponseChoicesInner instance.

Parameters:

message - The message of this CreateChatCompletionResponseChoicesInner

contentFilterResults

@Nonnull
public CreateChatCompletionResponseChoicesInner contentFilterResults(@Nullable
 ContentFilterChoiceResults contentFilterResults)

Set the contentFilterResults of this CreateChatCompletionResponseChoicesInner instance and return the same instance.

Parameters:

contentFilterResults - The contentFilterResults of this CreateChatCompletionResponseChoicesInner

Returns:

The same instance of this CreateChatCompletionResponseChoicesInner class

getContentFilterResults

@Nonnull
public ContentFilterChoiceResults getContentFilterResults()

Get contentFilterResults

Returns:

contentFilterResults The contentFilterResults of this CreateChatCompletionResponseChoicesInner instance.

setContentFilterResults

public void setContentFilterResults(@Nullable
 ContentFilterChoiceResults contentFilterResults)

Set the contentFilterResults of this CreateChatCompletionResponseChoicesInner instance.

Parameters:

contentFilterResults - The contentFilterResults of this CreateChatCompletionResponseChoicesInner

logprobs

@Nonnull
public CreateChatCompletionResponseChoicesInner logprobs(@Nullable
 CreateChatCompletionResponseChoicesInnerLogprobs logprobs)

Set the logprobs of this CreateChatCompletionResponseChoicesInner instance and return the same instance.

Parameters:

logprobs - The logprobs of this CreateChatCompletionResponseChoicesInner

Returns:

The same instance of this CreateChatCompletionResponseChoicesInner class

getLogprobs

@Nullable
public CreateChatCompletionResponseChoicesInnerLogprobs getLogprobs()

Get logprobs

Returns:

logprobs The logprobs of this CreateChatCompletionResponseChoicesInner instance.

setLogprobs

public void setLogprobs(@Nullable
 CreateChatCompletionResponseChoicesInnerLogprobs logprobs)

Set the logprobs of this CreateChatCompletionResponseChoicesInner instance.

Parameters:

logprobs - The logprobs of this CreateChatCompletionResponseChoicesInner

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the CreateChatCompletionResponseChoicesInner.

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