Amazon Comprehend · JSON Structure

Openapi.Yml Block Reference Structure

A reference to a block.

Type: object Properties: 4
Machine LearningNatural Language ProcessingNLPText Analysis

BlockReference is a JSON Structure definition published by Amazon Comprehend, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

BlockId BeginOffset EndOffset ChildBlocks

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/openapi.yml-block-reference-structure.json",
  "name": "BlockReference",
  "description": "A reference to a block. ",
  "type": "object",
  "properties": {
    "BlockId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "Unique identifier for the block."
        }
      ]
    },
    "BeginOffset": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "Offset of the start of the block within its parent block."
        }
      ]
    },
    "EndOffset": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "Offset of the end of the block within its parent block."
        }
      ]
    },
    "ChildBlocks": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfChildBlocks"
        },
        {
          "description": "List of child blocks within this block."
        }
      ]
    }
  }
}