InlineDocumentDetails¶

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

Bases: DocumentDetails

The document incorporated in the request payload.

Attributes:

`SOURCE_INLINE`	A constant which can be used with the source property of a DocumentDetails.
`SOURCE_OBJECT_STORAGE`	A constant which can be used with the source property of a DocumentDetails.
`data`	[Required] Gets the data of this InlineDocumentDetails.
`page_range`	Gets the page_range of this InlineDocumentDetails.
`source`	[Required] Gets the source of this DocumentDetails.

Methods:

`__init__`(**kwargs)	Initializes a new InlineDocumentDetails 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_INLINE = 'INLINE'¶: A constant which can be used with the source property of a DocumentDetails. This constant has a value of “INLINE”

SOURCE_OBJECT_STORAGE = 'OBJECT_STORAGE'¶: A constant which can be used with the source property of a DocumentDetails. This constant has a value of “OBJECT_STORAGE”

__init__(**kwargs)¶

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

Parameters

source (str) – The value to assign to the source property of this InlineDocumentDetails. Allowed values for this property are: “INLINE”, “OBJECT_STORAGE”
data (str) – The value to assign to the data property of this InlineDocumentDetails.
page_range (list[str]) – The value to assign to the page_range property of this InlineDocumentDetails.

property data¶

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

Returns: The data of this InlineDocumentDetails.
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 InlineDocumentDetails. The page ranges to be analysed.

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

property source¶

[Required] Gets the source of this DocumentDetails. The location of the document data. The allowed values are: - INLINE: The data is included directly in the request payload. - OBJECT_STORAGE: The document is in OCI Object Storage.

Allowed values for this property are: “INLINE”, “OBJECT_STORAGE”

Returns: The source of this DocumentDetails.
Return type: str