ImageUrl¶

class oci.generative_ai_inference.models.ImageUrl(**kwargs)¶

Bases: object

Provide a base64 encoded image or an image uri if it’s supported.

Attributes:

`DETAIL_AUTO`	A constant which can be used with the detail property of a ImageUrl.
`DETAIL_HIGH`	A constant which can be used with the detail property of a ImageUrl.
`DETAIL_LOW`	A constant which can be used with the detail property of a ImageUrl.
`detail`	Gets the detail of this ImageUrl.
`url`	[Required] Gets the url of this ImageUrl.

Methods:

__init__(**kwargs)

Initializes a new ImageUrl object with values from keyword arguments.

DETAIL_AUTO = 'AUTO'¶: A constant which can be used with the detail property of a ImageUrl. This constant has a value of “AUTO”

DETAIL_HIGH = 'HIGH'¶: A constant which can be used with the detail property of a ImageUrl. This constant has a value of “HIGH”

DETAIL_LOW = 'LOW'¶: A constant which can be used with the detail property of a ImageUrl. This constant has a value of “LOW”

__init__(**kwargs)¶

Initializes a new ImageUrl object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

url (str) – The value to assign to the url property of this ImageUrl.
detail (str) – The value to assign to the detail property of this ImageUrl. Allowed values for this property are: “AUTO”, “HIGH”, “LOW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property detail¶

Gets the detail of this ImageUrl. The default value is AUTO and only AUTO is supported. This option controls how to convert the base64 encoded image to tokens.

Allowed values for this property are: “AUTO”, “HIGH”, “LOW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The detail of this ImageUrl.
Return type: str

property url¶

[Required] Gets the url of this ImageUrl. The base64 encoded image data or an image uri if it’s supported.

Example for a png image:

`{

“type”: “IMAGE”, “imageUrl”: {

“url”: “data:image/png;base64,<base64 encoded image content>”

}

}`

Example with an image uri:

`{

“type”: “IMAGE”, “imageUrl”: {

“url”: “data:image/png;uri,<image uri>”

}

}`

Returns: The url of this ImageUrl.
Return type: str