Struct AnalyzeDocumentOutput

#[non_exhaustive]
pub struct AnalyzeDocumentOutput {
    pub document_metadata: Option<DocumentMetadata>,
    pub blocks: Option<Vec<Block>>,
    pub human_loop_activation_output: Option<HumanLoopActivationOutput>,
    pub analyze_document_model_version: Option<String>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

document_metadata: Option<DocumentMetadata>

Metadata about the analyzed document. An example is the number of pages.

blocks: Option<Vec<Block>>

The items that are detected and analyzed by AnalyzeDocument.

human_loop_activation_output: Option<HumanLoopActivationOutput>

Shows the results of the human in the loop evaluation.

analyze_document_model_version: Option<String>

The version of the model used to analyze the document.

Implementations

impl AnalyzeDocumentOutput

pub fn document_metadata(&self) -> Option<&DocumentMetadata>

Metadata about the analyzed document. An example is the number of pages.

pub fn blocks(&self) -> &[Block]

The items that are detected and analyzed by AnalyzeDocument.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .blocks.is_none().

pub fn human_loop_activation_output(&self) -> Option<&HumanLoopActivationOutput>

Shows the results of the human in the loop evaluation.

pub fn analyze_document_model_version(&self) -> Option<&str>

The version of the model used to analyze the document.

impl AnalyzeDocumentOutput

pub fn builder() -> AnalyzeDocumentOutputBuilder

Creates a new builder-style object to manufacture AnalyzeDocumentOutput.

Trait Implementations

impl Clone for AnalyzeDocumentOutput

fn clone(&self) -> AnalyzeDocumentOutput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AnalyzeDocumentOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AnalyzeDocumentOutput

fn eq(&self, other: &AnalyzeDocumentOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for AnalyzeDocumentOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for AnalyzeDocumentOutput