diff --git a/DocumentAi/metadata/V1/Document.php b/DocumentAi/metadata/V1/Document.php index 12aa4acbdba7..35905c88a379 100644 Binary files a/DocumentAi/metadata/V1/Document.php and b/DocumentAi/metadata/V1/Document.php differ diff --git a/DocumentAi/metadata/V1/DocumentIo.php b/DocumentAi/metadata/V1/DocumentIo.php index a6702efe61cc..53ccce6f992a 100644 Binary files a/DocumentAi/metadata/V1/DocumentIo.php and b/DocumentAi/metadata/V1/DocumentIo.php differ diff --git a/DocumentAi/metadata/V1/ProcessorType.php b/DocumentAi/metadata/V1/ProcessorType.php index 4f8a542b777f..6c30d3753734 100644 --- a/DocumentAi/metadata/V1/ProcessorType.php +++ b/DocumentAi/metadata/V1/ProcessorType.php @@ -18,15 +18,16 @@ public static function initOnce() { \GPBMetadata\Google\Api\Resource::initOnce(); $pool->internalAddGeneratedFile( ' -Æ -/google/cloud/documentai/v1/processor_type.protogoogle.cloud.documentai.v1google/api/resource.proto"õ +ä +/google/cloud/documentai/v1/processor_type.protogoogle.cloud.documentai.v1google/api/resource.proto"“ ProcessorType name (  type (  category ( S available_locations ( 26.google.cloud.documentai.v1.ProcessorType.LocationInfo allow_creation (- - launch_stage (2.google.api.LaunchStage# + launch_stage (2.google.api.LaunchStage +sample_document_uris ( # LocationInfo location_id ( :uêAr \'documentai.googleapis.com/ProcessorTypeGprojects/{project}/locations/{location}/processorTypes/{processor_type}BÛ diff --git a/DocumentAi/samples/V1/DocumentProcessorServiceClient/batch_process_documents.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/batch_process_documents.php index 839613a6828d..df4444c58801 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/batch_process_documents.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/batch_process_documents.php @@ -33,7 +33,8 @@ * LRO endpoint to batch process many documents. The output is written * to Cloud Storage as JSON in the [Document] format. * - * @param string $name The resource name of [Processor][google.cloud.documentai.v1.Processor] or + * @param string $name The resource name of + * [Processor][google.cloud.documentai.v1.Processor] or * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. * Format: `projects/{project}/locations/{location}/processors/{processor}`, * or diff --git a/DocumentAi/samples/V1/DocumentProcessorServiceClient/create_processor.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/create_processor.php index f013f90c2f89..61e87f4bf90a 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/create_processor.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/create_processor.php @@ -31,8 +31,8 @@ * Creates a processor from the type processor that the user chose. * The processor will be at "ENABLED" state by default after its creation. * - * @param string $formattedParent The parent (project and location) under which to create the processor. - * Format: `projects/{project}/locations/{location}` + * @param string $formattedParent The parent (project and location) under which to create the + * processor. Format: `projects/{project}/locations/{location}` * Please see {@see DocumentProcessorServiceClient::locationName()} for help formatting this field. */ function create_processor_sample(string $formattedParent): void diff --git a/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processor_versions.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processor_versions.php index 184df196292b..75fcae29770a 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processor_versions.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processor_versions.php @@ -31,8 +31,9 @@ /** * Lists all versions of a processor. * - * @param string $formattedParent The parent (project, location and processor) to list all versions. - * Format: `projects/{project}/locations/{location}/processors/{processor}` + * @param string $formattedParent The parent (project, location and processor) to list all + * versions. Format: + * `projects/{project}/locations/{location}/processors/{processor}` * Please see {@see DocumentProcessorServiceClient::processorName()} for help formatting this field. */ function list_processor_versions_sample(string $formattedParent): void diff --git a/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processors.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processors.php index d66f7b8f2b99..1eafdfcab5de 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processors.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processors.php @@ -31,8 +31,8 @@ /** * Lists all processors which belong to this project. * - * @param string $formattedParent The parent (project and location) which owns this collection of Processors. - * Format: `projects/{project}/locations/{location}` + * @param string $formattedParent The parent (project and location) which owns this collection of + * Processors. Format: `projects/{project}/locations/{location}` * Please see {@see DocumentProcessorServiceClient::locationName()} for help formatting this field. */ function list_processors_sample(string $formattedParent): void diff --git a/DocumentAi/samples/V1/DocumentProcessorServiceClient/process_document.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/process_document.php index f4f67f264ac9..7d552f7a9260 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/process_document.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/process_document.php @@ -30,11 +30,15 @@ /** * Processes a single document. * - * @param string $name The resource name of the [Processor][google.cloud.documentai.v1.Processor] or + * @param string $name The resource name of the + * [Processor][google.cloud.documentai.v1.Processor] or * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] - * to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use - * its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: - * `projects/{project}/locations/{location}/processors/{processor}`, or + * to use for processing. If a + * [Processor][google.cloud.documentai.v1.Processor] is specified, the server + * will use its [default + * version][google.cloud.documentai.v1.Processor.default_processor_version]. + * Format: `projects/{project}/locations/{location}/processors/{processor}`, + * or * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */ function process_document_sample(string $name): void diff --git a/DocumentAi/samples/V1/DocumentProcessorServiceClient/review_document.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/review_document.php index a0aff634f4d9..0e88edab087f 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/review_document.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/review_document.php @@ -33,8 +33,8 @@ * Send a document for Human Review. The input document should be processed by * the specified processor. * - * @param string $formattedHumanReviewConfig The resource name of the HumanReviewConfig that the document will be - * reviewed with. Please see + * @param string $formattedHumanReviewConfig The resource name of the HumanReviewConfig that the document will + * be reviewed with. Please see * {@see DocumentProcessorServiceClient::humanReviewConfigName()} for help formatting this field. */ function review_document_sample(string $formattedHumanReviewConfig): void diff --git a/DocumentAi/samples/V1/DocumentProcessorServiceClient/set_default_processor_version.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/set_default_processor_version.php index 03be406ccbef..ff60a0e00492 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/set_default_processor_version.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/set_default_processor_version.php @@ -30,14 +30,19 @@ use Google\Rpc\Status; /** - * Set the default (active) version of a [Processor][google.cloud.documentai.v1.Processor] that will be used in - * [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] and + * Set the default (active) version of a + * [Processor][google.cloud.documentai.v1.Processor] that will be used in + * [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] + * and * [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments]. * - * @param string $formattedProcessor The resource name of the [Processor][google.cloud.documentai.v1.Processor] to change default version. Please see + * @param string $formattedProcessor The resource name of the + * [Processor][google.cloud.documentai.v1.Processor] to change default + * version. Please see * {@see DocumentProcessorServiceClient::processorName()} for help formatting this field. - * @param string $formattedDefaultProcessorVersion The resource name of child [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as default. - * Format: + * @param string $formattedDefaultProcessorVersion The resource name of child + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as + * default. Format: * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` * Please see {@see DocumentProcessorServiceClient::processorVersionName()} for help formatting this field. */ diff --git a/DocumentAi/src/V1/BatchProcessRequest.php b/DocumentAi/src/V1/BatchProcessRequest.php index 990fab2c1f53..037c148491a7 100644 --- a/DocumentAi/src/V1/BatchProcessRequest.php +++ b/DocumentAi/src/V1/BatchProcessRequest.php @@ -16,7 +16,8 @@ class BatchProcessRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or + * Required. The resource name of + * [Processor][google.cloud.documentai.v1.Processor] or * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. * Format: `projects/{project}/locations/{location}/processors/{processor}`, * or @@ -52,7 +53,8 @@ class BatchProcessRequest extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or + * Required. The resource name of + * [Processor][google.cloud.documentai.v1.Processor] or * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. * Format: `projects/{project}/locations/{location}/processors/{processor}`, * or @@ -72,7 +74,8 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or + * Required. The resource name of + * [Processor][google.cloud.documentai.v1.Processor] or * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. * Format: `projects/{project}/locations/{location}/processors/{processor}`, * or @@ -87,7 +90,8 @@ public function getName() } /** - * Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or + * Required. The resource name of + * [Processor][google.cloud.documentai.v1.Processor] or * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. * Format: `projects/{project}/locations/{location}/processors/{processor}`, * or diff --git a/DocumentAi/src/V1/CreateProcessorRequest.php b/DocumentAi/src/V1/CreateProcessorRequest.php index 16e6fb488415..ced63edf415d 100644 --- a/DocumentAi/src/V1/CreateProcessorRequest.php +++ b/DocumentAi/src/V1/CreateProcessorRequest.php @@ -18,15 +18,16 @@ class CreateProcessorRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The parent (project and location) under which to create the processor. - * Format: `projects/{project}/locations/{location}` + * Required. The parent (project and location) under which to create the + * processor. Format: `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ private $parent = ''; /** - * Required. The processor to be created, requires [processor_type] and [display_name] - * to be set. Also, the processor is under CMEK if CMEK fields are set. + * Required. The processor to be created, requires [processor_type] and + * [display_name] to be set. Also, the processor is under CMEK if CMEK fields + * are set. * * Generated from protobuf field .google.cloud.documentai.v1.Processor processor = 2 [(.google.api.field_behavior) = REQUIRED]; */ @@ -39,11 +40,12 @@ class CreateProcessorRequest extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $parent - * Required. The parent (project and location) under which to create the processor. - * Format: `projects/{project}/locations/{location}` + * Required. The parent (project and location) under which to create the + * processor. Format: `projects/{project}/locations/{location}` * @type \Google\Cloud\DocumentAI\V1\Processor $processor - * Required. The processor to be created, requires [processor_type] and [display_name] - * to be set. Also, the processor is under CMEK if CMEK fields are set. + * Required. The processor to be created, requires [processor_type] and + * [display_name] to be set. Also, the processor is under CMEK if CMEK fields + * are set. * } */ public function __construct($data = NULL) { @@ -52,8 +54,8 @@ public function __construct($data = NULL) { } /** - * Required. The parent (project and location) under which to create the processor. - * Format: `projects/{project}/locations/{location}` + * Required. The parent (project and location) under which to create the + * processor. Format: `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -64,8 +66,8 @@ public function getParent() } /** - * Required. The parent (project and location) under which to create the processor. - * Format: `projects/{project}/locations/{location}` + * Required. The parent (project and location) under which to create the + * processor. Format: `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -80,8 +82,9 @@ public function setParent($var) } /** - * Required. The processor to be created, requires [processor_type] and [display_name] - * to be set. Also, the processor is under CMEK if CMEK fields are set. + * Required. The processor to be created, requires [processor_type] and + * [display_name] to be set. Also, the processor is under CMEK if CMEK fields + * are set. * * Generated from protobuf field .google.cloud.documentai.v1.Processor processor = 2 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\DocumentAI\V1\Processor|null @@ -102,8 +105,9 @@ public function clearProcessor() } /** - * Required. The processor to be created, requires [processor_type] and [display_name] - * to be set. Also, the processor is under CMEK if CMEK fields are set. + * Required. The processor to be created, requires [processor_type] and + * [display_name] to be set. Also, the processor is under CMEK if CMEK fields + * are set. * * Generated from protobuf field .google.cloud.documentai.v1.Processor processor = 2 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\DocumentAI\V1\Processor $var diff --git a/DocumentAi/src/V1/Document.php b/DocumentAi/src/V1/Document.php index b45b9dcf733e..9c2d3c6caa35 100644 --- a/DocumentAi/src/V1/Document.php +++ b/DocumentAi/src/V1/Document.php @@ -33,9 +33,10 @@ class Document extends \Google\Protobuf\Internal\Message */ private $text = ''; /** - * Placeholder. Styles for the [Document.text][google.cloud.documentai.v1.Document.text]. + * Styles for the [Document.text][google.cloud.documentai.v1.Document.text]. * - * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Style text_styles = 5; + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; + * @deprecated */ private $text_styles; /** @@ -45,22 +46,25 @@ class Document extends \Google\Protobuf\Internal\Message */ private $pages; /** - * A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, - * entities in this list may cross shard boundaries. + * A list of entities detected on + * [Document.text][google.cloud.documentai.v1.Document.text]. For document + * shards, entities in this list may cross shard boundaries. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Entity entities = 7; */ private $entities; /** - * Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities]. + * Placeholder. Relationship among + * [Document.entities][google.cloud.documentai.v1.Document.entities]. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; */ private $entity_relations; /** - * Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.Document.text]. This - * is usually used for annotating corrections to OCR mistakes. Text changes - * for a given revision may not overlap with each other. + * Placeholder. A list of text corrections made to + * [Document.text][google.cloud.documentai.v1.Document.text]. This is usually + * used for annotating corrections to OCR mistakes. Text changes for a given + * revision may not overlap with each other. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14; */ @@ -109,18 +113,21 @@ class Document extends \Google\Protobuf\Internal\Message * @type string $text * Optional. UTF-8 encoded text in reading order from the document. * @type array<\Google\Cloud\DocumentAI\V1\Document\Style>|\Google\Protobuf\Internal\RepeatedField $text_styles - * Placeholder. Styles for the [Document.text][google.cloud.documentai.v1.Document.text]. + * Styles for the [Document.text][google.cloud.documentai.v1.Document.text]. * @type array<\Google\Cloud\DocumentAI\V1\Document\Page>|\Google\Protobuf\Internal\RepeatedField $pages * Visual page layout for the [Document][google.cloud.documentai.v1.Document]. * @type array<\Google\Cloud\DocumentAI\V1\Document\Entity>|\Google\Protobuf\Internal\RepeatedField $entities - * A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, - * entities in this list may cross shard boundaries. + * A list of entities detected on + * [Document.text][google.cloud.documentai.v1.Document.text]. For document + * shards, entities in this list may cross shard boundaries. * @type array<\Google\Cloud\DocumentAI\V1\Document\EntityRelation>|\Google\Protobuf\Internal\RepeatedField $entity_relations - * Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities]. + * Placeholder. Relationship among + * [Document.entities][google.cloud.documentai.v1.Document.entities]. * @type array<\Google\Cloud\DocumentAI\V1\Document\TextChange>|\Google\Protobuf\Internal\RepeatedField $text_changes - * Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.Document.text]. This - * is usually used for annotating corrections to OCR mistakes. Text changes - * for a given revision may not overlap with each other. + * Placeholder. A list of text corrections made to + * [Document.text][google.cloud.documentai.v1.Document.text]. This is usually + * used for annotating corrections to OCR mistakes. Text changes for a given + * revision may not overlap with each other. * @type \Google\Cloud\DocumentAI\V1\Document\ShardInfo $shard_info * Information about the sharding if this document is sharded part of a larger * document. If the document is not sharded, this message is not specified. @@ -266,25 +273,29 @@ public function setText($var) } /** - * Placeholder. Styles for the [Document.text][google.cloud.documentai.v1.Document.text]. + * Styles for the [Document.text][google.cloud.documentai.v1.Document.text]. * - * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Style text_styles = 5; + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; * @return \Google\Protobuf\Internal\RepeatedField + * @deprecated */ public function getTextStyles() { + @trigger_error('text_styles is deprecated.', E_USER_DEPRECATED); return $this->text_styles; } /** - * Placeholder. Styles for the [Document.text][google.cloud.documentai.v1.Document.text]. + * Styles for the [Document.text][google.cloud.documentai.v1.Document.text]. * - * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Style text_styles = 5; + * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true]; * @param array<\Google\Cloud\DocumentAI\V1\Document\Style>|\Google\Protobuf\Internal\RepeatedField $var * @return $this + * @deprecated */ public function setTextStyles($var) { + @trigger_error('text_styles is deprecated.', E_USER_DEPRECATED); $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DocumentAI\V1\Document\Style::class); $this->text_styles = $arr; @@ -318,8 +329,9 @@ public function setPages($var) } /** - * A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, - * entities in this list may cross shard boundaries. + * A list of entities detected on + * [Document.text][google.cloud.documentai.v1.Document.text]. For document + * shards, entities in this list may cross shard boundaries. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Entity entities = 7; * @return \Google\Protobuf\Internal\RepeatedField @@ -330,8 +342,9 @@ public function getEntities() } /** - * A list of entities detected on [Document.text][google.cloud.documentai.v1.Document.text]. For document shards, - * entities in this list may cross shard boundaries. + * A list of entities detected on + * [Document.text][google.cloud.documentai.v1.Document.text]. For document + * shards, entities in this list may cross shard boundaries. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Entity entities = 7; * @param array<\Google\Cloud\DocumentAI\V1\Document\Entity>|\Google\Protobuf\Internal\RepeatedField $var @@ -346,7 +359,8 @@ public function setEntities($var) } /** - * Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities]. + * Placeholder. Relationship among + * [Document.entities][google.cloud.documentai.v1.Document.entities]. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; * @return \Google\Protobuf\Internal\RepeatedField @@ -357,7 +371,8 @@ public function getEntityRelations() } /** - * Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities]. + * Placeholder. Relationship among + * [Document.entities][google.cloud.documentai.v1.Document.entities]. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8; * @param array<\Google\Cloud\DocumentAI\V1\Document\EntityRelation>|\Google\Protobuf\Internal\RepeatedField $var @@ -372,9 +387,10 @@ public function setEntityRelations($var) } /** - * Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.Document.text]. This - * is usually used for annotating corrections to OCR mistakes. Text changes - * for a given revision may not overlap with each other. + * Placeholder. A list of text corrections made to + * [Document.text][google.cloud.documentai.v1.Document.text]. This is usually + * used for annotating corrections to OCR mistakes. Text changes for a given + * revision may not overlap with each other. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14; * @return \Google\Protobuf\Internal\RepeatedField @@ -385,9 +401,10 @@ public function getTextChanges() } /** - * Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1.Document.text]. This - * is usually used for annotating corrections to OCR mistakes. Text changes - * for a given revision may not overlap with each other. + * Placeholder. A list of text corrections made to + * [Document.text][google.cloud.documentai.v1.Document.text]. This is usually + * used for annotating corrections to OCR mistakes. Text changes for a given + * revision may not overlap with each other. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14; * @param array<\Google\Cloud\DocumentAI\V1\Document\TextChange>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/DocumentAi/src/V1/Document/Entity.php b/DocumentAi/src/V1/Document/Entity.php index 7f9ee563e314..57bd426eb317 100644 --- a/DocumentAi/src/V1/Document/Entity.php +++ b/DocumentAi/src/V1/Document/Entity.php @@ -19,7 +19,8 @@ class Entity extends \Google\Protobuf\Internal\Message { /** * Optional. Provenance of the entity. - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -49,8 +50,8 @@ class Entity extends \Google\Protobuf\Internal\Message */ private $confidence = 0.0; /** - * Optional. Represents the provenance of this entity wrt. the location on the - * page where it was found. + * Optional. Represents the provenance of this entity wrt. the location on + * the page where it was found. * * Generated from protobuf field .google.cloud.documentai.v1.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -63,8 +64,8 @@ class Entity extends \Google\Protobuf\Internal\Message */ private $id = ''; /** - * Optional. Normalized entity value. Absent if the extracted value could not be - * converted or the type (e.g. address) is not supported for certain + * Optional. Normalized entity value. Absent if the extracted value could + * not be converted or the type (e.g. address) is not supported for certain * parsers. This field is also only populated for certain supported document * types. * @@ -72,8 +73,8 @@ class Entity extends \Google\Protobuf\Internal\Message */ private $normalized_value = null; /** - * Optional. Entities can be nested to form a hierarchical data structure representing - * the content in the document. + * Optional. Entities can be nested to form a hierarchical data structure + * representing the content in the document. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -85,7 +86,8 @@ class Entity extends \Google\Protobuf\Internal\Message */ private $provenance = null; /** - * Optional. Whether the entity will be redacted for de-identification purposes. + * Optional. Whether the entity will be redacted for de-identification + * purposes. * * Generated from protobuf field bool redacted = 12 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -99,7 +101,8 @@ class Entity extends \Google\Protobuf\Internal\Message * * @type \Google\Cloud\DocumentAI\V1\Document\TextAnchor $text_anchor * Optional. Provenance of the entity. - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. * @type string $type * Required. Entity type from a schema e.g. `Address`. * @type string $mention_text @@ -109,23 +112,24 @@ class Entity extends \Google\Protobuf\Internal\Message * @type float $confidence * Optional. Confidence of detected Schema entity. Range `[0, 1]`. * @type \Google\Cloud\DocumentAI\V1\Document\PageAnchor $page_anchor - * Optional. Represents the provenance of this entity wrt. the location on the - * page where it was found. + * Optional. Represents the provenance of this entity wrt. the location on + * the page where it was found. * @type string $id * Optional. Canonical id. This will be a unique value in the entity list * for this document. * @type \Google\Cloud\DocumentAI\V1\Document\Entity\NormalizedValue $normalized_value - * Optional. Normalized entity value. Absent if the extracted value could not be - * converted or the type (e.g. address) is not supported for certain + * Optional. Normalized entity value. Absent if the extracted value could + * not be converted or the type (e.g. address) is not supported for certain * parsers. This field is also only populated for certain supported document * types. * @type array<\Google\Cloud\DocumentAI\V1\Document\Entity>|\Google\Protobuf\Internal\RepeatedField $properties - * Optional. Entities can be nested to form a hierarchical data structure representing - * the content in the document. + * Optional. Entities can be nested to form a hierarchical data structure + * representing the content in the document. * @type \Google\Cloud\DocumentAI\V1\Document\Provenance $provenance * Optional. The history of this annotation. * @type bool $redacted - * Optional. Whether the entity will be redacted for de-identification purposes. + * Optional. Whether the entity will be redacted for de-identification + * purposes. * } */ public function __construct($data = NULL) { @@ -135,7 +139,8 @@ public function __construct($data = NULL) { /** * Optional. Provenance of the entity. - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\DocumentAI\V1\Document\TextAnchor|null @@ -157,7 +162,8 @@ public function clearTextAnchor() /** * Optional. Provenance of the entity. - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\DocumentAI\V1\Document\TextAnchor $var @@ -276,8 +282,8 @@ public function setConfidence($var) } /** - * Optional. Represents the provenance of this entity wrt. the location on the - * page where it was found. + * Optional. Represents the provenance of this entity wrt. the location on + * the page where it was found. * * Generated from protobuf field .google.cloud.documentai.v1.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\DocumentAI\V1\Document\PageAnchor|null @@ -298,8 +304,8 @@ public function clearPageAnchor() } /** - * Optional. Represents the provenance of this entity wrt. the location on the - * page where it was found. + * Optional. Represents the provenance of this entity wrt. the location on + * the page where it was found. * * Generated from protobuf field .google.cloud.documentai.v1.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\DocumentAI\V1\Document\PageAnchor $var @@ -342,8 +348,8 @@ public function setId($var) } /** - * Optional. Normalized entity value. Absent if the extracted value could not be - * converted or the type (e.g. address) is not supported for certain + * Optional. Normalized entity value. Absent if the extracted value could + * not be converted or the type (e.g. address) is not supported for certain * parsers. This field is also only populated for certain supported document * types. * @@ -366,8 +372,8 @@ public function clearNormalizedValue() } /** - * Optional. Normalized entity value. Absent if the extracted value could not be - * converted or the type (e.g. address) is not supported for certain + * Optional. Normalized entity value. Absent if the extracted value could + * not be converted or the type (e.g. address) is not supported for certain * parsers. This field is also only populated for certain supported document * types. * @@ -384,8 +390,8 @@ public function setNormalizedValue($var) } /** - * Optional. Entities can be nested to form a hierarchical data structure representing - * the content in the document. + * Optional. Entities can be nested to form a hierarchical data structure + * representing the content in the document. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField @@ -396,8 +402,8 @@ public function getProperties() } /** - * Optional. Entities can be nested to form a hierarchical data structure representing - * the content in the document. + * Optional. Entities can be nested to form a hierarchical data structure + * representing the content in the document. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Cloud\DocumentAI\V1\Document\Entity>|\Google\Protobuf\Internal\RepeatedField $var @@ -448,7 +454,8 @@ public function setProvenance($var) } /** - * Optional. Whether the entity will be redacted for de-identification purposes. + * Optional. Whether the entity will be redacted for de-identification + * purposes. * * Generated from protobuf field bool redacted = 12 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -459,7 +466,8 @@ public function getRedacted() } /** - * Optional. Whether the entity will be redacted for de-identification purposes. + * Optional. Whether the entity will be redacted for de-identification + * purposes. * * Generated from protobuf field bool redacted = 12 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/DocumentAi/src/V1/Document/Entity/NormalizedValue.php b/DocumentAi/src/V1/Document/Entity/NormalizedValue.php index 3cf66df45b53..34b9f0bf5b0f 100644 --- a/DocumentAi/src/V1/Document/Entity/NormalizedValue.php +++ b/DocumentAi/src/V1/Document/Entity/NormalizedValue.php @@ -19,8 +19,8 @@ class NormalizedValue extends \Google\Protobuf\Internal\Message * Optional. An optional field to store a normalized string. * For some entity types, one of respective `structured_value` fields may * also be populated. Also not all the types of `structured_value` will be - * normalized. For example, some processors may not generate float - * or int normalized text by default. + * normalized. For example, some processors may not generate `float` + * or `integer` normalized text by default. * Below are sample formats mapped to structured values. * - Money/Currency type (`money_value`) is in the ISO 4217 text format. * - Date type (`date_value`) is in the ISO 8601 text format. @@ -60,8 +60,8 @@ class NormalizedValue extends \Google\Protobuf\Internal\Message * Optional. An optional field to store a normalized string. * For some entity types, one of respective `structured_value` fields may * also be populated. Also not all the types of `structured_value` will be - * normalized. For example, some processors may not generate float - * or int normalized text by default. + * normalized. For example, some processors may not generate `float` + * or `integer` normalized text by default. * Below are sample formats mapped to structured values. * - Money/Currency type (`money_value`) is in the ISO 4217 text format. * - Date type (`date_value`) is in the ISO 8601 text format. @@ -304,8 +304,8 @@ public function setFloatValue($var) * Optional. An optional field to store a normalized string. * For some entity types, one of respective `structured_value` fields may * also be populated. Also not all the types of `structured_value` will be - * normalized. For example, some processors may not generate float - * or int normalized text by default. + * normalized. For example, some processors may not generate `float` + * or `integer` normalized text by default. * Below are sample formats mapped to structured values. * - Money/Currency type (`money_value`) is in the ISO 4217 text format. * - Date type (`date_value`) is in the ISO 8601 text format. @@ -323,8 +323,8 @@ public function getText() * Optional. An optional field to store a normalized string. * For some entity types, one of respective `structured_value` fields may * also be populated. Also not all the types of `structured_value` will be - * normalized. For example, some processors may not generate float - * or int normalized text by default. + * normalized. For example, some processors may not generate `float` + * or `integer` normalized text by default. * Below are sample formats mapped to structured values. * - Money/Currency type (`money_value`) is in the ISO 4217 text format. * - Date type (`date_value`) is in the ISO 8601 text format. diff --git a/DocumentAi/src/V1/Document/EntityRelation.php b/DocumentAi/src/V1/Document/EntityRelation.php index a9a0a239a4ae..7669e0965bf4 100644 --- a/DocumentAi/src/V1/Document/EntityRelation.php +++ b/DocumentAi/src/V1/Document/EntityRelation.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Relationship between [Entities][google.cloud.documentai.v1.Document.Entity]. + * Relationship between + * [Entities][google.cloud.documentai.v1.Document.Entity]. * * Generated from protobuf message google.cloud.documentai.v1.Document.EntityRelation */ diff --git a/DocumentAi/src/V1/Document/Page.php b/DocumentAi/src/V1/Document/Page.php index 84010cb37b2b..af8d4df45f64 100644 --- a/DocumentAi/src/V1/Document/Page.php +++ b/DocumentAi/src/V1/Document/Page.php @@ -16,9 +16,11 @@ class Page extends \Google\Protobuf\Internal\Message { /** - * 1-based index for current [Page][google.cloud.documentai.v1.Document.Page] in a parent [Document][google.cloud.documentai.v1.Document]. - * Useful when a page is taken out of a [Document][google.cloud.documentai.v1.Document] for individual - * processing. + * 1-based index for current + * [Page][google.cloud.documentai.v1.Document.Page] in a parent + * [Document][google.cloud.documentai.v1.Document]. Useful when a page is + * taken out of a [Document][google.cloud.documentai.v1.Document] for + * individual processing. * * Generated from protobuf field int32 page_number = 1; */ @@ -136,9 +138,11 @@ class Page extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type int $page_number - * 1-based index for current [Page][google.cloud.documentai.v1.Document.Page] in a parent [Document][google.cloud.documentai.v1.Document]. - * Useful when a page is taken out of a [Document][google.cloud.documentai.v1.Document] for individual - * processing. + * 1-based index for current + * [Page][google.cloud.documentai.v1.Document.Page] in a parent + * [Document][google.cloud.documentai.v1.Document]. Useful when a page is + * taken out of a [Document][google.cloud.documentai.v1.Document] for + * individual processing. * @type \Google\Cloud\DocumentAI\V1\Document\Page\Image $image * Rendered image for this page. This image is preprocessed to remove any * skew, rotation, and distortions such that the annotation bounding boxes @@ -187,9 +191,11 @@ public function __construct($data = NULL) { } /** - * 1-based index for current [Page][google.cloud.documentai.v1.Document.Page] in a parent [Document][google.cloud.documentai.v1.Document]. - * Useful when a page is taken out of a [Document][google.cloud.documentai.v1.Document] for individual - * processing. + * 1-based index for current + * [Page][google.cloud.documentai.v1.Document.Page] in a parent + * [Document][google.cloud.documentai.v1.Document]. Useful when a page is + * taken out of a [Document][google.cloud.documentai.v1.Document] for + * individual processing. * * Generated from protobuf field int32 page_number = 1; * @return int @@ -200,9 +206,11 @@ public function getPageNumber() } /** - * 1-based index for current [Page][google.cloud.documentai.v1.Document.Page] in a parent [Document][google.cloud.documentai.v1.Document]. - * Useful when a page is taken out of a [Document][google.cloud.documentai.v1.Document] for individual - * processing. + * 1-based index for current + * [Page][google.cloud.documentai.v1.Document.Page] in a parent + * [Document][google.cloud.documentai.v1.Document]. Useful when a page is + * taken out of a [Document][google.cloud.documentai.v1.Document] for + * individual processing. * * Generated from protobuf field int32 page_number = 1; * @param int $var diff --git a/DocumentAi/src/V1/Document/Page/Block.php b/DocumentAi/src/V1/Document/Page/Block.php index 6d7b6e90d732..9db40cafb22a 100644 --- a/DocumentAi/src/V1/Document/Page/Block.php +++ b/DocumentAi/src/V1/Document/Page/Block.php @@ -17,7 +17,8 @@ class Block extends \Google\Protobuf\Internal\Message { /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Block][google.cloud.documentai.v1.Document.Page.Block]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Block][google.cloud.documentai.v1.Document.Page.Block]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; */ @@ -43,7 +44,8 @@ class Block extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\DocumentAI\V1\Document\Page\Layout $layout - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Block][google.cloud.documentai.v1.Document.Page.Block]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Block][google.cloud.documentai.v1.Document.Page.Block]. * @type array<\Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage>|\Google\Protobuf\Internal\RepeatedField $detected_languages * A list of detected languages together with confidence. * @type \Google\Cloud\DocumentAI\V1\Document\Provenance $provenance @@ -56,7 +58,8 @@ public function __construct($data = NULL) { } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Block][google.cloud.documentai.v1.Document.Page.Block]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Block][google.cloud.documentai.v1.Document.Page.Block]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @return \Google\Cloud\DocumentAI\V1\Document\Page\Layout|null @@ -77,7 +80,8 @@ public function clearLayout() } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Block][google.cloud.documentai.v1.Document.Page.Block]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Block][google.cloud.documentai.v1.Document.Page.Block]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @param \Google\Cloud\DocumentAI\V1\Document\Page\Layout $var diff --git a/DocumentAi/src/V1/Document/Page/DetectedBarcode.php b/DocumentAi/src/V1/Document/Page/DetectedBarcode.php index d1ba2db32d1b..e9f2aad81448 100644 --- a/DocumentAi/src/V1/Document/Page/DetectedBarcode.php +++ b/DocumentAi/src/V1/Document/Page/DetectedBarcode.php @@ -16,13 +16,15 @@ class DetectedBarcode extends \Google\Protobuf\Internal\Message { /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; */ private $layout = null; /** - * Detailed barcode information of the [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. + * Detailed barcode information of the + * [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. * * Generated from protobuf field .google.cloud.documentai.v1.Barcode barcode = 2; */ @@ -35,9 +37,11 @@ class DetectedBarcode extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\DocumentAI\V1\Document\Page\Layout $layout - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. * @type \Google\Cloud\DocumentAI\V1\Barcode $barcode - * Detailed barcode information of the [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. + * Detailed barcode information of the + * [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. * } */ public function __construct($data = NULL) { @@ -46,7 +50,8 @@ public function __construct($data = NULL) { } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @return \Google\Cloud\DocumentAI\V1\Document\Page\Layout|null @@ -67,7 +72,8 @@ public function clearLayout() } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @param \Google\Cloud\DocumentAI\V1\Document\Page\Layout $var @@ -82,7 +88,8 @@ public function setLayout($var) } /** - * Detailed barcode information of the [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. + * Detailed barcode information of the + * [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. * * Generated from protobuf field .google.cloud.documentai.v1.Barcode barcode = 2; * @return \Google\Cloud\DocumentAI\V1\Barcode|null @@ -103,7 +110,8 @@ public function clearBarcode() } /** - * Detailed barcode information of the [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. + * Detailed barcode information of the + * [DetectedBarcode][google.cloud.documentai.v1.Document.Page.DetectedBarcode]. * * Generated from protobuf field .google.cloud.documentai.v1.Barcode barcode = 2; * @param \Google\Cloud\DocumentAI\V1\Barcode $var diff --git a/DocumentAi/src/V1/Document/Page/FormField.php b/DocumentAi/src/V1/Document/Page/FormField.php index 80fecb9d2919..ebc285d717cc 100644 --- a/DocumentAi/src/V1/Document/Page/FormField.php +++ b/DocumentAi/src/V1/Document/Page/FormField.php @@ -16,14 +16,16 @@ class FormField extends \Google\Protobuf\Internal\Message { /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1.Document.Page.FormField] name. e.g. `Address`, `Email`, - * `Grand total`, `Phone number`, etc. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the + * [FormField][google.cloud.documentai.v1.Document.Page.FormField] name. + * e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout field_name = 1; */ private $field_name = null; /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1.Document.Page.FormField] value. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the + * [FormField][google.cloud.documentai.v1.Document.Page.FormField] value. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout field_value = 2; */ @@ -43,9 +45,9 @@ class FormField extends \Google\Protobuf\Internal\Message /** * If the value is non-textual, this field represents the type. Current * valid values are: - * - blank (this indicates the field_value is normal text) - * - "unfilled_checkbox" - * - "filled_checkbox" + * - blank (this indicates the `field_value` is normal text) + * - `unfilled_checkbox` + * - `filled_checkbox` * * Generated from protobuf field string value_type = 5; */ @@ -80,10 +82,12 @@ class FormField extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\DocumentAI\V1\Document\Page\Layout $field_name - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1.Document.Page.FormField] name. e.g. `Address`, `Email`, - * `Grand total`, `Phone number`, etc. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the + * [FormField][google.cloud.documentai.v1.Document.Page.FormField] name. + * e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. * @type \Google\Cloud\DocumentAI\V1\Document\Page\Layout $field_value - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1.Document.Page.FormField] value. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the + * [FormField][google.cloud.documentai.v1.Document.Page.FormField] value. * @type array<\Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage>|\Google\Protobuf\Internal\RepeatedField $name_detected_languages * A list of detected languages for name together with confidence. * @type array<\Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage>|\Google\Protobuf\Internal\RepeatedField $value_detected_languages @@ -91,9 +95,9 @@ class FormField extends \Google\Protobuf\Internal\Message * @type string $value_type * If the value is non-textual, this field represents the type. Current * valid values are: - * - blank (this indicates the field_value is normal text) - * - "unfilled_checkbox" - * - "filled_checkbox" + * - blank (this indicates the `field_value` is normal text) + * - `unfilled_checkbox` + * - `filled_checkbox` * @type string $corrected_key_text * Created for Labeling UI to export key text. * If corrections were made to the text identified by the @@ -112,8 +116,9 @@ public function __construct($data = NULL) { } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1.Document.Page.FormField] name. e.g. `Address`, `Email`, - * `Grand total`, `Phone number`, etc. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the + * [FormField][google.cloud.documentai.v1.Document.Page.FormField] name. + * e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout field_name = 1; * @return \Google\Cloud\DocumentAI\V1\Document\Page\Layout|null @@ -134,8 +139,9 @@ public function clearFieldName() } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1.Document.Page.FormField] name. e.g. `Address`, `Email`, - * `Grand total`, `Phone number`, etc. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the + * [FormField][google.cloud.documentai.v1.Document.Page.FormField] name. + * e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout field_name = 1; * @param \Google\Cloud\DocumentAI\V1\Document\Page\Layout $var @@ -150,7 +156,8 @@ public function setFieldName($var) } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1.Document.Page.FormField] value. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the + * [FormField][google.cloud.documentai.v1.Document.Page.FormField] value. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout field_value = 2; * @return \Google\Cloud\DocumentAI\V1\Document\Page\Layout|null @@ -171,7 +178,8 @@ public function clearFieldValue() } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1.Document.Page.FormField] value. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the + * [FormField][google.cloud.documentai.v1.Document.Page.FormField] value. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout field_value = 2; * @param \Google\Cloud\DocumentAI\V1\Document\Page\Layout $var @@ -240,9 +248,9 @@ public function setValueDetectedLanguages($var) /** * If the value is non-textual, this field represents the type. Current * valid values are: - * - blank (this indicates the field_value is normal text) - * - "unfilled_checkbox" - * - "filled_checkbox" + * - blank (this indicates the `field_value` is normal text) + * - `unfilled_checkbox` + * - `filled_checkbox` * * Generated from protobuf field string value_type = 5; * @return string @@ -255,9 +263,9 @@ public function getValueType() /** * If the value is non-textual, this field represents the type. Current * valid values are: - * - blank (this indicates the field_value is normal text) - * - "unfilled_checkbox" - * - "filled_checkbox" + * - blank (this indicates the `field_value` is normal text) + * - `unfilled_checkbox` + * - `filled_checkbox` * * Generated from protobuf field string value_type = 5; * @param string $var diff --git a/DocumentAi/src/V1/Document/Page/Layout.php b/DocumentAi/src/V1/Document/Page/Layout.php index dc7aca276aee..96282db495cb 100644 --- a/DocumentAi/src/V1/Document/Page/Layout.php +++ b/DocumentAi/src/V1/Document/Page/Layout.php @@ -16,27 +16,32 @@ class Layout extends \Google\Protobuf\Internal\Message { /** - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1; */ private $text_anchor = null; /** - * Confidence of the current [Layout][google.cloud.documentai.v1.Document.Page.Layout] within context of the object this - * layout is for. e.g. confidence can be for a single token, a table, - * a visual element, etc. depending on context. Range `[0, 1]`. + * Confidence of the current + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] within + * context of the object this layout is for. e.g. confidence can be for a + * single token, a table, a visual element, etc. depending on context. + * Range `[0, 1]`. * * Generated from protobuf field float confidence = 2; */ private $confidence = 0.0; /** - * The bounding polygon for the [Layout][google.cloud.documentai.v1.Document.Page.Layout]. + * The bounding polygon for the + * [Layout][google.cloud.documentai.v1.Document.Page.Layout]. * * Generated from protobuf field .google.cloud.documentai.v1.BoundingPoly bounding_poly = 3; */ private $bounding_poly = null; /** - * Detected orientation for the [Layout][google.cloud.documentai.v1.Document.Page.Layout]. + * Detected orientation for the + * [Layout][google.cloud.documentai.v1.Document.Page.Layout]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout.Orientation orientation = 4; */ @@ -49,15 +54,20 @@ class Layout extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\DocumentAI\V1\Document\TextAnchor $text_anchor - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. * @type float $confidence - * Confidence of the current [Layout][google.cloud.documentai.v1.Document.Page.Layout] within context of the object this - * layout is for. e.g. confidence can be for a single token, a table, - * a visual element, etc. depending on context. Range `[0, 1]`. + * Confidence of the current + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] within + * context of the object this layout is for. e.g. confidence can be for a + * single token, a table, a visual element, etc. depending on context. + * Range `[0, 1]`. * @type \Google\Cloud\DocumentAI\V1\BoundingPoly $bounding_poly - * The bounding polygon for the [Layout][google.cloud.documentai.v1.Document.Page.Layout]. + * The bounding polygon for the + * [Layout][google.cloud.documentai.v1.Document.Page.Layout]. * @type int $orientation - * Detected orientation for the [Layout][google.cloud.documentai.v1.Document.Page.Layout]. + * Detected orientation for the + * [Layout][google.cloud.documentai.v1.Document.Page.Layout]. * } */ public function __construct($data = NULL) { @@ -66,7 +76,8 @@ public function __construct($data = NULL) { } /** - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1; * @return \Google\Cloud\DocumentAI\V1\Document\TextAnchor|null @@ -87,7 +98,8 @@ public function clearTextAnchor() } /** - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1; * @param \Google\Cloud\DocumentAI\V1\Document\TextAnchor $var @@ -102,9 +114,11 @@ public function setTextAnchor($var) } /** - * Confidence of the current [Layout][google.cloud.documentai.v1.Document.Page.Layout] within context of the object this - * layout is for. e.g. confidence can be for a single token, a table, - * a visual element, etc. depending on context. Range `[0, 1]`. + * Confidence of the current + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] within + * context of the object this layout is for. e.g. confidence can be for a + * single token, a table, a visual element, etc. depending on context. + * Range `[0, 1]`. * * Generated from protobuf field float confidence = 2; * @return float @@ -115,9 +129,11 @@ public function getConfidence() } /** - * Confidence of the current [Layout][google.cloud.documentai.v1.Document.Page.Layout] within context of the object this - * layout is for. e.g. confidence can be for a single token, a table, - * a visual element, etc. depending on context. Range `[0, 1]`. + * Confidence of the current + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] within + * context of the object this layout is for. e.g. confidence can be for a + * single token, a table, a visual element, etc. depending on context. + * Range `[0, 1]`. * * Generated from protobuf field float confidence = 2; * @param float $var @@ -132,7 +148,8 @@ public function setConfidence($var) } /** - * The bounding polygon for the [Layout][google.cloud.documentai.v1.Document.Page.Layout]. + * The bounding polygon for the + * [Layout][google.cloud.documentai.v1.Document.Page.Layout]. * * Generated from protobuf field .google.cloud.documentai.v1.BoundingPoly bounding_poly = 3; * @return \Google\Cloud\DocumentAI\V1\BoundingPoly|null @@ -153,7 +170,8 @@ public function clearBoundingPoly() } /** - * The bounding polygon for the [Layout][google.cloud.documentai.v1.Document.Page.Layout]. + * The bounding polygon for the + * [Layout][google.cloud.documentai.v1.Document.Page.Layout]. * * Generated from protobuf field .google.cloud.documentai.v1.BoundingPoly bounding_poly = 3; * @param \Google\Cloud\DocumentAI\V1\BoundingPoly $var @@ -168,7 +186,8 @@ public function setBoundingPoly($var) } /** - * Detected orientation for the [Layout][google.cloud.documentai.v1.Document.Page.Layout]. + * Detected orientation for the + * [Layout][google.cloud.documentai.v1.Document.Page.Layout]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout.Orientation orientation = 4; * @return int @@ -179,7 +198,8 @@ public function getOrientation() } /** - * Detected orientation for the [Layout][google.cloud.documentai.v1.Document.Page.Layout]. + * Detected orientation for the + * [Layout][google.cloud.documentai.v1.Document.Page.Layout]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout.Orientation orientation = 4; * @param int $var diff --git a/DocumentAi/src/V1/Document/Page/Line.php b/DocumentAi/src/V1/Document/Page/Line.php index 7553c0232203..cac636117910 100644 --- a/DocumentAi/src/V1/Document/Page/Line.php +++ b/DocumentAi/src/V1/Document/Page/Line.php @@ -17,7 +17,8 @@ class Line extends \Google\Protobuf\Internal\Message { /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Line][google.cloud.documentai.v1.Document.Page.Line]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Line][google.cloud.documentai.v1.Document.Page.Line]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; */ @@ -43,7 +44,8 @@ class Line extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\DocumentAI\V1\Document\Page\Layout $layout - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Line][google.cloud.documentai.v1.Document.Page.Line]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Line][google.cloud.documentai.v1.Document.Page.Line]. * @type array<\Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage>|\Google\Protobuf\Internal\RepeatedField $detected_languages * A list of detected languages together with confidence. * @type \Google\Cloud\DocumentAI\V1\Document\Provenance $provenance @@ -56,7 +58,8 @@ public function __construct($data = NULL) { } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Line][google.cloud.documentai.v1.Document.Page.Line]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Line][google.cloud.documentai.v1.Document.Page.Line]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @return \Google\Cloud\DocumentAI\V1\Document\Page\Layout|null @@ -77,7 +80,8 @@ public function clearLayout() } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Line][google.cloud.documentai.v1.Document.Page.Line]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Line][google.cloud.documentai.v1.Document.Page.Line]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @param \Google\Cloud\DocumentAI\V1\Document\Page\Layout $var diff --git a/DocumentAi/src/V1/Document/Page/Paragraph.php b/DocumentAi/src/V1/Document/Page/Paragraph.php index 2d11cc1b091c..c22535ac9486 100644 --- a/DocumentAi/src/V1/Document/Page/Paragraph.php +++ b/DocumentAi/src/V1/Document/Page/Paragraph.php @@ -16,7 +16,8 @@ class Paragraph extends \Google\Protobuf\Internal\Message { /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Paragraph][google.cloud.documentai.v1.Document.Page.Paragraph]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Paragraph][google.cloud.documentai.v1.Document.Page.Paragraph]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; */ @@ -42,7 +43,8 @@ class Paragraph extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\DocumentAI\V1\Document\Page\Layout $layout - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Paragraph][google.cloud.documentai.v1.Document.Page.Paragraph]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Paragraph][google.cloud.documentai.v1.Document.Page.Paragraph]. * @type array<\Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage>|\Google\Protobuf\Internal\RepeatedField $detected_languages * A list of detected languages together with confidence. * @type \Google\Cloud\DocumentAI\V1\Document\Provenance $provenance @@ -55,7 +57,8 @@ public function __construct($data = NULL) { } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Paragraph][google.cloud.documentai.v1.Document.Page.Paragraph]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Paragraph][google.cloud.documentai.v1.Document.Page.Paragraph]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @return \Google\Cloud\DocumentAI\V1\Document\Page\Layout|null @@ -76,7 +79,8 @@ public function clearLayout() } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Paragraph][google.cloud.documentai.v1.Document.Page.Paragraph]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Paragraph][google.cloud.documentai.v1.Document.Page.Paragraph]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @param \Google\Cloud\DocumentAI\V1\Document\Page\Layout $var diff --git a/DocumentAi/src/V1/Document/Page/Symbol.php b/DocumentAi/src/V1/Document/Page/Symbol.php index 2b4815fefcb5..a2bc27bfde2a 100644 --- a/DocumentAi/src/V1/Document/Page/Symbol.php +++ b/DocumentAi/src/V1/Document/Page/Symbol.php @@ -16,7 +16,8 @@ class Symbol extends \Google\Protobuf\Internal\Message { /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Symbol][google.cloud.documentai.v1.Document.Page.Symbol]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Symbol][google.cloud.documentai.v1.Document.Page.Symbol]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; */ @@ -35,7 +36,8 @@ class Symbol extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\DocumentAI\V1\Document\Page\Layout $layout - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Symbol][google.cloud.documentai.v1.Document.Page.Symbol]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Symbol][google.cloud.documentai.v1.Document.Page.Symbol]. * @type array<\Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage>|\Google\Protobuf\Internal\RepeatedField $detected_languages * A list of detected languages together with confidence. * } @@ -46,7 +48,8 @@ public function __construct($data = NULL) { } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Symbol][google.cloud.documentai.v1.Document.Page.Symbol]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Symbol][google.cloud.documentai.v1.Document.Page.Symbol]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @return \Google\Cloud\DocumentAI\V1\Document\Page\Layout|null @@ -67,7 +70,8 @@ public function clearLayout() } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Symbol][google.cloud.documentai.v1.Document.Page.Symbol]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Symbol][google.cloud.documentai.v1.Document.Page.Symbol]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @param \Google\Cloud\DocumentAI\V1\Document\Page\Layout $var diff --git a/DocumentAi/src/V1/Document/Page/Table.php b/DocumentAi/src/V1/Document/Page/Table.php index b2502a31e68a..41e93153d38e 100644 --- a/DocumentAi/src/V1/Document/Page/Table.php +++ b/DocumentAi/src/V1/Document/Page/Table.php @@ -16,7 +16,8 @@ class Table extends \Google\Protobuf\Internal\Message { /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Table][google.cloud.documentai.v1.Document.Page.Table]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Table][google.cloud.documentai.v1.Document.Page.Table]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; */ @@ -53,7 +54,8 @@ class Table extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\DocumentAI\V1\Document\Page\Layout $layout - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Table][google.cloud.documentai.v1.Document.Page.Table]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Table][google.cloud.documentai.v1.Document.Page.Table]. * @type array<\Google\Cloud\DocumentAI\V1\Document\Page\Table\TableRow>|\Google\Protobuf\Internal\RepeatedField $header_rows * Header rows of the table. * @type array<\Google\Cloud\DocumentAI\V1\Document\Page\Table\TableRow>|\Google\Protobuf\Internal\RepeatedField $body_rows @@ -70,7 +72,8 @@ public function __construct($data = NULL) { } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Table][google.cloud.documentai.v1.Document.Page.Table]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Table][google.cloud.documentai.v1.Document.Page.Table]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @return \Google\Cloud\DocumentAI\V1\Document\Page\Layout|null @@ -91,7 +94,8 @@ public function clearLayout() } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Table][google.cloud.documentai.v1.Document.Page.Table]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Table][google.cloud.documentai.v1.Document.Page.Table]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @param \Google\Cloud\DocumentAI\V1\Document\Page\Layout $var diff --git a/DocumentAi/src/V1/Document/Page/Table/TableCell.php b/DocumentAi/src/V1/Document/Page/Table/TableCell.php index 696a1a17ad88..0339697c8857 100644 --- a/DocumentAi/src/V1/Document/Page/Table/TableCell.php +++ b/DocumentAi/src/V1/Document/Page/Table/TableCell.php @@ -16,7 +16,8 @@ class TableCell extends \Google\Protobuf\Internal\Message { /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [TableCell][google.cloud.documentai.v1.Document.Page.Table.TableCell]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [TableCell][google.cloud.documentai.v1.Document.Page.Table.TableCell]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; */ @@ -47,7 +48,8 @@ class TableCell extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\DocumentAI\V1\Document\Page\Layout $layout - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [TableCell][google.cloud.documentai.v1.Document.Page.Table.TableCell]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [TableCell][google.cloud.documentai.v1.Document.Page.Table.TableCell]. * @type int $row_span * How many rows this cell spans. * @type int $col_span @@ -62,7 +64,8 @@ public function __construct($data = NULL) { } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [TableCell][google.cloud.documentai.v1.Document.Page.Table.TableCell]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [TableCell][google.cloud.documentai.v1.Document.Page.Table.TableCell]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @return \Google\Cloud\DocumentAI\V1\Document\Page\Layout|null @@ -83,7 +86,8 @@ public function clearLayout() } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [TableCell][google.cloud.documentai.v1.Document.Page.Table.TableCell]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [TableCell][google.cloud.documentai.v1.Document.Page.Table.TableCell]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @param \Google\Cloud\DocumentAI\V1\Document\Page\Layout $var diff --git a/DocumentAi/src/V1/Document/Page/Token.php b/DocumentAi/src/V1/Document/Page/Token.php index ad70d9ed1991..372aad4677fb 100644 --- a/DocumentAi/src/V1/Document/Page/Token.php +++ b/DocumentAi/src/V1/Document/Page/Token.php @@ -16,13 +16,15 @@ class Token extends \Google\Protobuf\Internal\Message { /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Token][google.cloud.documentai.v1.Document.Page.Token]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Token][google.cloud.documentai.v1.Document.Page.Token]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; */ private $layout = null; /** - * Detected break at the end of a [Token][google.cloud.documentai.v1.Document.Page.Token]. + * Detected break at the end of a + * [Token][google.cloud.documentai.v1.Document.Page.Token]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Token.DetectedBreak detected_break = 2; */ @@ -48,9 +50,11 @@ class Token extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\DocumentAI\V1\Document\Page\Layout $layout - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Token][google.cloud.documentai.v1.Document.Page.Token]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Token][google.cloud.documentai.v1.Document.Page.Token]. * @type \Google\Cloud\DocumentAI\V1\Document\Page\Token\DetectedBreak $detected_break - * Detected break at the end of a [Token][google.cloud.documentai.v1.Document.Page.Token]. + * Detected break at the end of a + * [Token][google.cloud.documentai.v1.Document.Page.Token]. * @type array<\Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage>|\Google\Protobuf\Internal\RepeatedField $detected_languages * A list of detected languages together with confidence. * @type \Google\Cloud\DocumentAI\V1\Document\Provenance $provenance @@ -63,7 +67,8 @@ public function __construct($data = NULL) { } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Token][google.cloud.documentai.v1.Document.Page.Token]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Token][google.cloud.documentai.v1.Document.Page.Token]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @return \Google\Cloud\DocumentAI\V1\Document\Page\Layout|null @@ -84,7 +89,8 @@ public function clearLayout() } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [Token][google.cloud.documentai.v1.Document.Page.Token]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [Token][google.cloud.documentai.v1.Document.Page.Token]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @param \Google\Cloud\DocumentAI\V1\Document\Page\Layout $var @@ -99,7 +105,8 @@ public function setLayout($var) } /** - * Detected break at the end of a [Token][google.cloud.documentai.v1.Document.Page.Token]. + * Detected break at the end of a + * [Token][google.cloud.documentai.v1.Document.Page.Token]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Token.DetectedBreak detected_break = 2; * @return \Google\Cloud\DocumentAI\V1\Document\Page\Token\DetectedBreak|null @@ -120,7 +127,8 @@ public function clearDetectedBreak() } /** - * Detected break at the end of a [Token][google.cloud.documentai.v1.Document.Page.Token]. + * Detected break at the end of a + * [Token][google.cloud.documentai.v1.Document.Page.Token]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Token.DetectedBreak detected_break = 2; * @param \Google\Cloud\DocumentAI\V1\Document\Page\Token\DetectedBreak $var diff --git a/DocumentAi/src/V1/Document/Page/Token/DetectedBreak.php b/DocumentAi/src/V1/Document/Page/Token/DetectedBreak.php index f74d6c371237..826b142db9d3 100644 --- a/DocumentAi/src/V1/Document/Page/Token/DetectedBreak.php +++ b/DocumentAi/src/V1/Document/Page/Token/DetectedBreak.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Detected break at the end of a [Token][google.cloud.documentai.v1.Document.Page.Token]. + * Detected break at the end of a + * [Token][google.cloud.documentai.v1.Document.Page.Token]. * * Generated from protobuf message google.cloud.documentai.v1.Document.Page.Token.DetectedBreak */ diff --git a/DocumentAi/src/V1/Document/Page/VisualElement.php b/DocumentAi/src/V1/Document/Page/VisualElement.php index 68c3c902cee7..848278991249 100644 --- a/DocumentAi/src/V1/Document/Page/VisualElement.php +++ b/DocumentAi/src/V1/Document/Page/VisualElement.php @@ -17,13 +17,15 @@ class VisualElement extends \Google\Protobuf\Internal\Message { /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; */ private $layout = null; /** - * Type of the [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. + * Type of the + * [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. * * Generated from protobuf field string type = 2; */ @@ -42,9 +44,11 @@ class VisualElement extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\DocumentAI\V1\Document\Page\Layout $layout - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. * @type string $type - * Type of the [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. + * Type of the + * [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. * @type array<\Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage>|\Google\Protobuf\Internal\RepeatedField $detected_languages * A list of detected languages together with confidence. * } @@ -55,7 +59,8 @@ public function __construct($data = NULL) { } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @return \Google\Cloud\DocumentAI\V1\Document\Page\Layout|null @@ -76,7 +81,8 @@ public function clearLayout() } /** - * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. + * [Layout][google.cloud.documentai.v1.Document.Page.Layout] for + * [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 1; * @param \Google\Cloud\DocumentAI\V1\Document\Page\Layout $var @@ -91,7 +97,8 @@ public function setLayout($var) } /** - * Type of the [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. + * Type of the + * [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. * * Generated from protobuf field string type = 2; * @return string @@ -102,7 +109,8 @@ public function getType() } /** - * Type of the [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. + * Type of the + * [VisualElement][google.cloud.documentai.v1.Document.Page.VisualElement]. * * Generated from protobuf field string type = 2; * @param string $var diff --git a/DocumentAi/src/V1/Document/PageAnchor.php b/DocumentAi/src/V1/Document/PageAnchor.php index 416be7aac5d0..c6524ec14f53 100644 --- a/DocumentAi/src/V1/Document/PageAnchor.php +++ b/DocumentAi/src/V1/Document/PageAnchor.php @@ -9,9 +9,10 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Referencing the visual context of the entity in the [Document.pages][google.cloud.documentai.v1.Document.pages]. - * Page anchors can be cross-page, consist of multiple bounding polygons and - * optionally reference specific layout element types. + * Referencing the visual context of the entity in the + * [Document.pages][google.cloud.documentai.v1.Document.pages]. Page anchors + * can be cross-page, consist of multiple bounding polygons and optionally + * reference specific layout element types. * * Generated from protobuf message google.cloud.documentai.v1.Document.PageAnchor */ diff --git a/DocumentAi/src/V1/Document/PageAnchor/PageRef.php b/DocumentAi/src/V1/Document/PageAnchor/PageRef.php index a4df1d0910c1..8cd995c73216 100644 --- a/DocumentAi/src/V1/Document/PageAnchor/PageRef.php +++ b/DocumentAi/src/V1/Document/PageAnchor/PageRef.php @@ -16,35 +16,42 @@ class PageRef extends \Google\Protobuf\Internal\Message { /** - * Required. Index into the [Document.pages][google.cloud.documentai.v1.Document.pages] element, for example using - * [Document.pages][page_refs.page] to locate the related page element. - * This field is skipped when its value is the default 0. See + * Required. Index into the + * [Document.pages][google.cloud.documentai.v1.Document.pages] element, + * for example using + * `[Document.pages][page_refs.page]` to locate the related page element. + * This field is skipped when its value is the default `0`. See * https://developers.google.com/protocol-buffers/docs/proto3#json. * * Generated from protobuf field int64 page = 1 [(.google.api.field_behavior) = REQUIRED]; */ private $page = 0; /** - * Optional. The type of the layout element that is being referenced if any. + * Optional. The type of the layout element that is being referenced if + * any. * * Generated from protobuf field .google.cloud.documentai.v1.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $layout_type = 0; /** - * Optional. Deprecated. Use [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly] instead. + * Optional. Deprecated. Use + * [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly] + * instead. * * Generated from protobuf field string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL]; * @deprecated */ protected $layout_id = ''; /** - * Optional. Identifies the bounding polygon of a layout element on the page. + * Optional. Identifies the bounding polygon of a layout element on the + * page. * * Generated from protobuf field .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $bounding_poly = null; /** - * Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. + * Optional. Confidence of detected page element, if applicable. Range + * `[0, 1]`. * * Generated from protobuf field float confidence = 5 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -57,18 +64,25 @@ class PageRef extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type int|string $page - * Required. Index into the [Document.pages][google.cloud.documentai.v1.Document.pages] element, for example using - * [Document.pages][page_refs.page] to locate the related page element. - * This field is skipped when its value is the default 0. See + * Required. Index into the + * [Document.pages][google.cloud.documentai.v1.Document.pages] element, + * for example using + * `[Document.pages][page_refs.page]` to locate the related page element. + * This field is skipped when its value is the default `0`. See * https://developers.google.com/protocol-buffers/docs/proto3#json. * @type int $layout_type - * Optional. The type of the layout element that is being referenced if any. + * Optional. The type of the layout element that is being referenced if + * any. * @type string $layout_id - * Optional. Deprecated. Use [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly] instead. + * Optional. Deprecated. Use + * [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly] + * instead. * @type \Google\Cloud\DocumentAI\V1\BoundingPoly $bounding_poly - * Optional. Identifies the bounding polygon of a layout element on the page. + * Optional. Identifies the bounding polygon of a layout element on the + * page. * @type float $confidence - * Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. + * Optional. Confidence of detected page element, if applicable. Range + * `[0, 1]`. * } */ public function __construct($data = NULL) { @@ -77,9 +91,11 @@ public function __construct($data = NULL) { } /** - * Required. Index into the [Document.pages][google.cloud.documentai.v1.Document.pages] element, for example using - * [Document.pages][page_refs.page] to locate the related page element. - * This field is skipped when its value is the default 0. See + * Required. Index into the + * [Document.pages][google.cloud.documentai.v1.Document.pages] element, + * for example using + * `[Document.pages][page_refs.page]` to locate the related page element. + * This field is skipped when its value is the default `0`. See * https://developers.google.com/protocol-buffers/docs/proto3#json. * * Generated from protobuf field int64 page = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -91,9 +107,11 @@ public function getPage() } /** - * Required. Index into the [Document.pages][google.cloud.documentai.v1.Document.pages] element, for example using - * [Document.pages][page_refs.page] to locate the related page element. - * This field is skipped when its value is the default 0. See + * Required. Index into the + * [Document.pages][google.cloud.documentai.v1.Document.pages] element, + * for example using + * `[Document.pages][page_refs.page]` to locate the related page element. + * This field is skipped when its value is the default `0`. See * https://developers.google.com/protocol-buffers/docs/proto3#json. * * Generated from protobuf field int64 page = 1 [(.google.api.field_behavior) = REQUIRED]; @@ -109,7 +127,8 @@ public function setPage($var) } /** - * Optional. The type of the layout element that is being referenced if any. + * Optional. The type of the layout element that is being referenced if + * any. * * Generated from protobuf field .google.cloud.documentai.v1.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -120,7 +139,8 @@ public function getLayoutType() } /** - * Optional. The type of the layout element that is being referenced if any. + * Optional. The type of the layout element that is being referenced if + * any. * * Generated from protobuf field .google.cloud.documentai.v1.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -135,7 +155,9 @@ public function setLayoutType($var) } /** - * Optional. Deprecated. Use [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly] instead. + * Optional. Deprecated. Use + * [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly] + * instead. * * Generated from protobuf field string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL]; * @return string @@ -148,7 +170,9 @@ public function getLayoutId() } /** - * Optional. Deprecated. Use [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly] instead. + * Optional. Deprecated. Use + * [PageRef.bounding_poly][google.cloud.documentai.v1.Document.PageAnchor.PageRef.bounding_poly] + * instead. * * Generated from protobuf field string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -165,7 +189,8 @@ public function setLayoutId($var) } /** - * Optional. Identifies the bounding polygon of a layout element on the page. + * Optional. Identifies the bounding polygon of a layout element on the + * page. * * Generated from protobuf field .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\DocumentAI\V1\BoundingPoly|null @@ -186,7 +211,8 @@ public function clearBoundingPoly() } /** - * Optional. Identifies the bounding polygon of a layout element on the page. + * Optional. Identifies the bounding polygon of a layout element on the + * page. * * Generated from protobuf field .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\DocumentAI\V1\BoundingPoly $var @@ -201,7 +227,8 @@ public function setBoundingPoly($var) } /** - * Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. + * Optional. Confidence of detected page element, if applicable. Range + * `[0, 1]`. * * Generated from protobuf field float confidence = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return float @@ -212,7 +239,8 @@ public function getConfidence() } /** - * Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. + * Optional. Confidence of detected page element, if applicable. Range + * `[0, 1]`. * * Generated from protobuf field float confidence = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param float $var diff --git a/DocumentAi/src/V1/Document/PageAnchor/PageRef/LayoutType.php b/DocumentAi/src/V1/Document/PageAnchor/PageRef/LayoutType.php index 57636ed532aa..221ebd633975 100644 --- a/DocumentAi/src/V1/Document/PageAnchor/PageRef/LayoutType.php +++ b/DocumentAi/src/V1/Document/PageAnchor/PageRef/LayoutType.php @@ -20,43 +20,56 @@ class LayoutType */ const LAYOUT_TYPE_UNSPECIFIED = 0; /** - * References a [Page.blocks][google.cloud.documentai.v1.Document.Page.blocks] element. + * References a + * [Page.blocks][google.cloud.documentai.v1.Document.Page.blocks] + * element. * * Generated from protobuf enum BLOCK = 1; */ const BLOCK = 1; /** - * References a [Page.paragraphs][google.cloud.documentai.v1.Document.Page.paragraphs] element. + * References a + * [Page.paragraphs][google.cloud.documentai.v1.Document.Page.paragraphs] + * element. * * Generated from protobuf enum PARAGRAPH = 2; */ const PARAGRAPH = 2; /** - * References a [Page.lines][google.cloud.documentai.v1.Document.Page.lines] element. + * References a + * [Page.lines][google.cloud.documentai.v1.Document.Page.lines] element. * * Generated from protobuf enum LINE = 3; */ const LINE = 3; /** - * References a [Page.tokens][google.cloud.documentai.v1.Document.Page.tokens] element. + * References a + * [Page.tokens][google.cloud.documentai.v1.Document.Page.tokens] + * element. * * Generated from protobuf enum TOKEN = 4; */ const TOKEN = 4; /** - * References a [Page.visual_elements][google.cloud.documentai.v1.Document.Page.visual_elements] element. + * References a + * [Page.visual_elements][google.cloud.documentai.v1.Document.Page.visual_elements] + * element. * * Generated from protobuf enum VISUAL_ELEMENT = 5; */ const VISUAL_ELEMENT = 5; /** - * Refrrences a [Page.tables][google.cloud.documentai.v1.Document.Page.tables] element. + * Refrrences a + * [Page.tables][google.cloud.documentai.v1.Document.Page.tables] + * element. * * Generated from protobuf enum TABLE = 6; */ const TABLE = 6; /** - * References a [Page.form_fields][google.cloud.documentai.v1.Document.Page.form_fields] element. + * References a + * [Page.form_fields][google.cloud.documentai.v1.Document.Page.form_fields] + * element. * * Generated from protobuf enum FORM_FIELD = 7; */ diff --git a/DocumentAi/src/V1/Document/ShardInfo.php b/DocumentAi/src/V1/Document/ShardInfo.php index ceb0ffbd1b07..5468362e5902 100644 --- a/DocumentAi/src/V1/Document/ShardInfo.php +++ b/DocumentAi/src/V1/Document/ShardInfo.php @@ -30,7 +30,8 @@ class ShardInfo extends \Google\Protobuf\Internal\Message */ private $shard_count = 0; /** - * The index of the first character in [Document.text][google.cloud.documentai.v1.Document.text] in the overall + * The index of the first character in + * [Document.text][google.cloud.documentai.v1.Document.text] in the overall * document global text. * * Generated from protobuf field int64 text_offset = 3; @@ -48,7 +49,8 @@ class ShardInfo extends \Google\Protobuf\Internal\Message * @type int|string $shard_count * Total number of shards. * @type int|string $text_offset - * The index of the first character in [Document.text][google.cloud.documentai.v1.Document.text] in the overall + * The index of the first character in + * [Document.text][google.cloud.documentai.v1.Document.text] in the overall * document global text. * } */ @@ -110,7 +112,8 @@ public function setShardCount($var) } /** - * The index of the first character in [Document.text][google.cloud.documentai.v1.Document.text] in the overall + * The index of the first character in + * [Document.text][google.cloud.documentai.v1.Document.text] in the overall * document global text. * * Generated from protobuf field int64 text_offset = 3; @@ -122,7 +125,8 @@ public function getTextOffset() } /** - * The index of the first character in [Document.text][google.cloud.documentai.v1.Document.text] in the overall + * The index of the first character in + * [Document.text][google.cloud.documentai.v1.Document.text] in the overall * document global text. * * Generated from protobuf field int64 text_offset = 3; diff --git a/DocumentAi/src/V1/Document/Style.php b/DocumentAi/src/V1/Document/Style.php index 96ae9be5ebb3..da13ace922c0 100644 --- a/DocumentAi/src/V1/Document/Style.php +++ b/DocumentAi/src/V1/Document/Style.php @@ -17,7 +17,8 @@ class Style extends \Google\Protobuf\Internal\Message { /** - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1; */ @@ -77,7 +78,8 @@ class Style extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Cloud\DocumentAI\V1\Document\TextAnchor $text_anchor - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. * @type \Google\Type\Color $color * Text color. * @type \Google\Type\Color $background_color @@ -105,7 +107,8 @@ public function __construct($data = NULL) { } /** - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1; * @return \Google\Cloud\DocumentAI\V1\Document\TextAnchor|null @@ -126,7 +129,8 @@ public function clearTextAnchor() } /** - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1; * @param \Google\Cloud\DocumentAI\V1\Document\TextAnchor $var diff --git a/DocumentAi/src/V1/Document/TextAnchor.php b/DocumentAi/src/V1/Document/TextAnchor.php index b7c04a37cd21..5655e0477ede 100644 --- a/DocumentAi/src/V1/Document/TextAnchor.php +++ b/DocumentAi/src/V1/Document/TextAnchor.php @@ -9,14 +9,16 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Text reference indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. + * Text reference indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf message google.cloud.documentai.v1.Document.TextAnchor */ class TextAnchor extends \Google\Protobuf\Internal\Message { /** - * The text segments from the [Document.text][google.cloud.documentai.v1.Document.text]. + * The text segments from the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.TextAnchor.TextSegment text_segments = 1; */ @@ -37,7 +39,8 @@ class TextAnchor extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\DocumentAI\V1\Document\TextAnchor\TextSegment>|\Google\Protobuf\Internal\RepeatedField $text_segments - * The text segments from the [Document.text][google.cloud.documentai.v1.Document.text]. + * The text segments from the + * [Document.text][google.cloud.documentai.v1.Document.text]. * @type string $content * Contains the content of the text span so that users do * not have to look it up in the text_segments. It is always @@ -50,7 +53,8 @@ public function __construct($data = NULL) { } /** - * The text segments from the [Document.text][google.cloud.documentai.v1.Document.text]. + * The text segments from the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.TextAnchor.TextSegment text_segments = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -61,7 +65,8 @@ public function getTextSegments() } /** - * The text segments from the [Document.text][google.cloud.documentai.v1.Document.text]. + * The text segments from the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field repeated .google.cloud.documentai.v1.Document.TextAnchor.TextSegment text_segments = 1; * @param array<\Google\Cloud\DocumentAI\V1\Document\TextAnchor\TextSegment>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/DocumentAi/src/V1/Document/TextAnchor/TextSegment.php b/DocumentAi/src/V1/Document/TextAnchor/TextSegment.php index eec03dab8f9a..0af2a77b2bc1 100644 --- a/DocumentAi/src/V1/Document/TextAnchor/TextSegment.php +++ b/DocumentAi/src/V1/Document/TextAnchor/TextSegment.php @@ -9,22 +9,27 @@ use Google\Protobuf\Internal\GPBUtil; /** - * A text segment in the [Document.text][google.cloud.documentai.v1.Document.text]. The indices may be out of bounds - * which indicate that the text extends into another document shard for - * large sharded documents. See [ShardInfo.text_offset][google.cloud.documentai.v1.Document.ShardInfo.text_offset] + * A text segment in the + * [Document.text][google.cloud.documentai.v1.Document.text]. The indices + * may be out of bounds which indicate that the text extends into another + * document shard for large sharded documents. See + * [ShardInfo.text_offset][google.cloud.documentai.v1.Document.ShardInfo.text_offset] * * Generated from protobuf message google.cloud.documentai.v1.Document.TextAnchor.TextSegment */ class TextSegment extends \Google\Protobuf\Internal\Message { /** - * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] start UTF-8 char index in the [Document.text][google.cloud.documentai.v1.Document.text]. + * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] + * start UTF-8 char index in the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field int64 start_index = 1; */ private $start_index = 0; /** - * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] half open end UTF-8 char index in the + * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] + * half open end UTF-8 char index in the * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field int64 end_index = 2; @@ -38,9 +43,12 @@ class TextSegment extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type int|string $start_index - * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] start UTF-8 char index in the [Document.text][google.cloud.documentai.v1.Document.text]. + * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] + * start UTF-8 char index in the + * [Document.text][google.cloud.documentai.v1.Document.text]. * @type int|string $end_index - * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] half open end UTF-8 char index in the + * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] + * half open end UTF-8 char index in the * [Document.text][google.cloud.documentai.v1.Document.text]. * } */ @@ -50,7 +58,9 @@ public function __construct($data = NULL) { } /** - * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] start UTF-8 char index in the [Document.text][google.cloud.documentai.v1.Document.text]. + * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] + * start UTF-8 char index in the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field int64 start_index = 1; * @return int|string @@ -61,7 +71,9 @@ public function getStartIndex() } /** - * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] start UTF-8 char index in the [Document.text][google.cloud.documentai.v1.Document.text]. + * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] + * start UTF-8 char index in the + * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field int64 start_index = 1; * @param int|string $var @@ -76,7 +88,8 @@ public function setStartIndex($var) } /** - * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] half open end UTF-8 char index in the + * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] + * half open end UTF-8 char index in the * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field int64 end_index = 2; @@ -88,7 +101,8 @@ public function getEndIndex() } /** - * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] half open end UTF-8 char index in the + * [TextSegment][google.cloud.documentai.v1.Document.TextAnchor.TextSegment] + * half open end UTF-8 char index in the * [Document.text][google.cloud.documentai.v1.Document.text]. * * Generated from protobuf field int64 end_index = 2; diff --git a/DocumentAi/src/V1/Document/TextChange.php b/DocumentAi/src/V1/Document/TextChange.php index 691263416988..ad2ef3ef1be5 100644 --- a/DocumentAi/src/V1/Document/TextChange.php +++ b/DocumentAi/src/V1/Document/TextChange.php @@ -17,8 +17,9 @@ class TextChange extends \Google\Protobuf\Internal\Message { /** * Provenance of the correction. - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. There can only be a - * single `TextAnchor.text_segments` element. If the start and + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. There can + * only be a single `TextAnchor.text_segments` element. If the start and * end index of the text segment are the same, the text change is inserted * before that index. * @@ -47,8 +48,9 @@ class TextChange extends \Google\Protobuf\Internal\Message * * @type \Google\Cloud\DocumentAI\V1\Document\TextAnchor $text_anchor * Provenance of the correction. - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. There can only be a - * single `TextAnchor.text_segments` element. If the start and + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. There can + * only be a single `TextAnchor.text_segments` element. If the start and * end index of the text segment are the same, the text change is inserted * before that index. * @type string $changed_text @@ -64,8 +66,9 @@ public function __construct($data = NULL) { /** * Provenance of the correction. - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. There can only be a - * single `TextAnchor.text_segments` element. If the start and + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. There can + * only be a single `TextAnchor.text_segments` element. If the start and * end index of the text segment are the same, the text change is inserted * before that index. * @@ -89,8 +92,9 @@ public function clearTextAnchor() /** * Provenance of the correction. - * Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text]. There can only be a - * single `TextAnchor.text_segments` element. If the start and + * Text anchor indexing into the + * [Document.text][google.cloud.documentai.v1.Document.text]. There can + * only be a single `TextAnchor.text_segments` element. If the start and * end index of the text segment are the same, the text change is inserted * before that index. * diff --git a/DocumentAi/src/V1/DocumentOutputConfig/GcsOutputConfig.php b/DocumentAi/src/V1/DocumentOutputConfig/GcsOutputConfig.php index ed543957087f..f8353879c4b5 100644 --- a/DocumentAi/src/V1/DocumentOutputConfig/GcsOutputConfig.php +++ b/DocumentAi/src/V1/DocumentOutputConfig/GcsOutputConfig.php @@ -29,6 +29,12 @@ class GcsOutputConfig extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.protobuf.FieldMask field_mask = 2; */ private $field_mask = null; + /** + * Specifies the sharding config for the output document. + * + * Generated from protobuf field .google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig sharding_config = 3; + */ + private $sharding_config = null; /** * Constructor. @@ -42,6 +48,8 @@ class GcsOutputConfig extends \Google\Protobuf\Internal\Message * Specifies which fields to include in the output documents. * Only supports top level document and pages field so it must be in the * form of `{document_field_name}` or `pages.{page_field_name}`. + * @type \Google\Cloud\DocumentAI\V1\DocumentOutputConfig\GcsOutputConfig\ShardingConfig $sharding_config + * Specifies the sharding config for the output document. * } */ public function __construct($data = NULL) { @@ -115,6 +123,42 @@ public function setFieldMask($var) return $this; } + /** + * Specifies the sharding config for the output document. + * + * Generated from protobuf field .google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig sharding_config = 3; + * @return \Google\Cloud\DocumentAI\V1\DocumentOutputConfig\GcsOutputConfig\ShardingConfig|null + */ + public function getShardingConfig() + { + return $this->sharding_config; + } + + public function hasShardingConfig() + { + return isset($this->sharding_config); + } + + public function clearShardingConfig() + { + unset($this->sharding_config); + } + + /** + * Specifies the sharding config for the output document. + * + * Generated from protobuf field .google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig sharding_config = 3; + * @param \Google\Cloud\DocumentAI\V1\DocumentOutputConfig\GcsOutputConfig\ShardingConfig $var + * @return $this + */ + public function setShardingConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\DocumentAI\V1\DocumentOutputConfig\GcsOutputConfig\ShardingConfig::class); + $this->sharding_config = $var; + + return $this; + } + } diff --git a/DocumentAi/src/V1/DocumentOutputConfig/GcsOutputConfig/ShardingConfig.php b/DocumentAi/src/V1/DocumentOutputConfig/GcsOutputConfig/ShardingConfig.php new file mode 100644 index 000000000000..a2c01433a0cd --- /dev/null +++ b/DocumentAi/src/V1/DocumentOutputConfig/GcsOutputConfig/ShardingConfig.php @@ -0,0 +1,102 @@ +google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig + */ +class ShardingConfig extends \Google\Protobuf\Internal\Message +{ + /** + * The number of pages per shard. + * + * Generated from protobuf field int32 pages_per_shard = 1; + */ + private $pages_per_shard = 0; + /** + * The number of overlapping pages between consecutive shards. + * + * Generated from protobuf field int32 pages_overlap = 2; + */ + private $pages_overlap = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $pages_per_shard + * The number of pages per shard. + * @type int $pages_overlap + * The number of overlapping pages between consecutive shards. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Documentai\V1\DocumentIo::initOnce(); + parent::__construct($data); + } + + /** + * The number of pages per shard. + * + * Generated from protobuf field int32 pages_per_shard = 1; + * @return int + */ + public function getPagesPerShard() + { + return $this->pages_per_shard; + } + + /** + * The number of pages per shard. + * + * Generated from protobuf field int32 pages_per_shard = 1; + * @param int $var + * @return $this + */ + public function setPagesPerShard($var) + { + GPBUtil::checkInt32($var); + $this->pages_per_shard = $var; + + return $this; + } + + /** + * The number of overlapping pages between consecutive shards. + * + * Generated from protobuf field int32 pages_overlap = 2; + * @return int + */ + public function getPagesOverlap() + { + return $this->pages_overlap; + } + + /** + * The number of overlapping pages between consecutive shards. + * + * Generated from protobuf field int32 pages_overlap = 2; + * @param int $var + * @return $this + */ + public function setPagesOverlap($var) + { + GPBUtil::checkInt32($var); + $this->pages_overlap = $var; + + return $this; + } + +} + + diff --git a/DocumentAi/src/V1/DocumentSchema/EntityType.php b/DocumentAi/src/V1/DocumentSchema/EntityType.php index eca9aebccc90..ca0c2db17dcb 100644 --- a/DocumentAi/src/V1/DocumentSchema/EntityType.php +++ b/DocumentAi/src/V1/DocumentSchema/EntityType.php @@ -28,7 +28,7 @@ class EntityType extends \Google\Protobuf\Internal\Message * cannot be a 'Common Type'. Besides that we use the following naming * conventions: * - *use `snake_casing`* - * - name matching is case-insensitive + * - name matching is case-sensitive * - Maximum 64 characters. * - Must start with a letter. * - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward @@ -75,7 +75,7 @@ class EntityType extends \Google\Protobuf\Internal\Message * cannot be a 'Common Type'. Besides that we use the following naming * conventions: * - *use `snake_casing`* - * - name matching is case-insensitive + * - name matching is case-sensitive * - Maximum 64 characters. * - Must start with a letter. * - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward @@ -166,7 +166,7 @@ public function setDisplayName($var) * cannot be a 'Common Type'. Besides that we use the following naming * conventions: * - *use `snake_casing`* - * - name matching is case-insensitive + * - name matching is case-sensitive * - Maximum 64 characters. * - Must start with a letter. * - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward @@ -189,7 +189,7 @@ public function getName() * cannot be a 'Common Type'. Besides that we use the following naming * conventions: * - *use `snake_casing`* - * - name matching is case-insensitive + * - name matching is case-sensitive * - Maximum 64 characters. * - Must start with a letter. * - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward diff --git a/DocumentAi/src/V1/Gapic/DocumentProcessorServiceGapicClient.php b/DocumentAi/src/V1/Gapic/DocumentProcessorServiceGapicClient.php index 940b161133e9..df9279b3bbd2 100644 --- a/DocumentAi/src/V1/Gapic/DocumentProcessorServiceGapicClient.php +++ b/DocumentAi/src/V1/Gapic/DocumentProcessorServiceGapicClient.php @@ -508,7 +508,8 @@ public function __construct(array $options = []) * } * ``` * - * @param string $name Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or + * @param string $name Required. The resource name of + * [Processor][google.cloud.documentai.v1.Processor] or * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. * Format: `projects/{project}/locations/{location}/processors/{processor}`, * or @@ -583,10 +584,11 @@ public function batchProcessDocuments($name, array $optionalArgs = []) * } * ``` * - * @param string $parent Required. The parent (project and location) under which to create the processor. - * Format: `projects/{project}/locations/{location}` - * @param Processor $processor Required. The processor to be created, requires [processor_type] and [display_name] - * to be set. Also, the processor is under CMEK if CMEK fields are set. + * @param string $parent Required. The parent (project and location) under which to create the + * processor. Format: `projects/{project}/locations/{location}` + * @param Processor $processor Required. The processor to be created, requires [processor_type] and + * [display_name] to be set. Also, the processor is under CMEK if CMEK fields + * are set. * @param array $optionalArgs { * Optional. * @@ -1239,8 +1241,9 @@ public function listProcessorTypes($parent, array $optionalArgs = []) * } * ``` * - * @param string $parent Required. The parent (project, location and processor) to list all versions. - * Format: `projects/{project}/locations/{location}/processors/{processor}` + * @param string $parent Required. The parent (project, location and processor) to list all + * versions. Format: + * `projects/{project}/locations/{location}/processors/{processor}` * @param array $optionalArgs { * Optional. * @@ -1317,8 +1320,8 @@ public function listProcessorVersions($parent, array $optionalArgs = []) * } * ``` * - * @param string $parent Required. The parent (project and location) which owns this collection of Processors. - * Format: `projects/{project}/locations/{location}` + * @param string $parent Required. The parent (project and location) which owns this collection of + * Processors. Format: `projects/{project}/locations/{location}` * @param array $optionalArgs { * Optional. * @@ -1383,11 +1386,15 @@ public function listProcessors($parent, array $optionalArgs = []) * } * ``` * - * @param string $name Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or + * @param string $name Required. The resource name of the + * [Processor][google.cloud.documentai.v1.Processor] or * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] - * to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use - * its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: - * `projects/{project}/locations/{location}/processors/{processor}`, or + * to use for processing. If a + * [Processor][google.cloud.documentai.v1.Processor] is specified, the server + * will use its [default + * version][google.cloud.documentai.v1.Processor.default_processor_version]. + * Format: `projects/{project}/locations/{location}/processors/{processor}`, + * or * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * @param array $optionalArgs { * Optional. @@ -1489,8 +1496,8 @@ public function processDocument($name, array $optionalArgs = []) * } * ``` * - * @param string $humanReviewConfig Required. The resource name of the HumanReviewConfig that the document will be - * reviewed with. + * @param string $humanReviewConfig Required. The resource name of the HumanReviewConfig that the document will + * be reviewed with. * @param array $optionalArgs { * Optional. * @@ -1552,8 +1559,10 @@ public function reviewDocument($humanReviewConfig, array $optionalArgs = []) } /** - * Set the default (active) version of a [Processor][google.cloud.documentai.v1.Processor] that will be used in - * [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] and + * Set the default (active) version of a + * [Processor][google.cloud.documentai.v1.Processor] that will be used in + * [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] + * and * [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments]. * * Sample code: @@ -1593,9 +1602,12 @@ public function reviewDocument($humanReviewConfig, array $optionalArgs = []) * } * ``` * - * @param string $processor Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] to change default version. - * @param string $defaultProcessorVersion Required. The resource name of child [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as default. - * Format: + * @param string $processor Required. The resource name of the + * [Processor][google.cloud.documentai.v1.Processor] to change default + * version. + * @param string $defaultProcessorVersion Required. The resource name of child + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as + * default. Format: * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` * @param array $optionalArgs { * Optional. diff --git a/DocumentAi/src/V1/ListProcessorVersionsRequest.php b/DocumentAi/src/V1/ListProcessorVersionsRequest.php index e0d2fa84684e..1b550ccba716 100644 --- a/DocumentAi/src/V1/ListProcessorVersionsRequest.php +++ b/DocumentAi/src/V1/ListProcessorVersionsRequest.php @@ -16,8 +16,9 @@ class ListProcessorVersionsRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The parent (project, location and processor) to list all versions. - * Format: `projects/{project}/locations/{location}/processors/{processor}` + * Required. The parent (project, location and processor) to list all + * versions. Format: + * `projects/{project}/locations/{location}/processors/{processor}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -45,8 +46,9 @@ class ListProcessorVersionsRequest extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $parent - * Required. The parent (project, location and processor) to list all versions. - * Format: `projects/{project}/locations/{location}/processors/{processor}` + * Required. The parent (project, location and processor) to list all + * versions. Format: + * `projects/{project}/locations/{location}/processors/{processor}` * @type int $page_size * The maximum number of processor versions to return. * If unspecified, at most 10 processor versions will be returned. @@ -62,8 +64,9 @@ public function __construct($data = NULL) { } /** - * Required. The parent (project, location and processor) to list all versions. - * Format: `projects/{project}/locations/{location}/processors/{processor}` + * Required. The parent (project, location and processor) to list all + * versions. Format: + * `projects/{project}/locations/{location}/processors/{processor}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -74,8 +77,9 @@ public function getParent() } /** - * Required. The parent (project, location and processor) to list all versions. - * Format: `projects/{project}/locations/{location}/processors/{processor}` + * Required. The parent (project, location and processor) to list all + * versions. Format: + * `projects/{project}/locations/{location}/processors/{processor}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DocumentAi/src/V1/ListProcessorsRequest.php b/DocumentAi/src/V1/ListProcessorsRequest.php index 888ad75c2433..45d5a2bb1440 100644 --- a/DocumentAi/src/V1/ListProcessorsRequest.php +++ b/DocumentAi/src/V1/ListProcessorsRequest.php @@ -16,8 +16,8 @@ class ListProcessorsRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The parent (project and location) which owns this collection of Processors. - * Format: `projects/{project}/locations/{location}` + * Required. The parent (project and location) which owns this collection of + * Processors. Format: `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -45,8 +45,8 @@ class ListProcessorsRequest extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $parent - * Required. The parent (project and location) which owns this collection of Processors. - * Format: `projects/{project}/locations/{location}` + * Required. The parent (project and location) which owns this collection of + * Processors. Format: `projects/{project}/locations/{location}` * @type int $page_size * The maximum number of processors to return. * If unspecified, at most 50 processors will be returned. @@ -62,8 +62,8 @@ public function __construct($data = NULL) { } /** - * Required. The parent (project and location) which owns this collection of Processors. - * Format: `projects/{project}/locations/{location}` + * Required. The parent (project and location) which owns this collection of + * Processors. Format: `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -74,8 +74,8 @@ public function getParent() } /** - * Required. The parent (project and location) which owns this collection of Processors. - * Format: `projects/{project}/locations/{location}` + * Required. The parent (project and location) which owns this collection of + * Processors. Format: `projects/{project}/locations/{location}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DocumentAi/src/V1/ProcessRequest.php b/DocumentAi/src/V1/ProcessRequest.php index fd58e41cbc3f..9591649b8e0b 100644 --- a/DocumentAi/src/V1/ProcessRequest.php +++ b/DocumentAi/src/V1/ProcessRequest.php @@ -16,11 +16,15 @@ class ProcessRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or + * Required. The resource name of the + * [Processor][google.cloud.documentai.v1.Processor] or * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] - * to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use - * its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: - * `projects/{project}/locations/{location}/processors/{processor}`, or + * to use for processing. If a + * [Processor][google.cloud.documentai.v1.Processor] is specified, the server + * will use its [default + * version][google.cloud.documentai.v1.Processor.default_processor_version]. + * Format: `projects/{project}/locations/{location}/processors/{processor}`, + * or * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -54,11 +58,15 @@ class ProcessRequest extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\DocumentAI\V1\RawDocument $raw_document * A raw document content (bytes). * @type string $name - * Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or + * Required. The resource name of the + * [Processor][google.cloud.documentai.v1.Processor] or * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] - * to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use - * its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: - * `projects/{project}/locations/{location}/processors/{processor}`, or + * to use for processing. If a + * [Processor][google.cloud.documentai.v1.Processor] is specified, the server + * will use its [default + * version][google.cloud.documentai.v1.Processor.default_processor_version]. + * Format: `projects/{project}/locations/{location}/processors/{processor}`, + * or * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * @type bool $skip_human_review * Whether Human Review feature should be skipped for this request. Default to @@ -137,11 +145,15 @@ public function setRawDocument($var) } /** - * Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or + * Required. The resource name of the + * [Processor][google.cloud.documentai.v1.Processor] or * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] - * to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use - * its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: - * `projects/{project}/locations/{location}/processors/{processor}`, or + * to use for processing. If a + * [Processor][google.cloud.documentai.v1.Processor] is specified, the server + * will use its [default + * version][google.cloud.documentai.v1.Processor.default_processor_version]. + * Format: `projects/{project}/locations/{location}/processors/{processor}`, + * or * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -153,11 +165,15 @@ public function getName() } /** - * Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or + * Required. The resource name of the + * [Processor][google.cloud.documentai.v1.Processor] or * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] - * to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use - * its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: - * `projects/{project}/locations/{location}/processors/{processor}`, or + * to use for processing. If a + * [Processor][google.cloud.documentai.v1.Processor] is specified, the server + * will use its [default + * version][google.cloud.documentai.v1.Processor.default_processor_version]. + * Format: `projects/{project}/locations/{location}/processors/{processor}`, + * or * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/DocumentAi/src/V1/Processor.php b/DocumentAi/src/V1/Processor.php index a684ac7eff77..ac52dbbfe9d6 100644 --- a/DocumentAi/src/V1/Processor.php +++ b/DocumentAi/src/V1/Processor.php @@ -50,7 +50,8 @@ class Processor extends \Google\Protobuf\Internal\Message */ private $default_processor_version = ''; /** - * Output only. Immutable. The http endpoint that can be called to invoke processing. + * Output only. Immutable. The http endpoint that can be called to invoke + * processing. * * Generated from protobuf field string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE]; */ @@ -89,7 +90,8 @@ class Processor extends \Google\Protobuf\Internal\Message * @type string $default_processor_version * The default processor version. * @type string $process_endpoint - * Output only. Immutable. The http endpoint that can be called to invoke processing. + * Output only. Immutable. The http endpoint that can be called to invoke + * processing. * @type \Google\Protobuf\Timestamp $create_time * The time the processor was created. * @type string $kms_key_name @@ -239,7 +241,8 @@ public function setDefaultProcessorVersion($var) } /** - * Output only. Immutable. The http endpoint that can be called to invoke processing. + * Output only. Immutable. The http endpoint that can be called to invoke + * processing. * * Generated from protobuf field string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE]; * @return string @@ -250,7 +253,8 @@ public function getProcessEndpoint() } /** - * Output only. Immutable. The http endpoint that can be called to invoke processing. + * Output only. Immutable. The http endpoint that can be called to invoke + * processing. * * Generated from protobuf field string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE]; * @param string $var diff --git a/DocumentAi/src/V1/ProcessorType.php b/DocumentAi/src/V1/ProcessorType.php index 869c15d88afa..f8428e8ae365 100644 --- a/DocumentAi/src/V1/ProcessorType.php +++ b/DocumentAi/src/V1/ProcessorType.php @@ -54,6 +54,12 @@ class ProcessorType extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.api.LaunchStage launch_stage = 8; */ private $launch_stage = 0; + /** + * A set of Cloud Storage URIs of sample documents for this processor. + * + * Generated from protobuf field repeated string sample_document_uris = 9; + */ + private $sample_document_uris; /** * Constructor. @@ -75,6 +81,8 @@ class ProcessorType extends \Google\Protobuf\Internal\Message * processor of this processor type. Otherwise, users need to request access. * @type int $launch_stage * Launch stage of the processor type + * @type array|\Google\Protobuf\Internal\RepeatedField $sample_document_uris + * A set of Cloud Storage URIs of sample documents for this processor. * } */ public function __construct($data = NULL) { @@ -242,5 +250,31 @@ public function setLaunchStage($var) return $this; } + /** + * A set of Cloud Storage URIs of sample documents for this processor. + * + * Generated from protobuf field repeated string sample_document_uris = 9; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getSampleDocumentUris() + { + return $this->sample_document_uris; + } + + /** + * A set of Cloud Storage URIs of sample documents for this processor. + * + * Generated from protobuf field repeated string sample_document_uris = 9; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setSampleDocumentUris($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->sample_document_uris = $arr; + + return $this; + } + } diff --git a/DocumentAi/src/V1/ReviewDocumentRequest.php b/DocumentAi/src/V1/ReviewDocumentRequest.php index bf7acbca1078..041f7106bc56 100644 --- a/DocumentAi/src/V1/ReviewDocumentRequest.php +++ b/DocumentAi/src/V1/ReviewDocumentRequest.php @@ -16,8 +16,8 @@ class ReviewDocumentRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the HumanReviewConfig that the document will be - * reviewed with. + * Required. The resource name of the HumanReviewConfig that the document will + * be reviewed with. * * Generated from protobuf field string human_review_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -51,8 +51,8 @@ class ReviewDocumentRequest extends \Google\Protobuf\Internal\Message * @type \Google\Cloud\DocumentAI\V1\Document $inline_document * An inline document proto. * @type string $human_review_config - * Required. The resource name of the HumanReviewConfig that the document will be - * reviewed with. + * Required. The resource name of the HumanReviewConfig that the document will + * be reviewed with. * @type bool $enable_schema_validation * Whether the validation should be performed on the ad-hoc review request. * @type int $priority @@ -98,8 +98,8 @@ public function setInlineDocument($var) } /** - * Required. The resource name of the HumanReviewConfig that the document will be - * reviewed with. + * Required. The resource name of the HumanReviewConfig that the document will + * be reviewed with. * * Generated from protobuf field string human_review_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -110,8 +110,8 @@ public function getHumanReviewConfig() } /** - * Required. The resource name of the HumanReviewConfig that the document will be - * reviewed with. + * Required. The resource name of the HumanReviewConfig that the document will + * be reviewed with. * * Generated from protobuf field string human_review_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var diff --git a/DocumentAi/src/V1/SetDefaultProcessorVersionRequest.php b/DocumentAi/src/V1/SetDefaultProcessorVersionRequest.php index acc829c09110..8277a82692cb 100644 --- a/DocumentAi/src/V1/SetDefaultProcessorVersionRequest.php +++ b/DocumentAi/src/V1/SetDefaultProcessorVersionRequest.php @@ -16,14 +16,17 @@ class SetDefaultProcessorVersionRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] to change default version. + * Required. The resource name of the + * [Processor][google.cloud.documentai.v1.Processor] to change default + * version. * * Generated from protobuf field string processor = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ private $processor = ''; /** - * Required. The resource name of child [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as default. - * Format: + * Required. The resource name of child + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as + * default. Format: * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` * * Generated from protobuf field string default_processor_version = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -37,10 +40,13 @@ class SetDefaultProcessorVersionRequest extends \Google\Protobuf\Internal\Messag * Optional. Data for populating the Message object. * * @type string $processor - * Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] to change default version. + * Required. The resource name of the + * [Processor][google.cloud.documentai.v1.Processor] to change default + * version. * @type string $default_processor_version - * Required. The resource name of child [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as default. - * Format: + * Required. The resource name of child + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as + * default. Format: * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` * } */ @@ -50,7 +56,9 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] to change default version. + * Required. The resource name of the + * [Processor][google.cloud.documentai.v1.Processor] to change default + * version. * * Generated from protobuf field string processor = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -61,7 +69,9 @@ public function getProcessor() } /** - * Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] to change default version. + * Required. The resource name of the + * [Processor][google.cloud.documentai.v1.Processor] to change default + * version. * * Generated from protobuf field string processor = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -76,8 +86,9 @@ public function setProcessor($var) } /** - * Required. The resource name of child [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as default. - * Format: + * Required. The resource name of child + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as + * default. Format: * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` * * Generated from protobuf field string default_processor_version = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -89,8 +100,9 @@ public function getDefaultProcessorVersion() } /** - * Required. The resource name of child [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as default. - * Format: + * Required. The resource name of child + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use as + * default. Format: * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` * * Generated from protobuf field string default_processor_version = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/DocumentAi/src/V1/resources/document_processor_service_rest_client_config.php b/DocumentAi/src/V1/resources/document_processor_service_rest_client_config.php index 7ef62ea115ad..8510793af7ad 100644 --- a/DocumentAi/src/V1/resources/document_processor_service_rest_client_config.php +++ b/DocumentAi/src/V1/resources/document_processor_service_rest_client_config.php @@ -308,4 +308,5 @@ ], ], ], + 'numericEnums' => true, ];