AnalyzeDocumentResult

class oci.ai_vision.models.AnalyzeDocumentResult(**kwargs)

Bases: object

The document analysis results.

Methods

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

Attributes

detected_document_types Gets the detected_document_types of this AnalyzeDocumentResult.
detected_languages Gets the detected_languages of this AnalyzeDocumentResult.
document_classification_model_version Gets the document_classification_model_version of this AnalyzeDocumentResult.
document_metadata [Required] Gets the document_metadata of this AnalyzeDocumentResult.
errors Gets the errors of this AnalyzeDocumentResult.
key_value_detection_model_version Gets the key_value_detection_model_version of this AnalyzeDocumentResult.
language_classification_model_version Gets the language_classification_model_version of this AnalyzeDocumentResult.
pages [Required] Gets the pages of this AnalyzeDocumentResult.
searchable_pdf Gets the searchable_pdf of this AnalyzeDocumentResult.
table_detection_model_version Gets the table_detection_model_version of this AnalyzeDocumentResult.
text_detection_model_version Gets the text_detection_model_version of this AnalyzeDocumentResult.
__init__(**kwargs)

Initializes a new AnalyzeDocumentResult object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • document_metadata (oci.ai_vision.models.DocumentMetadata) – The value to assign to the document_metadata property of this AnalyzeDocumentResult.
  • pages (list[oci.ai_vision.models.Page]) – The value to assign to the pages property of this AnalyzeDocumentResult.
  • detected_document_types (list[oci.ai_vision.models.DetectedDocumentType]) – The value to assign to the detected_document_types property of this AnalyzeDocumentResult.
  • detected_languages (list[oci.ai_vision.models.DetectedLanguage]) – The value to assign to the detected_languages property of this AnalyzeDocumentResult.
  • document_classification_model_version (str) – The value to assign to the document_classification_model_version property of this AnalyzeDocumentResult.
  • language_classification_model_version (str) – The value to assign to the language_classification_model_version property of this AnalyzeDocumentResult.
  • text_detection_model_version (str) – The value to assign to the text_detection_model_version property of this AnalyzeDocumentResult.
  • key_value_detection_model_version (str) – The value to assign to the key_value_detection_model_version property of this AnalyzeDocumentResult.
  • table_detection_model_version (str) – The value to assign to the table_detection_model_version property of this AnalyzeDocumentResult.
  • errors (list[oci.ai_vision.models.ProcessingError]) – The value to assign to the errors property of this AnalyzeDocumentResult.
  • searchable_pdf (str) – The value to assign to the searchable_pdf property of this AnalyzeDocumentResult.
detected_document_types

Gets the detected_document_types of this AnalyzeDocumentResult. An array of detected document types.

Returns:The detected_document_types of this AnalyzeDocumentResult.
Return type:list[oci.ai_vision.models.DetectedDocumentType]
detected_languages

Gets the detected_languages of this AnalyzeDocumentResult. An array of detected languages.

Returns:The detected_languages of this AnalyzeDocumentResult.
Return type:list[oci.ai_vision.models.DetectedLanguage]
document_classification_model_version

Gets the document_classification_model_version of this AnalyzeDocumentResult. The document classification model version.

Returns:The document_classification_model_version of this AnalyzeDocumentResult.
Return type:str
document_metadata

[Required] Gets the document_metadata of this AnalyzeDocumentResult.

Returns:The document_metadata of this AnalyzeDocumentResult.
Return type:oci.ai_vision.models.DocumentMetadata
errors

Gets the errors of this AnalyzeDocumentResult. The errors encountered during document analysis.

Returns:The errors of this AnalyzeDocumentResult.
Return type:list[oci.ai_vision.models.ProcessingError]
key_value_detection_model_version

Gets the key_value_detection_model_version of this AnalyzeDocumentResult. The document keyValue detection model version.

Returns:The key_value_detection_model_version of this AnalyzeDocumentResult.
Return type:str
language_classification_model_version

Gets the language_classification_model_version of this AnalyzeDocumentResult. The document language classification model version.

Returns:The language_classification_model_version of this AnalyzeDocumentResult.
Return type:str
pages

[Required] Gets the pages of this AnalyzeDocumentResult. The array of a Page.

Returns:The pages of this AnalyzeDocumentResult.
Return type:list[oci.ai_vision.models.Page]
searchable_pdf

Gets the searchable_pdf of this AnalyzeDocumentResult. The searchable PDF file that was generated.

Returns:The searchable_pdf of this AnalyzeDocumentResult.
Return type:str
table_detection_model_version

Gets the table_detection_model_version of this AnalyzeDocumentResult. The document table detection model version.

Returns:The table_detection_model_version of this AnalyzeDocumentResult.
Return type:str
text_detection_model_version

Gets the text_detection_model_version of this AnalyzeDocumentResult. The document text detection model version.

Returns:The text_detection_model_version of this AnalyzeDocumentResult.
Return type:str