DocumentDetails¶
- class oci.ai_document.models.DocumentDetails(**kwargs)¶
Bases:
objectThe details of a document to analyze.
Attributes:
A constant which can be used with the source property of a DocumentDetails.
A constant which can be used with the source property of a DocumentDetails.
[Required] Gets the source of this DocumentDetails.
Methods:
__init__(**kwargs)Initializes a new DocumentDetails 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 DocumentDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
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 DocumentDetails. Allowed values for this property are: “INLINE”, “OBJECT_STORAGE”
- 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 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