reciTAL for Developers

Welcome to the reciTAL developer hub

You'll find comprehensive guides and documentation to help you start working with reciTAL for Developers as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Guides

Layout elements

Get started with the layout model

reciTAL's layout model is able to identify the types of the different elements of the document.

Detected types:

  • Titles
  • Paragraph
  • Header
  • Footer
  • Table
  • Element from TOC (Table of Contents)
  • Element from list (bullet points, numbered list, etc...)

To get started, just use the simple Get Layout recipe below:

Get the document layout

Elements representation

Each element has an attribute "type" that defines its type, from the previously detected types.
Here is an example of the attributes of a text: "Marché des Particuliers "

{
      "id": 0,
      "elastic_id": "1_0",
      "type": [
        "TITLE"
      ],
      "coordinates": {
        "1": [
          51.638898,
          70.713587,
          546.62732,
          352.301918
        ]
      },
      "page": [
        1
      ],
      "related": 0,
      "content": "Marché des Particuliers "
  }

The output of the layout model gives you different informations:

The unique "id" of the block
This allows to identify each block independently. It is also used with the "related" attribute, to know the hierarchy between two blocks.
A block with "Related:0" is at the top hierarchy level of the document.

"id": 0"
"related": 0

The layout model also provides you the unique id of its related chunk in elastic

"elastic_id": "1_0"

Positioning attributes

Coordinates: positioning of the block within the document
Page: page location of the block

"coordinates": {
        "1": [
          51.638898,
          70.713587,
          546.62732,
          352.301918
        ]
      },
      "page": [
        1]

Updated 20 days ago


Layout elements


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.