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

Class ChatCompletionRequestMessageContentPartImageImageUrl

java.lang.Object

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

public class ChatCompletionRequestMessageContentPartImageImageUrl
extends Object

ChatCompletionRequestMessageContentPartImageImageUrl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChatCompletionRequestMessageContentPartImageImageUrl.DetailEnum	Specifies the detail level of the image.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionRequestMessageContentPartImageImageUrl()

Method Summary

Modifier and Type	Method	Description
ChatCompletionRequestMessageContentPartImageImageUrl	detail(ChatCompletionRequestMessageContentPartImageImageUrl.DetailEnum detail)	Set the detail of this ChatCompletionRequestMessageContentPartImageImageUrl instance and return the same instance.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ChatCompletionRequestMessageContentPartImageImageUrl.
ChatCompletionRequestMessageContentPartImageImageUrl.DetailEnum	getDetail()	Specifies the detail level of the image.
URI	getUrl()	Either a URL of the image or the base64 encoded image data.
int	hashCode()
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ChatCompletionRequestMessageContentPartImageImageUrl instance.
void	setDetail(ChatCompletionRequestMessageContentPartImageImageUrl.DetailEnum detail)	Set the detail of this ChatCompletionRequestMessageContentPartImageImageUrl instance.
void	setUrl(URI url)	Set the url of this ChatCompletionRequestMessageContentPartImageImageUrl instance.
Map<String,Object>	toMap()	Get the value of all properties of this ChatCompletionRequestMessageContentPartImageImageUrl instance including unrecognized properties.
String	toString()
ChatCompletionRequestMessageContentPartImageImageUrl	url(URI url)	Set the url of this ChatCompletionRequestMessageContentPartImageImageUrl instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

ChatCompletionRequestMessageContentPartImageImageUrl

public ChatCompletionRequestMessageContentPartImageImageUrl()

Method Details

url

@Nonnull
public ChatCompletionRequestMessageContentPartImageImageUrl url(@Nonnull
 URI url)

Set the url of this ChatCompletionRequestMessageContentPartImageImageUrl instance and return the same instance.

Parameters:

url - Either a URL of the image or the base64 encoded image data.

Returns:

The same instance of this ChatCompletionRequestMessageContentPartImageImageUrl class

getUrl

@Nonnull
public URI getUrl()

Either a URL of the image or the base64 encoded image data.

Returns:

url The url of this ChatCompletionRequestMessageContentPartImageImageUrl instance.

setUrl

public void setUrl(@Nonnull
 URI url)

Set the url of this ChatCompletionRequestMessageContentPartImageImageUrl instance.

Parameters:

url - Either a URL of the image or the base64 encoded image data.

detail

@Nonnull
public ChatCompletionRequestMessageContentPartImageImageUrl detail(@Nullable
 ChatCompletionRequestMessageContentPartImageImageUrl.DetailEnum detail)

Set the detail of this ChatCompletionRequestMessageContentPartImageImageUrl instance and return the same instance.

Parameters:

detail - Specifies the detail level of the image. Learn more in the [Vision guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/gpt-with-vision?tabs=rest%2Csystem-assigned%2Cresource#detail-parameter-settings-in-image-processing-low-high-auto).

Returns:

The same instance of this ChatCompletionRequestMessageContentPartImageImageUrl class

getDetail

@Nonnull
public ChatCompletionRequestMessageContentPartImageImageUrl.DetailEnum getDetail()

Specifies the detail level of the image. Learn more in the [Vision guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/gpt-with-vision?tabs=rest%2Csystem-assigned%2Cresource#detail-parameter-settings-in-image-processing-low-high-auto).

Returns:

detail The detail of this ChatCompletionRequestMessageContentPartImageImageUrl instance.

setDetail

public void setDetail(@Nullable
 ChatCompletionRequestMessageContentPartImageImageUrl.DetailEnum detail)

Set the detail of this ChatCompletionRequestMessageContentPartImageImageUrl instance.

Parameters:

detail - Specifies the detail level of the image. Learn more in the [Vision guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/gpt-with-vision?tabs=rest%2Csystem-assigned%2Cresource#detail-parameter-settings-in-image-processing-low-high-auto).

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ChatCompletionRequestMessageContentPartImageImageUrl.

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