DocumentContent¶

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

Bases: ChatContent

Represents a single instance of chat document content.

Attributes:

`TYPE_IMAGE`	A constant which can be used with the type property of a ChatContent.
`TYPE_TEXT`	A constant which can be used with the type property of a ChatContent.
`document_url`	Gets the document_url of this DocumentContent.
`type`	[Required] Gets the type of this ChatContent.

Methods:

`__init__`(**kwargs)	Initializes a new DocumentContent 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 ChatContent. This constant has a value of “IMAGE”

TYPE_TEXT = 'TEXT'¶: A constant which can be used with the type property of a ChatContent. This constant has a value of “TEXT”

__init__(**kwargs)¶

Initializes a new DocumentContent object with values from keyword arguments. The default value of the type attribute of this class is DOCUMENT 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 DocumentContent. Allowed values for this property are: “TEXT”, “IMAGE”
document_url (oci.generative_ai_inference.models.DocumentUrl) – The value to assign to the document_url property of this DocumentContent.

property document_url¶

Gets the document_url of this DocumentContent.

Returns: The document_url of this DocumentContent.
Return type: oci.generative_ai_inference.models.DocumentUrl

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 type¶

[Required] Gets the type of this ChatContent. 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 ChatContent.
Return type: str