diff --git a/DocumentAi/metadata/V1/Document.php b/DocumentAi/metadata/V1/Document.php index a1af7ec3b387..152f7b5e639f 100644 Binary files a/DocumentAi/metadata/V1/Document.php and b/DocumentAi/metadata/V1/Document.php differ diff --git a/DocumentAi/metadata/V1/DocumentProcessorService.php b/DocumentAi/metadata/V1/DocumentProcessorService.php index 0471f41168e2..0a8e94e861ce 100644 Binary files a/DocumentAi/metadata/V1/DocumentProcessorService.php and b/DocumentAi/metadata/V1/DocumentProcessorService.php differ diff --git a/DocumentAi/metadata/V1/Processor.php b/DocumentAi/metadata/V1/Processor.php index a6db10d83a8e..f67f7c69f840 100644 Binary files a/DocumentAi/metadata/V1/Processor.php and b/DocumentAi/metadata/V1/Processor.php differ diff --git a/DocumentAi/src/V1/Document.php b/DocumentAi/src/V1/Document.php index 680a4cb3d531..928e7816039e 100644 --- a/DocumentAi/src/V1/Document.php +++ b/DocumentAi/src/V1/Document.php @@ -87,6 +87,18 @@ class Document extends \Google\Protobuf\Internal\Message * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Revision revisions = 13; */ private $revisions; + /** + * Parsed layout of the document. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17; + */ + private $document_layout = null; + /** + * Document chunked based on chunking config. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18; + */ + private $chunked_document = null; protected $source; /** @@ -132,6 +144,10 @@ class Document extends \Google\Protobuf\Internal\Message * Any error that occurred while processing this document. * @type array<\Google\Cloud\DocumentAI\V1\Document\Revision>|\Google\Protobuf\Internal\RepeatedField $revisions * Placeholder. Revision history of this document. + * @type \Google\Cloud\DocumentAI\V1\Document\DocumentLayout $document_layout + * Parsed layout of the document. + * @type \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument $chunked_document + * Document chunked based on chunking config. * } */ public function __construct($data = NULL) { @@ -511,6 +527,78 @@ public function setRevisions($var) return $this; } + /** + * Parsed layout of the document. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17; + * @return \Google\Cloud\DocumentAI\V1\Document\DocumentLayout|null + */ + public function getDocumentLayout() + { + return $this->document_layout; + } + + public function hasDocumentLayout() + { + return isset($this->document_layout); + } + + public function clearDocumentLayout() + { + unset($this->document_layout); + } + + /** + * Parsed layout of the document. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17; + * @param \Google\Cloud\DocumentAI\V1\Document\DocumentLayout $var + * @return $this + */ + public function setDocumentLayout($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\Document\DocumentLayout::class); + $this->document_layout = $var; + + return $this; + } + + /** + * Document chunked based on chunking config. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18; + * @return \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument|null + */ + public function getChunkedDocument() + { + return $this->chunked_document; + } + + public function hasChunkedDocument() + { + return isset($this->chunked_document); + } + + public function clearChunkedDocument() + { + unset($this->chunked_document); + } + + /** + * Document chunked based on chunking config. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18; + * @param \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument $var + * @return $this + */ + public function setChunkedDocument($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument::class); + $this->chunked_document = $var; + + return $this; + } + /** * @return string */ diff --git a/DocumentAi/src/V1/Document/ChunkedDocument.php b/DocumentAi/src/V1/Document/ChunkedDocument.php new file mode 100644 index 000000000000..93c66055751f --- /dev/null +++ b/DocumentAi/src/V1/Document/ChunkedDocument.php @@ -0,0 +1,68 @@ +google.cloud.documentai.v1.Document.ChunkedDocument + */ +class ChunkedDocument extends \Google\Protobuf\Internal\Message +{ + /** + * List of chunks. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk chunks = 1; + */ + private $chunks; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk>|\Google\Protobuf\Internal\RepeatedField $chunks + * List of chunks. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * List of chunks. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk chunks = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getChunks() + { + return $this->chunks; + } + + /** + * List of chunks. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk chunks = 1; + * @param array<\Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setChunks($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk::class); + $this->chunks = $arr; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/Document/ChunkedDocument/Chunk.php b/DocumentAi/src/V1/Document/ChunkedDocument/Chunk.php new file mode 100644 index 000000000000..afc1f2c765e6 --- /dev/null +++ b/DocumentAi/src/V1/Document/ChunkedDocument/Chunk.php @@ -0,0 +1,248 @@ +google.cloud.documentai.v1.Document.ChunkedDocument.Chunk + */ +class Chunk extends \Google\Protobuf\Internal\Message +{ + /** + * ID of the chunk. + * + * Generated from protobuf field string chunk_id = 1; + */ + private $chunk_id = ''; + /** + * Unused. + * + * Generated from protobuf field repeated string source_block_ids = 2; + */ + private $source_block_ids; + /** + * Text content of the chunk. + * + * Generated from protobuf field string content = 3; + */ + private $content = ''; + /** + * Page span of the chunk. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 4; + */ + private $page_span = null; + /** + * Page headers associated with the chunk. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageHeader page_headers = 5; + */ + private $page_headers; + /** + * Page footers associated with the chunk. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageFooter page_footers = 6; + */ + private $page_footers; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $chunk_id + * ID of the chunk. + * @type array|\Google\Protobuf\Internal\RepeatedField $source_block_ids + * Unused. + * @type string $content + * Text content of the chunk. + * @type \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan $page_span + * Page span of the chunk. + * @type array<\Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageHeader>|\Google\Protobuf\Internal\RepeatedField $page_headers + * Page headers associated with the chunk. + * @type array<\Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageFooter>|\Google\Protobuf\Internal\RepeatedField $page_footers + * Page footers associated with the chunk. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * ID of the chunk. + * + * Generated from protobuf field string chunk_id = 1; + * @return string + */ + public function getChunkId() + { + return $this->chunk_id; + } + + /** + * ID of the chunk. + * + * Generated from protobuf field string chunk_id = 1; + * @param string $var + * @return $this + */ + public function setChunkId($var) + { + GPBUtil::checkString($var, True); + $this->chunk_id = $var; + + return $this; + } + + /** + * Unused. + * + * Generated from protobuf field repeated string source_block_ids = 2; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSourceBlockIds() + { + return $this->source_block_ids; + } + + /** + * Unused. + * + * Generated from protobuf field repeated string source_block_ids = 2; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSourceBlockIds($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->source_block_ids = $arr; + + return $this; + } + + /** + * Text content of the chunk. + * + * Generated from protobuf field string content = 3; + * @return string + */ + public function getContent() + { + return $this->content; + } + + /** + * Text content of the chunk. + * + * Generated from protobuf field string content = 3; + * @param string $var + * @return $this + */ + public function setContent($var) + { + GPBUtil::checkString($var, True); + $this->content = $var; + + return $this; + } + + /** + * Page span of the chunk. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 4; + * @return \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan|null + */ + public function getPageSpan() + { + return $this->page_span; + } + + public function hasPageSpan() + { + return isset($this->page_span); + } + + public function clearPageSpan() + { + unset($this->page_span); + } + + /** + * Page span of the chunk. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 4; + * @param \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan $var + * @return $this + */ + public function setPageSpan($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan::class); + $this->page_span = $var; + + return $this; + } + + /** + * Page headers associated with the chunk. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageHeader page_headers = 5; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getPageHeaders() + { + return $this->page_headers; + } + + /** + * Page headers associated with the chunk. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageHeader page_headers = 5; + * @param array<\Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageHeader>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setPageHeaders($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageHeader::class); + $this->page_headers = $arr; + + return $this; + } + + /** + * Page footers associated with the chunk. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageFooter page_footers = 6; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getPageFooters() + { + return $this->page_footers; + } + + /** + * Page footers associated with the chunk. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageFooter page_footers = 6; + * @param array<\Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageFooter>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setPageFooters($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageFooter::class); + $this->page_footers = $arr; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/Document/ChunkedDocument/Chunk/ChunkPageFooter.php b/DocumentAi/src/V1/Document/ChunkedDocument/Chunk/ChunkPageFooter.php new file mode 100644 index 000000000000..13b0c3d1b1d2 --- /dev/null +++ b/DocumentAi/src/V1/Document/ChunkedDocument/Chunk/ChunkPageFooter.php @@ -0,0 +1,112 @@ +google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageFooter + */ +class ChunkPageFooter extends \Google\Protobuf\Internal\Message +{ + /** + * Footer in text format. + * + * Generated from protobuf field string text = 1; + */ + private $text = ''; + /** + * Page span of the footer. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 2; + */ + private $page_span = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $text + * Footer in text format. + * @type \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan $page_span + * Page span of the footer. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * Footer in text format. + * + * Generated from protobuf field string text = 1; + * @return string + */ + public function getText() + { + return $this->text; + } + + /** + * Footer in text format. + * + * Generated from protobuf field string text = 1; + * @param string $var + * @return $this + */ + public function setText($var) + { + GPBUtil::checkString($var, True); + $this->text = $var; + + return $this; + } + + /** + * Page span of the footer. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 2; + * @return \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan|null + */ + public function getPageSpan() + { + return $this->page_span; + } + + public function hasPageSpan() + { + return isset($this->page_span); + } + + public function clearPageSpan() + { + unset($this->page_span); + } + + /** + * Page span of the footer. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 2; + * @param \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan $var + * @return $this + */ + public function setPageSpan($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan::class); + $this->page_span = $var; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/Document/ChunkedDocument/Chunk/ChunkPageHeader.php b/DocumentAi/src/V1/Document/ChunkedDocument/Chunk/ChunkPageHeader.php new file mode 100644 index 000000000000..8637c32a5b2e --- /dev/null +++ b/DocumentAi/src/V1/Document/ChunkedDocument/Chunk/ChunkPageHeader.php @@ -0,0 +1,112 @@ +google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageHeader + */ +class ChunkPageHeader extends \Google\Protobuf\Internal\Message +{ + /** + * Header in text format. + * + * Generated from protobuf field string text = 1; + */ + private $text = ''; + /** + * Page span of the header. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 2; + */ + private $page_span = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $text + * Header in text format. + * @type \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan $page_span + * Page span of the header. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * Header in text format. + * + * Generated from protobuf field string text = 1; + * @return string + */ + public function getText() + { + return $this->text; + } + + /** + * Header in text format. + * + * Generated from protobuf field string text = 1; + * @param string $var + * @return $this + */ + public function setText($var) + { + GPBUtil::checkString($var, True); + $this->text = $var; + + return $this; + } + + /** + * Page span of the header. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 2; + * @return \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan|null + */ + public function getPageSpan() + { + return $this->page_span; + } + + public function hasPageSpan() + { + return isset($this->page_span); + } + + public function clearPageSpan() + { + unset($this->page_span); + } + + /** + * Page span of the header. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 2; + * @param \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan $var + * @return $this + */ + public function setPageSpan($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\Document\ChunkedDocument\Chunk\ChunkPageSpan::class); + $this->page_span = $var; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/Document/ChunkedDocument/Chunk/ChunkPageSpan.php b/DocumentAi/src/V1/Document/ChunkedDocument/Chunk/ChunkPageSpan.php new file mode 100644 index 000000000000..75a9e0af3172 --- /dev/null +++ b/DocumentAi/src/V1/Document/ChunkedDocument/Chunk/ChunkPageSpan.php @@ -0,0 +1,102 @@ +google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan + */ +class ChunkPageSpan extends \Google\Protobuf\Internal\Message +{ + /** + * Page where chunk starts in the document. + * + * Generated from protobuf field int32 page_start = 1; + */ + private $page_start = 0; + /** + * Page where chunk ends in the document. + * + * Generated from protobuf field int32 page_end = 2; + */ + private $page_end = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $page_start + * Page where chunk starts in the document. + * @type int $page_end + * Page where chunk ends in the document. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * Page where chunk starts in the document. + * + * Generated from protobuf field int32 page_start = 1; + * @return int + */ + public function getPageStart() + { + return $this->page_start; + } + + /** + * Page where chunk starts in the document. + * + * Generated from protobuf field int32 page_start = 1; + * @param int $var + * @return $this + */ + public function setPageStart($var) + { + GPBUtil::checkInt32($var); + $this->page_start = $var; + + return $this; + } + + /** + * Page where chunk ends in the document. + * + * Generated from protobuf field int32 page_end = 2; + * @return int + */ + public function getPageEnd() + { + return $this->page_end; + } + + /** + * Page where chunk ends in the document. + * + * Generated from protobuf field int32 page_end = 2; + * @param int $var + * @return $this + */ + public function setPageEnd($var) + { + GPBUtil::checkInt32($var); + $this->page_end = $var; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/Document/DocumentLayout.php b/DocumentAi/src/V1/Document/DocumentLayout.php new file mode 100644 index 000000000000..998131971580 --- /dev/null +++ b/DocumentAi/src/V1/Document/DocumentLayout.php @@ -0,0 +1,69 @@ +google.cloud.documentai.v1.Document.DocumentLayout + */ +class DocumentLayout extends \Google\Protobuf\Internal\Message +{ + /** + * List of blocks in the document. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1; + */ + private $blocks; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock>|\Google\Protobuf\Internal\RepeatedField $blocks + * List of blocks in the document. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * List of blocks in the document. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBlocks() + { + return $this->blocks; + } + + /** + * List of blocks in the document. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1; + * @param array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBlocks($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock::class); + $this->blocks = $arr; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock.php b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock.php new file mode 100644 index 000000000000..91311d4d073d --- /dev/null +++ b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock.php @@ -0,0 +1,221 @@ +google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock + */ +class DocumentLayoutBlock extends \Google\Protobuf\Internal\Message +{ + /** + * ID of the block. + * + * Generated from protobuf field string block_id = 1; + */ + private $block_id = ''; + /** + * Page span of the block. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan page_span = 5; + */ + private $page_span = null; + protected $block; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTextBlock $text_block + * Block consisting of text content. + * @type \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTableBlock $table_block + * Block consisting of table content/structure. + * @type \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutListBlock $list_block + * Block consisting of list content/structure. + * @type string $block_id + * ID of the block. + * @type \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutPageSpan $page_span + * Page span of the block. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * Block consisting of text content. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock text_block = 2; + * @return \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTextBlock|null + */ + public function getTextBlock() + { + return $this->readOneof(2); + } + + public function hasTextBlock() + { + return $this->hasOneof(2); + } + + /** + * Block consisting of text content. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock text_block = 2; + * @param \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTextBlock $var + * @return $this + */ + public function setTextBlock($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTextBlock::class); + $this->writeOneof(2, $var); + + return $this; + } + + /** + * Block consisting of table content/structure. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock table_block = 3; + * @return \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTableBlock|null + */ + public function getTableBlock() + { + return $this->readOneof(3); + } + + public function hasTableBlock() + { + return $this->hasOneof(3); + } + + /** + * Block consisting of table content/structure. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock table_block = 3; + * @param \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTableBlock $var + * @return $this + */ + public function setTableBlock($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTableBlock::class); + $this->writeOneof(3, $var); + + return $this; + } + + /** + * Block consisting of list content/structure. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock list_block = 4; + * @return \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutListBlock|null + */ + public function getListBlock() + { + return $this->readOneof(4); + } + + public function hasListBlock() + { + return $this->hasOneof(4); + } + + /** + * Block consisting of list content/structure. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock list_block = 4; + * @param \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutListBlock $var + * @return $this + */ + public function setListBlock($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutListBlock::class); + $this->writeOneof(4, $var); + + return $this; + } + + /** + * ID of the block. + * + * Generated from protobuf field string block_id = 1; + * @return string + */ + public function getBlockId() + { + return $this->block_id; + } + + /** + * ID of the block. + * + * Generated from protobuf field string block_id = 1; + * @param string $var + * @return $this + */ + public function setBlockId($var) + { + GPBUtil::checkString($var, True); + $this->block_id = $var; + + return $this; + } + + /** + * Page span of the block. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan page_span = 5; + * @return \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutPageSpan|null + */ + public function getPageSpan() + { + return $this->page_span; + } + + public function hasPageSpan() + { + return isset($this->page_span); + } + + public function clearPageSpan() + { + unset($this->page_span); + } + + /** + * Page span of the block. + * + * Generated from protobuf field .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan page_span = 5; + * @param \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutPageSpan $var + * @return $this + */ + public function setPageSpan($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutPageSpan::class); + $this->page_span = $var; + + return $this; + } + + /** + * @return string + */ + public function getBlock() + { + return $this->whichOneof("block"); + } + +} + + diff --git a/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutListBlock.php b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutListBlock.php new file mode 100644 index 000000000000..b6096592d4b3 --- /dev/null +++ b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutListBlock.php @@ -0,0 +1,106 @@ +google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock + */ +class LayoutListBlock extends \Google\Protobuf\Internal\Message +{ + /** + * List entries that constitute a list block. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListEntry list_entries = 1; + */ + private $list_entries; + /** + * Type of the list_entries (if exist). Available options are `ordered` + * and `unordered`. + * + * Generated from protobuf field string type = 2; + */ + private $type = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutListEntry>|\Google\Protobuf\Internal\RepeatedField $list_entries + * List entries that constitute a list block. + * @type string $type + * Type of the list_entries (if exist). Available options are `ordered` + * and `unordered`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * List entries that constitute a list block. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListEntry list_entries = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getListEntries() + { + return $this->list_entries; + } + + /** + * List entries that constitute a list block. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListEntry list_entries = 1; + * @param array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutListEntry>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setListEntries($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutListEntry::class); + $this->list_entries = $arr; + + return $this; + } + + /** + * Type of the list_entries (if exist). Available options are `ordered` + * and `unordered`. + * + * Generated from protobuf field string type = 2; + * @return string + */ + public function getType() + { + return $this->type; + } + + /** + * Type of the list_entries (if exist). Available options are `ordered` + * and `unordered`. + * + * Generated from protobuf field string type = 2; + * @param string $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkString($var, True); + $this->type = $var; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutListEntry.php b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutListEntry.php new file mode 100644 index 000000000000..d725f3d9c738 --- /dev/null +++ b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutListEntry.php @@ -0,0 +1,72 @@ +google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListEntry + */ +class LayoutListEntry extends \Google\Protobuf\Internal\Message +{ + /** + * A list entry is a list of blocks. + * Repeated blocks support further hierarchies and nested blocks. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1; + */ + private $blocks; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock>|\Google\Protobuf\Internal\RepeatedField $blocks + * A list entry is a list of blocks. + * Repeated blocks support further hierarchies and nested blocks. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * A list entry is a list of blocks. + * Repeated blocks support further hierarchies and nested blocks. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBlocks() + { + return $this->blocks; + } + + /** + * A list entry is a list of blocks. + * Repeated blocks support further hierarchies and nested blocks. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1; + * @param array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBlocks($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock::class); + $this->blocks = $arr; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutPageSpan.php b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutPageSpan.php new file mode 100644 index 000000000000..d4d2bd406272 --- /dev/null +++ b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutPageSpan.php @@ -0,0 +1,102 @@ +google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan + */ +class LayoutPageSpan extends \Google\Protobuf\Internal\Message +{ + /** + * Page where block starts in the document. + * + * Generated from protobuf field int32 page_start = 1; + */ + private $page_start = 0; + /** + * Page where block ends in the document. + * + * Generated from protobuf field int32 page_end = 2; + */ + private $page_end = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $page_start + * Page where block starts in the document. + * @type int $page_end + * Page where block ends in the document. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * Page where block starts in the document. + * + * Generated from protobuf field int32 page_start = 1; + * @return int + */ + public function getPageStart() + { + return $this->page_start; + } + + /** + * Page where block starts in the document. + * + * Generated from protobuf field int32 page_start = 1; + * @param int $var + * @return $this + */ + public function setPageStart($var) + { + GPBUtil::checkInt32($var); + $this->page_start = $var; + + return $this; + } + + /** + * Page where block ends in the document. + * + * Generated from protobuf field int32 page_end = 2; + * @return int + */ + public function getPageEnd() + { + return $this->page_end; + } + + /** + * Page where block ends in the document. + * + * Generated from protobuf field int32 page_end = 2; + * @param int $var + * @return $this + */ + public function setPageEnd($var) + { + GPBUtil::checkInt32($var); + $this->page_end = $var; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutTableBlock.php b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutTableBlock.php new file mode 100644 index 000000000000..0510351937cb --- /dev/null +++ b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutTableBlock.php @@ -0,0 +1,136 @@ +google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock + */ +class LayoutTableBlock extends \Google\Protobuf\Internal\Message +{ + /** + * Header rows at the top of the table. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableRow header_rows = 1; + */ + private $header_rows; + /** + * Body rows containing main table content. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableRow body_rows = 2; + */ + private $body_rows; + /** + * Table caption/title. + * + * Generated from protobuf field string caption = 3; + */ + private $caption = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTableRow>|\Google\Protobuf\Internal\RepeatedField $header_rows + * Header rows at the top of the table. + * @type array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTableRow>|\Google\Protobuf\Internal\RepeatedField $body_rows + * Body rows containing main table content. + * @type string $caption + * Table caption/title. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * Header rows at the top of the table. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableRow header_rows = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getHeaderRows() + { + return $this->header_rows; + } + + /** + * Header rows at the top of the table. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableRow header_rows = 1; + * @param array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTableRow>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setHeaderRows($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTableRow::class); + $this->header_rows = $arr; + + return $this; + } + + /** + * Body rows containing main table content. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableRow body_rows = 2; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBodyRows() + { + return $this->body_rows; + } + + /** + * Body rows containing main table content. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableRow body_rows = 2; + * @param array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTableRow>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBodyRows($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTableRow::class); + $this->body_rows = $arr; + + return $this; + } + + /** + * Table caption/title. + * + * Generated from protobuf field string caption = 3; + * @return string + */ + public function getCaption() + { + return $this->caption; + } + + /** + * Table caption/title. + * + * Generated from protobuf field string caption = 3; + * @param string $var + * @return $this + */ + public function setCaption($var) + { + GPBUtil::checkString($var, True); + $this->caption = $var; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutTableCell.php b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutTableCell.php new file mode 100644 index 000000000000..3deb5e30da5f --- /dev/null +++ b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutTableCell.php @@ -0,0 +1,140 @@ +google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableCell + */ +class LayoutTableCell extends \Google\Protobuf\Internal\Message +{ + /** + * A table cell is a list of blocks. + * Repeated blocks support further hierarchies and nested blocks. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1; + */ + private $blocks; + /** + * How many rows this cell spans. + * + * Generated from protobuf field int32 row_span = 2; + */ + private $row_span = 0; + /** + * How many columns this cell spans. + * + * Generated from protobuf field int32 col_span = 3; + */ + private $col_span = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock>|\Google\Protobuf\Internal\RepeatedField $blocks + * A table cell is a list of blocks. + * Repeated blocks support further hierarchies and nested blocks. + * @type int $row_span + * How many rows this cell spans. + * @type int $col_span + * How many columns this cell spans. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * A table cell is a list of blocks. + * Repeated blocks support further hierarchies and nested blocks. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBlocks() + { + return $this->blocks; + } + + /** + * A table cell is a list of blocks. + * Repeated blocks support further hierarchies and nested blocks. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1; + * @param array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBlocks($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock::class); + $this->blocks = $arr; + + return $this; + } + + /** + * How many rows this cell spans. + * + * Generated from protobuf field int32 row_span = 2; + * @return int + */ + public function getRowSpan() + { + return $this->row_span; + } + + /** + * How many rows this cell spans. + * + * Generated from protobuf field int32 row_span = 2; + * @param int $var + * @return $this + */ + public function setRowSpan($var) + { + GPBUtil::checkInt32($var); + $this->row_span = $var; + + return $this; + } + + /** + * How many columns this cell spans. + * + * Generated from protobuf field int32 col_span = 3; + * @return int + */ + public function getColSpan() + { + return $this->col_span; + } + + /** + * How many columns this cell spans. + * + * Generated from protobuf field int32 col_span = 3; + * @param int $var + * @return $this + */ + public function setColSpan($var) + { + GPBUtil::checkInt32($var); + $this->col_span = $var; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutTableRow.php b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutTableRow.php new file mode 100644 index 000000000000..253239c033bd --- /dev/null +++ b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutTableRow.php @@ -0,0 +1,68 @@ +google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableRow + */ +class LayoutTableRow extends \Google\Protobuf\Internal\Message +{ + /** + * A table row is a list of table cells. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableCell cells = 1; + */ + private $cells; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTableCell>|\Google\Protobuf\Internal\RepeatedField $cells + * A table row is a list of table cells. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * A table row is a list of table cells. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableCell cells = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCells() + { + return $this->cells; + } + + /** + * A table row is a list of table cells. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableCell cells = 1; + * @param array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTableCell>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCells($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock\LayoutTableCell::class); + $this->cells = $arr; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutTextBlock.php b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutTextBlock.php new file mode 100644 index 000000000000..66ef27c32403 --- /dev/null +++ b/DocumentAi/src/V1/Document/DocumentLayout/DocumentLayoutBlock/LayoutTextBlock.php @@ -0,0 +1,148 @@ +google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock + */ +class LayoutTextBlock extends \Google\Protobuf\Internal\Message +{ + /** + * Text content stored in the block. + * + * Generated from protobuf field string text = 1; + */ + private $text = ''; + /** + * Type of the text in the block. Available options are: `paragraph`, + * `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, + * `heading-5`, `header`, `footer`. + * + * Generated from protobuf field string type = 2; + */ + private $type = ''; + /** + * A text block could further have child blocks. + * Repeated blocks support further hierarchies and nested blocks. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 3; + */ + private $blocks; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $text + * Text content stored in the block. + * @type string $type + * Type of the text in the block. Available options are: `paragraph`, + * `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, + * `heading-5`, `header`, `footer`. + * @type array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock>|\Google\Protobuf\Internal\RepeatedField $blocks + * A text block could further have child blocks. + * Repeated blocks support further hierarchies and nested blocks. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\Document::initOnce(); + parent::__construct($data); + } + + /** + * Text content stored in the block. + * + * Generated from protobuf field string text = 1; + * @return string + */ + public function getText() + { + return $this->text; + } + + /** + * Text content stored in the block. + * + * Generated from protobuf field string text = 1; + * @param string $var + * @return $this + */ + public function setText($var) + { + GPBUtil::checkString($var, True); + $this->text = $var; + + return $this; + } + + /** + * Type of the text in the block. Available options are: `paragraph`, + * `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, + * `heading-5`, `header`, `footer`. + * + * Generated from protobuf field string type = 2; + * @return string + */ + public function getType() + { + return $this->type; + } + + /** + * Type of the text in the block. Available options are: `paragraph`, + * `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, + * `heading-5`, `header`, `footer`. + * + * Generated from protobuf field string type = 2; + * @param string $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkString($var, True); + $this->type = $var; + + return $this; + } + + /** + * A text block could further have child blocks. + * Repeated blocks support further hierarchies and nested blocks. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getBlocks() + { + return $this->blocks; + } + + /** + * A text block could further have child blocks. + * Repeated blocks support further hierarchies and nested blocks. + * + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 3; + * @param array<\Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setBlocks($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\DocumentLayout\DocumentLayoutBlock::class); + $this->blocks = $arr; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/ProcessOptions.php b/DocumentAi/src/V1/ProcessOptions.php index 04141b7386a6..8a043b1dcc4e 100644 --- a/DocumentAi/src/V1/ProcessOptions.php +++ b/DocumentAi/src/V1/ProcessOptions.php @@ -22,6 +22,13 @@ class ProcessOptions extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.documentai.v1.OcrConfig ocr_config = 1; */ private $ocr_config = null; + /** + * Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. + * Returns error if set on other processor types. + * + * Generated from protobuf field .google.cloud.documentai.v1.ProcessOptions.LayoutConfig layout_config = 9 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $layout_config = null; /** * Optional. Override the schema of the * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will @@ -50,6 +57,9 @@ class ProcessOptions extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\DocumentAI\V1\OcrConfig $ocr_config * Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. * Returns error if set on other processor types. + * @type \Google\Cloud\DocumentAI\V1\ProcessOptions\LayoutConfig $layout_config + * Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. + * Returns error if set on other processor types. * @type \Google\Cloud\DocumentAI\V1\DocumentSchema $schema_override * Optional. Override the schema of the * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will @@ -196,6 +206,44 @@ public function setOcrConfig($var) return $this; } + /** + * Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. + * Returns error if set on other processor types. + * + * Generated from protobuf field .google.cloud.documentai.v1.ProcessOptions.LayoutConfig layout_config = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\DocumentAI\V1\ProcessOptions\LayoutConfig|null + */ + public function getLayoutConfig() + { + return $this->layout_config; + } + + public function hasLayoutConfig() + { + return isset($this->layout_config); + } + + public function clearLayoutConfig() + { + unset($this->layout_config); + } + + /** + * Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. + * Returns error if set on other processor types. + * + * Generated from protobuf field .google.cloud.documentai.v1.ProcessOptions.LayoutConfig layout_config = 9 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\DocumentAI\V1\ProcessOptions\LayoutConfig $var + * @return $this + */ + public function setLayoutConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\ProcessOptions\LayoutConfig::class); + $this->layout_config = $var; + + return $this; + } + /** * Optional. Override the schema of the * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will diff --git a/DocumentAi/src/V1/ProcessOptions/LayoutConfig.php b/DocumentAi/src/V1/ProcessOptions/LayoutConfig.php new file mode 100644 index 000000000000..0a3dc30126c3 --- /dev/null +++ b/DocumentAi/src/V1/ProcessOptions/LayoutConfig.php @@ -0,0 +1,78 @@ +google.cloud.documentai.v1.ProcessOptions.LayoutConfig + */ +class LayoutConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Config for chunking in layout parser processor. + * + * Generated from protobuf field .google.cloud.documentai.v1.ProcessOptions.LayoutConfig.ChunkingConfig chunking_config = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $chunking_config = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\DocumentAI\V1\ProcessOptions\LayoutConfig\ChunkingConfig $chunking_config + * Optional. Config for chunking in layout parser processor. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\DocumentProcessorService::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Config for chunking in layout parser processor. + * + * Generated from protobuf field .google.cloud.documentai.v1.ProcessOptions.LayoutConfig.ChunkingConfig chunking_config = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\DocumentAI\V1\ProcessOptions\LayoutConfig\ChunkingConfig|null + */ + public function getChunkingConfig() + { + return $this->chunking_config; + } + + public function hasChunkingConfig() + { + return isset($this->chunking_config); + } + + public function clearChunkingConfig() + { + unset($this->chunking_config); + } + + /** + * Optional. Config for chunking in layout parser processor. + * + * Generated from protobuf field .google.cloud.documentai.v1.ProcessOptions.LayoutConfig.ChunkingConfig chunking_config = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\DocumentAI\V1\ProcessOptions\LayoutConfig\ChunkingConfig $var + * @return $this + */ + public function setChunkingConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\ProcessOptions\LayoutConfig\ChunkingConfig::class); + $this->chunking_config = $var; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/ProcessOptions/LayoutConfig/ChunkingConfig.php b/DocumentAi/src/V1/ProcessOptions/LayoutConfig/ChunkingConfig.php new file mode 100644 index 000000000000..d25d4d23d93b --- /dev/null +++ b/DocumentAi/src/V1/ProcessOptions/LayoutConfig/ChunkingConfig.php @@ -0,0 +1,106 @@ +google.cloud.documentai.v1.ProcessOptions.LayoutConfig.ChunkingConfig + */ +class ChunkingConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The chunk sizes to use when splitting documents, in order of + * level. + * + * Generated from protobuf field int32 chunk_size = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $chunk_size = 0; + /** + * Optional. Whether or not to include ancestor headings when splitting. + * + * Generated from protobuf field bool include_ancestor_headings = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $include_ancestor_headings = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $chunk_size + * Optional. The chunk sizes to use when splitting documents, in order of + * level. + * @type bool $include_ancestor_headings + * Optional. Whether or not to include ancestor headings when splitting. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\DocumentProcessorService::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The chunk sizes to use when splitting documents, in order of + * level. + * + * Generated from protobuf field int32 chunk_size = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getChunkSize() + { + return $this->chunk_size; + } + + /** + * Optional. The chunk sizes to use when splitting documents, in order of + * level. + * + * Generated from protobuf field int32 chunk_size = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setChunkSize($var) + { + GPBUtil::checkInt32($var); + $this->chunk_size = $var; + + return $this; + } + + /** + * Optional. Whether or not to include ancestor headings when splitting. + * + * Generated from protobuf field bool include_ancestor_headings = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getIncludeAncestorHeadings() + { + return $this->include_ancestor_headings; + } + + /** + * Optional. Whether or not to include ancestor headings when splitting. + * + * Generated from protobuf field bool include_ancestor_headings = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setIncludeAncestorHeadings($var) + { + GPBUtil::checkBool($var); + $this->include_ancestor_headings = $var; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/Processor.php b/DocumentAi/src/V1/Processor.php index 1c0793461805..63b353aa3bcc 100644 --- a/DocumentAi/src/V1/Processor.php +++ b/DocumentAi/src/V1/Processor.php @@ -75,6 +75,18 @@ class Processor extends \Google\Protobuf\Internal\Message * Generated from protobuf field string kms_key_name = 8; */ private $kms_key_name = ''; + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $satisfies_pzs = false; + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzi = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $satisfies_pzi = false; /** * Constructor. @@ -105,6 +117,10 @@ class Processor extends \Google\Protobuf\Internal\Message * @type string $kms_key_name * The [KMS key](https://cloud.google.com/security-key-management) used for * encryption and decryption in CMEK scenarios. + * @type bool $satisfies_pzs + * Output only. Reserved for future use. + * @type bool $satisfies_pzi + * Output only. Reserved for future use. * } */ public function __construct($data = NULL) { @@ -366,5 +382,57 @@ public function setKmsKeyName($var) return $this; } + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getSatisfiesPzs() + { + return $this->satisfies_pzs; + } + + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzs($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzs = $var; + + return $this; + } + + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzi = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getSatisfiesPzi() + { + return $this->satisfies_pzi; + } + + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzi = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzi($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzi = $var; + + return $this; + } + } diff --git a/DocumentAi/src/V1/ProcessorVersion.php b/DocumentAi/src/V1/ProcessorVersion.php index 224507b3f28f..c272716b922f 100644 --- a/DocumentAi/src/V1/ProcessorVersion.php +++ b/DocumentAi/src/V1/ProcessorVersion.php @@ -86,6 +86,18 @@ class ProcessorVersion extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.documentai.v1.ProcessorVersion.ModelType model_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $model_type = 0; + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $satisfies_pzs = false; + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzi = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $satisfies_pzi = false; /** * Constructor. @@ -117,6 +129,10 @@ class ProcessorVersion extends \Google\Protobuf\Internal\Message * If set, information about the eventual deprecation of this version. * @type int $model_type * Output only. The model type of this processor version. + * @type bool $satisfies_pzs + * Output only. Reserved for future use. + * @type bool $satisfies_pzi + * Output only. Reserved for future use. * } */ public function __construct($data = NULL) { @@ -454,5 +470,57 @@ public function setModelType($var) return $this; } + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getSatisfiesPzs() + { + return $this->satisfies_pzs; + } + + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzs = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzs($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzs = $var; + + return $this; + } + + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzi = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return bool + */ + public function getSatisfiesPzi() + { + return $this->satisfies_pzi; + } + + /** + * Output only. Reserved for future use. + * + * Generated from protobuf field bool satisfies_pzi = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param bool $var + * @return $this + */ + public function setSatisfiesPzi($var) + { + GPBUtil::checkBool($var); + $this->satisfies_pzi = $var; + + return $this; + } + } diff --git a/DocumentAi/tests/Unit/V1/Client/DocumentProcessorServiceClientTest.php b/DocumentAi/tests/Unit/V1/Client/DocumentProcessorServiceClientTest.php index dca152cb8451..5c883050f60a 100644 --- a/DocumentAi/tests/Unit/V1/Client/DocumentProcessorServiceClientTest.php +++ b/DocumentAi/tests/Unit/V1/Client/DocumentProcessorServiceClientTest.php @@ -244,6 +244,8 @@ public function createProcessorTest() $defaultProcessorVersion = 'defaultProcessorVersion1185902509'; $processEndpoint = 'processEndpoint-178717339'; $kmsKeyName = 'kmsKeyName2094986649'; + $satisfiesPzs = false; + $satisfiesPzi = false; $expectedResponse = new Processor(); $expectedResponse->setName($name); $expectedResponse->setType($type); @@ -251,6 +253,8 @@ public function createProcessorTest() $expectedResponse->setDefaultProcessorVersion($defaultProcessorVersion); $expectedResponse->setProcessEndpoint($processEndpoint); $expectedResponse->setKmsKeyName($kmsKeyName); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); $transport->addResponse($expectedResponse); // Mock request $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); @@ -1182,6 +1186,8 @@ public function getProcessorTest() $defaultProcessorVersion = 'defaultProcessorVersion1185902509'; $processEndpoint = 'processEndpoint-178717339'; $kmsKeyName = 'kmsKeyName2094986649'; + $satisfiesPzs = false; + $satisfiesPzi = false; $expectedResponse = new Processor(); $expectedResponse->setName($name2); $expectedResponse->setType($type); @@ -1189,6 +1195,8 @@ public function getProcessorTest() $expectedResponse->setDefaultProcessorVersion($defaultProcessorVersion); $expectedResponse->setProcessEndpoint($processEndpoint); $expectedResponse->setKmsKeyName($kmsKeyName); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->processorName('[PROJECT]', '[LOCATION]', '[PROCESSOR]'); @@ -1325,12 +1333,16 @@ public function getProcessorVersionTest() $kmsKeyName = 'kmsKeyName2094986649'; $kmsKeyVersionName = 'kmsKeyVersionName-1734350176'; $googleManaged = false; + $satisfiesPzs = false; + $satisfiesPzi = false; $expectedResponse = new ProcessorVersion(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); $expectedResponse->setKmsKeyName($kmsKeyName); $expectedResponse->setKmsKeyVersionName($kmsKeyVersionName); $expectedResponse->setGoogleManaged($googleManaged); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->processorVersionName('[PROJECT]', '[LOCATION]', '[PROCESSOR]', '[PROCESSOR_VERSION]'); diff --git a/DocumentAi/tests/Unit/V1/DocumentProcessorServiceClientTest.php b/DocumentAi/tests/Unit/V1/DocumentProcessorServiceClientTest.php index 5468691c2f78..b941841b6838 100644 --- a/DocumentAi/tests/Unit/V1/DocumentProcessorServiceClientTest.php +++ b/DocumentAi/tests/Unit/V1/DocumentProcessorServiceClientTest.php @@ -216,6 +216,8 @@ public function createProcessorTest() $defaultProcessorVersion = 'defaultProcessorVersion1185902509'; $processEndpoint = 'processEndpoint-178717339'; $kmsKeyName = 'kmsKeyName2094986649'; + $satisfiesPzs = false; + $satisfiesPzi = false; $expectedResponse = new Processor(); $expectedResponse->setName($name); $expectedResponse->setType($type); @@ -223,6 +225,8 @@ public function createProcessorTest() $expectedResponse->setDefaultProcessorVersion($defaultProcessorVersion); $expectedResponse->setProcessEndpoint($processEndpoint); $expectedResponse->setKmsKeyName($kmsKeyName); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); $transport->addResponse($expectedResponse); // Mock request $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); @@ -1116,6 +1120,8 @@ public function getProcessorTest() $defaultProcessorVersion = 'defaultProcessorVersion1185902509'; $processEndpoint = 'processEndpoint-178717339'; $kmsKeyName = 'kmsKeyName2094986649'; + $satisfiesPzs = false; + $satisfiesPzi = false; $expectedResponse = new Processor(); $expectedResponse->setName($name2); $expectedResponse->setType($type); @@ -1123,6 +1129,8 @@ public function getProcessorTest() $expectedResponse->setDefaultProcessorVersion($defaultProcessorVersion); $expectedResponse->setProcessEndpoint($processEndpoint); $expectedResponse->setKmsKeyName($kmsKeyName); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->processorName('[PROJECT]', '[LOCATION]', '[PROCESSOR]'); @@ -1251,12 +1259,16 @@ public function getProcessorVersionTest() $kmsKeyName = 'kmsKeyName2094986649'; $kmsKeyVersionName = 'kmsKeyVersionName-1734350176'; $googleManaged = false; + $satisfiesPzs = false; + $satisfiesPzi = false; $expectedResponse = new ProcessorVersion(); $expectedResponse->setName($name2); $expectedResponse->setDisplayName($displayName); $expectedResponse->setKmsKeyName($kmsKeyName); $expectedResponse->setKmsKeyVersionName($kmsKeyVersionName); $expectedResponse->setGoogleManaged($googleManaged); + $expectedResponse->setSatisfiesPzs($satisfiesPzs); + $expectedResponse->setSatisfiesPzi($satisfiesPzi); $transport->addResponse($expectedResponse); // Mock request $formattedName = $gapicClient->processorVersionName('[PROJECT]', '[LOCATION]', '[PROCESSOR]', '[PROCESSOR_VERSION]');