InlineDocumentContent¶

class oci.ai_document.models.InlineDocumentContent(**kwargs)¶

Bases: InputLocation

The content of an inline document.

Attributes:

`SOURCE_TYPE_INLINE_DOCUMENT_CONTENT`	A constant which can be used with the source_type property of a InputLocation.
`SOURCE_TYPE_OBJECT_STORAGE_LOCATIONS`	A constant which can be used with the source_type property of a InputLocation.
`data`	[Required] Gets the data of this InlineDocumentContent.
`page_range`	Gets the page_range of this InlineDocumentContent.
`source_type`	[Required] Gets the source_type of this InputLocation.

Methods:

`__init__`(**kwargs)	Initializes a new InlineDocumentContent 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.

SOURCE_TYPE_INLINE_DOCUMENT_CONTENT = 'INLINE_DOCUMENT_CONTENT'¶: A constant which can be used with the source_type property of a InputLocation. This constant has a value of “INLINE_DOCUMENT_CONTENT”

SOURCE_TYPE_OBJECT_STORAGE_LOCATIONS = 'OBJECT_STORAGE_LOCATIONS'¶: A constant which can be used with the source_type property of a InputLocation. This constant has a value of “OBJECT_STORAGE_LOCATIONS”

__init__(**kwargs)¶

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

Parameters

source_type (str) – The value to assign to the source_type property of this InlineDocumentContent. Allowed values for this property are: “OBJECT_STORAGE_LOCATIONS”, “INLINE_DOCUMENT_CONTENT”
data (str) – The value to assign to the data property of this InlineDocumentContent.
page_range (list[str]) – The value to assign to the page_range property of this InlineDocumentContent.

property data¶

[Required] Gets the data of this InlineDocumentContent. Raw document data with Base64 encoding.

Returns: The data of this InlineDocumentContent.
Return type: str

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

Gets the page_range of this InlineDocumentContent. The page ranges to be analysed.

Returns: The page_range of this InlineDocumentContent.
Return type: list[str]

property source_type¶

[Required] Gets the source_type of this InputLocation. The type of input location. The allowed values are: - OBJECT_STORAGE_LOCATIONS: A list of object locations in Object Storage. - INLINE_DOCUMENT_CONTENT: The content of an inline document.

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

Returns: The source_type of this InputLocation.
Return type: str