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

Class ChatCompletionRequestMessageContentPartImage

java.lang.Object

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

All Implemented Interfaces:

ChatCompletionRequestUserMessageContentPart

public class ChatCompletionRequestMessageContentPartImage
extends Object
implements ChatCompletionRequestUserMessageContentPart

ChatCompletionRequestMessageContentPartImage

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChatCompletionRequestMessageContentPartImage.TypeEnum	The type of the content part.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionRequestMessageContentPartImage()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ChatCompletionRequestMessageContentPartImage.
ChatCompletionRequestMessageContentPartImageImageUrl	getImageUrl()	Get imageUrl
ChatCompletionRequestMessageContentPartImage.TypeEnum	getType()	The type of the content part.
int	hashCode()
ChatCompletionRequestMessageContentPartImage	imageUrl(ChatCompletionRequestMessageContentPartImageImageUrl imageUrl)	Set the imageUrl of this ChatCompletionRequestMessageContentPartImage instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ChatCompletionRequestMessageContentPartImage instance.
void	setImageUrl(ChatCompletionRequestMessageContentPartImageImageUrl imageUrl)	Set the imageUrl of this ChatCompletionRequestMessageContentPartImage instance.
void	setType(ChatCompletionRequestMessageContentPartImage.TypeEnum type)	Set the type of this ChatCompletionRequestMessageContentPartImage instance.
Map<String,Object>	toMap()	Get the value of all properties of this ChatCompletionRequestMessageContentPartImage instance including unrecognized properties.
String	toString()
ChatCompletionRequestMessageContentPartImage	type(ChatCompletionRequestMessageContentPartImage.TypeEnum type)	Set the type of this ChatCompletionRequestMessageContentPartImage instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

ChatCompletionRequestMessageContentPartImage

public ChatCompletionRequestMessageContentPartImage()

Method Details

type

@Nonnull
public ChatCompletionRequestMessageContentPartImage type(@Nonnull
 ChatCompletionRequestMessageContentPartImage.TypeEnum type)

Set the type of this ChatCompletionRequestMessageContentPartImage instance and return the same instance.

Parameters:

type - The type of the content part.

Returns:

The same instance of this ChatCompletionRequestMessageContentPartImage class

getType

@Nonnull
public ChatCompletionRequestMessageContentPartImage.TypeEnum getType()

The type of the content part.

Returns:

type The type of this ChatCompletionRequestMessageContentPartImage instance.

setType

public void setType(@Nonnull
 ChatCompletionRequestMessageContentPartImage.TypeEnum type)

Set the type of this ChatCompletionRequestMessageContentPartImage instance.

Parameters:

type - The type of the content part.

imageUrl

@Nonnull
public ChatCompletionRequestMessageContentPartImage imageUrl(@Nonnull
 ChatCompletionRequestMessageContentPartImageImageUrl imageUrl)

Set the imageUrl of this ChatCompletionRequestMessageContentPartImage instance and return the same instance.

Parameters:

imageUrl - The imageUrl of this ChatCompletionRequestMessageContentPartImage

Returns:

The same instance of this ChatCompletionRequestMessageContentPartImage class

getImageUrl

@Nonnull
public ChatCompletionRequestMessageContentPartImageImageUrl getImageUrl()

Get imageUrl

Returns:

imageUrl The imageUrl of this ChatCompletionRequestMessageContentPartImage instance.

setImageUrl

public void setImageUrl(@Nonnull
 ChatCompletionRequestMessageContentPartImageImageUrl imageUrl)

Set the imageUrl of this ChatCompletionRequestMessageContentPartImage instance.

Parameters:

imageUrl - The imageUrl of this ChatCompletionRequestMessageContentPartImage

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ChatCompletionRequestMessageContentPartImage.

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