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

Class ChatCompletionTokenLogprob

java.lang.Object

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

public class ChatCompletionTokenLogprob
extends Object

ChatCompletionTokenLogprob

Constructor Summary

Constructors

Constructor	Description
ChatCompletionTokenLogprob()

Method Summary

Modifier and Type	Method	Description
ChatCompletionTokenLogprob	addBytesItem(Integer bytesItem)	Add one bytes instance to this ChatCompletionTokenLogprob.
ChatCompletionTokenLogprob	addTopLogprobsItem(ChatCompletionTokenLogprobTopLogprobsInner topLogprobsItem)	Add one topLogprobs instance to this ChatCompletionTokenLogprob.
ChatCompletionTokenLogprob	bytes(List<Integer> bytes)	Set the bytes of this ChatCompletionTokenLogprob instance and return the same instance.
boolean	equals(Object o)
List<Integer>	getBytes()	A list of integers representing the UTF-8 bytes representation of the token.
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ChatCompletionTokenLogprob.
BigDecimal	getLogprob()	The log probability of this token.
String	getToken()	The token.
List<ChatCompletionTokenLogprobTopLogprobsInner>	getTopLogprobs()	List of the most likely tokens and their log probability, at this token position.
int	hashCode()
ChatCompletionTokenLogprob	logprob(BigDecimal logprob)	Set the logprob of this ChatCompletionTokenLogprob instance and return the same instance.
void	setBytes(List<Integer> bytes)	Set the bytes of this ChatCompletionTokenLogprob instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ChatCompletionTokenLogprob instance.
void	setLogprob(BigDecimal logprob)	Set the logprob of this ChatCompletionTokenLogprob instance.
void	setToken(String token)	Set the token of this ChatCompletionTokenLogprob instance.
void	setTopLogprobs(List<ChatCompletionTokenLogprobTopLogprobsInner> topLogprobs)	Set the topLogprobs of this ChatCompletionTokenLogprob instance.
ChatCompletionTokenLogprob	token(String token)	Set the token of this ChatCompletionTokenLogprob instance and return the same instance.
Map<String,Object>	toMap()	Get the value of all properties of this ChatCompletionTokenLogprob instance including unrecognized properties.
ChatCompletionTokenLogprob	topLogprobs(List<ChatCompletionTokenLogprobTopLogprobsInner> topLogprobs)	Set the topLogprobs of this ChatCompletionTokenLogprob 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

ChatCompletionTokenLogprob

public ChatCompletionTokenLogprob()

Method Details

token

@Nonnull
public ChatCompletionTokenLogprob token(@Nonnull
 String token)

Set the token of this ChatCompletionTokenLogprob instance and return the same instance.

Parameters:

token - The token.

Returns:

The same instance of this ChatCompletionTokenLogprob class

getToken

@Nonnull
public String getToken()

The token.

Returns:

token The token of this ChatCompletionTokenLogprob instance.

setToken

public void setToken(@Nonnull
 String token)

Set the token of this ChatCompletionTokenLogprob instance.

Parameters:

token - The token.

logprob

@Nonnull
public ChatCompletionTokenLogprob logprob(@Nonnull
 BigDecimal logprob)

Set the logprob of this ChatCompletionTokenLogprob instance and return the same instance.

Parameters:

logprob - The log probability of this token.

Returns:

The same instance of this ChatCompletionTokenLogprob class

getLogprob

@Nonnull
public BigDecimal getLogprob()

The log probability of this token.

Returns:

logprob The logprob of this ChatCompletionTokenLogprob instance.

setLogprob

public void setLogprob(@Nonnull
 BigDecimal logprob)

Set the logprob of this ChatCompletionTokenLogprob instance.

Parameters:

logprob - The log probability of this token.

bytes

@Nonnull
public ChatCompletionTokenLogprob bytes(@Nullable
 List<Integer> bytes)

Set the bytes of this ChatCompletionTokenLogprob instance and return the same instance.

Parameters:

bytes - A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.

Returns:

The same instance of this ChatCompletionTokenLogprob class

addBytesItem

@Nonnull
public ChatCompletionTokenLogprob addBytesItem(@Nonnull
 Integer bytesItem)

Add one bytes instance to this ChatCompletionTokenLogprob.

Parameters:

bytesItem - The bytes that should be added

Returns:

The same instance of type ChatCompletionTokenLogprob

getBytes

@Nullable
public List<Integer> getBytes()

A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.

Returns:

bytes The bytes of this ChatCompletionTokenLogprob instance.

setBytes

public void setBytes(@Nullable
 List<Integer> bytes)

Set the bytes of this ChatCompletionTokenLogprob instance.

Parameters:

bytes - A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.

topLogprobs

@Nonnull
public ChatCompletionTokenLogprob topLogprobs(@Nonnull
 List<ChatCompletionTokenLogprobTopLogprobsInner> topLogprobs)

Set the topLogprobs of this ChatCompletionTokenLogprob instance and return the same instance.

Parameters:

topLogprobs - List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.

Returns:

The same instance of this ChatCompletionTokenLogprob class

addTopLogprobsItem

@Nonnull
public ChatCompletionTokenLogprob addTopLogprobsItem(@Nonnull
 ChatCompletionTokenLogprobTopLogprobsInner topLogprobsItem)

Add one topLogprobs instance to this ChatCompletionTokenLogprob.

Parameters:

topLogprobsItem - The topLogprobs that should be added

Returns:

The same instance of type ChatCompletionTokenLogprob

getTopLogprobs

@Nonnull
public List<ChatCompletionTokenLogprobTopLogprobsInner> getTopLogprobs()

List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.

Returns:

topLogprobs The topLogprobs of this ChatCompletionTokenLogprob instance.

setTopLogprobs

public void setTopLogprobs(@Nonnull
 List<ChatCompletionTokenLogprobTopLogprobsInner> topLogprobs)

Set the topLogprobs of this ChatCompletionTokenLogprob instance.

Parameters:

topLogprobs - List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ChatCompletionTokenLogprob.

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