DocumentUrl¶

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

Bases: object

The base64 encoded document data or a document uri if it’s supported.

Attributes

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

Methods

__init__(**kwargs) Initializes a new DocumentUrl object with values from keyword arguments.

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

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

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

__init__(**kwargs)¶

Initializes a new DocumentUrl 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 DocumentUrl. detail (str) – The value to assign to the detail property of this DocumentUrl. 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’.

detail¶

Gets the detail of this DocumentUrl. The default value is AUTO and only AUTO is supported. This option controls how to convert the base64 encoded document 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 DocumentUrl.
Return type:	str

url¶

[Required] Gets the url of this DocumentUrl. The base64 encoded document data or a document uri if it’s supported.

Example for a pdf document:

`{

“type”: “DOCUMENT”, “documentUrl”: {

“url”: “data:application/pdf;base64,<base64 encoded document content>”

}

}`

Example with a document uri:

`{

“type”: “DOCUMENT”, “videoUrl”: {

“url”: “data:application/pdf;uri,<document uri>”

}

}`

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