Amazonka.Textract.AnalyzeExpense

AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.

Information is returned as ExpenseDocuments and seperated as follows:

• LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt.
• SummaryFields- Contains all other information a receipt, such as header information or the vendors name.

Creating a Request

data AnalyzeExpense

See: newAnalyzeExpense smart constructor.

Constructors

AnalyzeExpense'

Fields

• document :: Document

Instances

ToJSON AnalyzeExpense

Defined in Amazonka.Textract.AnalyzeExpense

Methods

toJSON :: AnalyzeExpense -> Value

toEncoding :: AnalyzeExpense -> Encoding

toJSONList :: [AnalyzeExpense] -> Value

toEncodingList :: [AnalyzeExpense] -> Encoding

ToHeaders AnalyzeExpense

Defined in Amazonka.Textract.AnalyzeExpense

Methods

toHeaders :: AnalyzeExpense -> [Header]

ToPath AnalyzeExpense

Defined in Amazonka.Textract.AnalyzeExpense

Methods

toPath :: AnalyzeExpense -> ByteString

ToQuery AnalyzeExpense

Defined in Amazonka.Textract.AnalyzeExpense

Methods

toQuery :: AnalyzeExpense -> QueryString

AWSRequest AnalyzeExpense

Defined in Amazonka.Textract.AnalyzeExpense

Associated Types

type AWSResponse AnalyzeExpense

Methods

request :: (Service -> Service) -> AnalyzeExpense -> Request AnalyzeExpense

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AnalyzeExpense -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AnalyzeExpense)))

Generic AnalyzeExpense

Defined in Amazonka.Textract.AnalyzeExpense

Associated Types

type Rep AnalyzeExpense :: Type -> Type

Methods

from :: AnalyzeExpense -> Rep AnalyzeExpense x

to :: Rep AnalyzeExpense x -> AnalyzeExpense

Read AnalyzeExpense

Defined in Amazonka.Textract.AnalyzeExpense

Methods

readsPrec :: Int -> ReadS AnalyzeExpense

readList :: ReadS [AnalyzeExpense]

readPrec :: ReadPrec AnalyzeExpense

readListPrec :: ReadPrec [AnalyzeExpense]

Show AnalyzeExpense

Defined in Amazonka.Textract.AnalyzeExpense

Methods

showsPrec :: Int -> AnalyzeExpense -> ShowS

show :: AnalyzeExpense -> String

showList :: [AnalyzeExpense] -> ShowS

NFData AnalyzeExpense

Defined in Amazonka.Textract.AnalyzeExpense

Methods

rnf :: AnalyzeExpense -> ()

Eq AnalyzeExpense

Defined in Amazonka.Textract.AnalyzeExpense

Methods

(==) :: AnalyzeExpense -> AnalyzeExpense -> Bool

(/=) :: AnalyzeExpense -> AnalyzeExpense -> Bool

Hashable AnalyzeExpense

Defined in Amazonka.Textract.AnalyzeExpense

Methods

hashWithSalt :: Int -> AnalyzeExpense -> Int

hash :: AnalyzeExpense -> Int

type AWSResponse AnalyzeExpense

Defined in Amazonka.Textract.AnalyzeExpense

type AWSResponse AnalyzeExpense = AnalyzeExpenseResponse

type Rep AnalyzeExpense

Defined in Amazonka.Textract.AnalyzeExpense

type Rep AnalyzeExpense = D1 ('MetaData "AnalyzeExpense" "Amazonka.Textract.AnalyzeExpense" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "AnalyzeExpense'" 'PrefixI 'True) (S1 ('MetaSel ('Just "document") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Document)))

newAnalyzeExpense

Arguments

:: Document

$sel:document:AnalyzeExpense'

-> AnalyzeExpense

Create a value of AnalyzeExpense with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:document:AnalyzeExpense', analyzeExpense_document - Undocumented member.

Request Lenses

analyzeExpense_document :: Lens' AnalyzeExpense Document

Undocumented member.

Destructuring the Response

data AnalyzeExpenseResponse

See: newAnalyzeExpenseResponse smart constructor.

Constructors

AnalyzeExpenseResponse'

Fields

• documentMetadata :: Maybe DocumentMetadata
• expenseDocuments :: Maybe [ExpenseDocument]

  The expenses detected by Amazon Textract.

• httpStatus :: Int

  The response's http status code.

Instances

Generic AnalyzeExpenseResponse

Defined in Amazonka.Textract.AnalyzeExpense

Associated Types

type Rep AnalyzeExpenseResponse :: Type -> Type

Methods

from :: AnalyzeExpenseResponse -> Rep AnalyzeExpenseResponse x

to :: Rep AnalyzeExpenseResponse x -> AnalyzeExpenseResponse

Read AnalyzeExpenseResponse

Defined in Amazonka.Textract.AnalyzeExpense

Methods

readsPrec :: Int -> ReadS AnalyzeExpenseResponse

readList :: ReadS [AnalyzeExpenseResponse]

readPrec :: ReadPrec AnalyzeExpenseResponse

readListPrec :: ReadPrec [AnalyzeExpenseResponse]

Show AnalyzeExpenseResponse

Defined in Amazonka.Textract.AnalyzeExpense

Methods

showsPrec :: Int -> AnalyzeExpenseResponse -> ShowS

show :: AnalyzeExpenseResponse -> String

showList :: [AnalyzeExpenseResponse] -> ShowS

NFData AnalyzeExpenseResponse

Defined in Amazonka.Textract.AnalyzeExpense

Methods

rnf :: AnalyzeExpenseResponse -> ()

Eq AnalyzeExpenseResponse

Defined in Amazonka.Textract.AnalyzeExpense

Methods

(==) :: AnalyzeExpenseResponse -> AnalyzeExpenseResponse -> Bool

(/=) :: AnalyzeExpenseResponse -> AnalyzeExpenseResponse -> Bool

type Rep AnalyzeExpenseResponse

Defined in Amazonka.Textract.AnalyzeExpense

type Rep AnalyzeExpenseResponse = D1 ('MetaData "AnalyzeExpenseResponse" "Amazonka.Textract.AnalyzeExpense" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "AnalyzeExpenseResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentMetadata)) :*: (S1 ('MetaSel ('Just "expenseDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExpenseDocument])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAnalyzeExpenseResponse

Arguments

:: Int

$sel:httpStatus:AnalyzeExpenseResponse'

-> AnalyzeExpenseResponse

Create a value of AnalyzeExpenseResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentMetadata:AnalyzeExpenseResponse', analyzeExpenseResponse_documentMetadata - Undocumented member.

$sel:expenseDocuments:AnalyzeExpenseResponse', analyzeExpenseResponse_expenseDocuments - The expenses detected by Amazon Textract.

$sel:httpStatus:AnalyzeExpenseResponse', analyzeExpenseResponse_httpStatus - The response's http status code.

Response Lenses

analyzeExpenseResponse_documentMetadata :: Lens' AnalyzeExpenseResponse (Maybe DocumentMetadata)

Undocumented member.

analyzeExpenseResponse_expenseDocuments :: Lens' AnalyzeExpenseResponse (Maybe [ExpenseDocument])

The expenses detected by Amazon Textract.

analyzeExpenseResponse_httpStatus :: Lens' AnalyzeExpenseResponse Int

The response's http status code.