AI_PARSE_DOCUMENT¶

Syntax¶

AI_PARSE_DOCUMENT( '@<stage>', '<path>', [ <options> ] )

Arguments¶

Required:

stage

Name of the Snowflake stage that contains the document to parse. This must be an internal or external stage that uses server-side encryption and is accessible to the user executing the function.

path

Relative path to the document on the Snowflake stage.

Optional:

options

An OBJECT value that contains options for parsing documents. The supported keys are shown below. All are optional.

• 'mode': Specifies the parsing mode. The supported modes are:

  • 'OCR': The function extracts text only. This is the default mode.

  • 'LAYOUT': The function extracts layout as well as text, including structural content such as tables.

• 'page_split': If set to TRUE, the function splits the document into pages and processes each page separately. This feature supports only PDF, PowerPoint (.pptx), and Word (.docx) documents. Documents in other formats return an error. The default is FALSE.

  Tip

  To process long documents that exceed the token limit of AI_PARSE_DOCUMENT, set this option to TRUE.

Returns¶

A JSON object (as a string) that contains the extracted data and associated metadata. The options argument determines the structure of the returned object.

If the 'page_split' option is set, the output has the following structure:

• "pages": An array of JSON objects, each containing text extracted from the document. If the document has only one page, the output still contains a "pages" array (which contains a single object). Each page has the following fields:

  • "content": Plain text (in OCR mode) or Markdown-formatted text (in LAYOUT mode).

  • "index": The page index in the file, starting at 0. Page numbers and formats specified in the document are ignored.

• "errorInformation": Contains error information if document can’t be parsed.

• "metadata": Contains metadata about the document, such as page count.

Note

The "pages" and "metadata" fields are present in the output when parsing succeeds. "errorInformation" is present only if parsing fails.

If 'page_split' is FALSE or is not present, the output has the following structure:

• "content": Plain text (in OCR mode) or Markdown-formatted text (in LAYOUT mode).

• "errorInformation": Contains error information if the document can’t be parsed.

• "metadata": Contains metadata about the document, such as page count.

Note

The "content" and "metadata" fields are present in the output when parsing succeeds. "errorInformation" is present only if parsing fails.

Examples¶

For examples, see AI_PARSE_DOCUMENT examples.