dp_results: Retrieve results from parsed documents

Description Usage Arguments Value Examples

Description

Retrieve results from parsed documents

Usage

1
2
3
dp_results(doc_id, parser, format = c("object", "flat"),
  include_children = TRUE,
  docparser_api_key = Sys.getenv("DOCPARSER_API_KEY"))

Arguments

doc_id

a document ID from the web interface or as returned by dp_parse_doc()

parser

a parser id (which can be found via dp_parsers())

format

one of "object" or "flat". By default, parsed document data is returned as nested JSON objects. Setting this parameter to "flat" will return a simplified version of the parsed data which does not contain flat key/value pairs instead of nested objects. Default is "object".

include_children

If child documents were created during preprocessing (e.g. when splitting documents), setting this parameter to TRUE (the default) ensures that the parsed data of all child documents is returned.

docparser_api_key

if not placed in the DOCPARSER_API_KEY environment variable, place it here. Otherwise, API requests fail.

Value

list

Examples

1
2
3
4
## Not run: 
dp_results("484c4292ab3b324b7f2b60f3f2d3149f", "jcpfgqiexwky")

## End(Not run)

hrbrmstr/docparser documentation built on May 18, 2019, 2:34 a.m.