EmbedImageContent

class oci.generative_ai_inference.models.EmbedImageContent(**kwargs)

Bases: EmbedContent

Represents a single instance of embed image content.

Attributes:

TYPE_IMAGE

A constant which can be used with the type property of a EmbedContent.

TYPE_TEXT

A constant which can be used with the type property of a EmbedContent.

image_url

Gets the image_url of this EmbedImageContent.

type

[Required] Gets the type of this EmbedContent.

Methods:

__init__(**kwargs)

Initializes a new EmbedImageContent object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

TYPE_IMAGE = 'IMAGE'

A constant which can be used with the type property of a EmbedContent. This constant has a value of “IMAGE”

TYPE_TEXT = 'TEXT'

A constant which can be used with the type property of a EmbedContent. This constant has a value of “TEXT”

__init__(**kwargs)

Initializes a new EmbedImageContent object with values from keyword arguments. The default value of the type attribute of this class is IMAGE and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • type (str) – The value to assign to the type property of this EmbedImageContent. Allowed values for this property are: “TEXT”, “IMAGE”

  • image_url (oci.generative_ai_inference.models.ImageUrl) – The value to assign to the image_url property of this EmbedImageContent.

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property image_url

Gets the image_url of this EmbedImageContent.

Returns

The image_url of this EmbedImageContent.

Return type

oci.generative_ai_inference.models.ImageUrl

property type

[Required] Gets the type of this EmbedContent. The type of the content.

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

Returns

The type of this EmbedContent.

Return type

str