ObjectStorageDocumentDetails

class oci.ai_document.models.ObjectStorageDocumentDetails(**kwargs)

Bases: DocumentDetails

A document in OCI Object Storage.

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.
bucket_name	[Required] Gets the bucket_name of this ObjectStorageDocumentDetails.
namespace_name	[Required] Gets the namespace_name of this ObjectStorageDocumentDetails.
object_name	[Required] Gets the object_name of this ObjectStorageDocumentDetails.
page_range	Gets the page_range of this ObjectStorageDocumentDetails.
source	[Required] Gets the source of this DocumentDetails.

Methods:

__init__(**kwargs)	Initializes a new ObjectStorageDocumentDetails 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 ObjectStorageDocumentDetails object with values from keyword arguments. The default value of the source attribute of this class is OBJECT_STORAGE 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 ObjectStorageDocumentDetails. Allowed values for this property are: “INLINE”, “OBJECT_STORAGE”

• namespace_name (str) – The value to assign to the namespace_name property of this ObjectStorageDocumentDetails.

• bucket_name (str) – The value to assign to the bucket_name property of this ObjectStorageDocumentDetails.

• object_name (str) – The value to assign to the object_name property of this ObjectStorageDocumentDetails.

• page_range (list[str]) – The value to assign to the page_range property of this ObjectStorageDocumentDetails.

property bucket_name

[Required] Gets the bucket_name of this ObjectStorageDocumentDetails. The Object Storage bucket name.

Returns

The bucket_name of this ObjectStorageDocumentDetails.

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 namespace_name

[Required] Gets the namespace_name of this ObjectStorageDocumentDetails. The Object Storage namespace.

Returns

The namespace_name of this ObjectStorageDocumentDetails.

Return type

str

property object_name

[Required] Gets the object_name of this ObjectStorageDocumentDetails. The Object Storage object name.

Returns

The object_name of this ObjectStorageDocumentDetails.

Return type

str

property page_range

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

Returns

The page_range of this ObjectStorageDocumentDetails.

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