diff --git a/DocumentAi/samples/V1/DocumentProcessorServiceClient/batch_process_documents.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/batch_process_documents.php index a09cdc4702a2..0160bd39a744 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/batch_process_documents.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/batch_process_documents.php @@ -34,7 +34,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 4da1d5d88927..d43b36d2063f 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/create_processor.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/create_processor.php @@ -29,11 +29,12 @@ use Google\Cloud\DocumentAI\V1\Processor; /** - * Creates a processor from the [ProcessorType][google.cloud.documentai.v1.ProcessorType] provided. - * The processor will be at `ENABLED` state by default after its creation. + * Creates a processor from the + * [ProcessorType][google.cloud.documentai.v1.ProcessorType] provided. 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/evaluate_processor_version.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/evaluate_processor_version.php index 6ce9a0bd5bc0..6e97be55dcf5 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/evaluate_processor_version.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/evaluate_processor_version.php @@ -34,7 +34,9 @@ * Evaluates a ProcessorVersion against annotated documents, producing an * Evaluation. * - * @param string $formattedProcessorVersion The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. + * @param string $formattedProcessorVersion The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to + * evaluate. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * Please see {@see DocumentProcessorServiceClient::processorVersionName()} for help formatting this field. */ diff --git a/DocumentAi/samples/V1/DocumentProcessorServiceClient/fetch_processor_types.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/fetch_processor_types.php index 8289f03e2441..ae701e7f169d 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/fetch_processor_types.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/fetch_processor_types.php @@ -29,7 +29,8 @@ use Google\Cloud\DocumentAI\V1\FetchProcessorTypesResponse; /** - * Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] + * Fetches processor types. Note that we don't use + * [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] * here, because it isn't paginated. * * @param string $formattedParent The location of processor types to list. diff --git a/DocumentAi/samples/V1/DocumentProcessorServiceClient/get_evaluation.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/get_evaluation.php index 93b7b12e58c2..5a9fd34e7829 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/get_evaluation.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/get_evaluation.php @@ -31,7 +31,8 @@ /** * Retrieves a specific evaluation. * - * @param string $formattedName The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. + * @param string $formattedName The resource name of the + * [Evaluation][google.cloud.documentai.v1.Evaluation] to get. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}` * Please see {@see DocumentProcessorServiceClient::evaluationName()} for help formatting this field. */ diff --git a/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_evaluations.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_evaluations.php index d9fd83952492..56204bee4cec 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_evaluations.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_evaluations.php @@ -32,7 +32,9 @@ /** * Retrieves a set of evaluations for a given processor version. * - * @param string $formattedParent The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list evaluations for. + * @param string $formattedParent The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list + * evaluations for. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * Please see {@see DocumentProcessorServiceClient::processorVersionName()} for help formatting this field. */ diff --git a/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processor_versions.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processor_versions.php index fdbc0e346d93..6f255e825eef 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processor_versions.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processor_versions.php @@ -32,8 +32,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 0aa0d1a6308b..8e44cb46fb8e 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processors.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/list_processors.php @@ -32,8 +32,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 b408215b09af..83301198db37 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/process_document.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/process_document.php @@ -31,11 +31,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 432799e813f9..de14acf00be8 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/review_document.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/review_document.php @@ -34,8 +34,9 @@ * 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][google.cloud.documentai.v1.HumanReviewConfig] that the document will be - * reviewed with. Please see + * @param string $formattedHumanReviewConfig The resource name of the + * [HumanReviewConfig][google.cloud.documentai.v1.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 14dc833f029c..4f6a0333c6bd 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/set_default_processor_version.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/set_default_processor_version.php @@ -31,14 +31,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/samples/V1/DocumentProcessorServiceClient/train_processor_version.php b/DocumentAi/samples/V1/DocumentProcessorServiceClient/train_processor_version.php index 001de10572ec..17d67c3e5d87 100644 --- a/DocumentAi/samples/V1/DocumentProcessorServiceClient/train_processor_version.php +++ b/DocumentAi/samples/V1/DocumentProcessorServiceClient/train_processor_version.php @@ -36,8 +36,9 @@ * Operation metadata is returned as * [TrainProcessorVersionMetadata][google.cloud.documentai.v1.TrainProcessorVersionMetadata]. * - * @param string $formattedParent The parent (project, location and processor) to create the new version for. - * Format: `projects/{project}/locations/{location}/processors/{processor}`. Please see + * @param string $formattedParent The parent (project, location and processor) to create the new + * version for. Format: + * `projects/{project}/locations/{location}/processors/{processor}`. Please see * {@see DocumentProcessorServiceClient::processorName()} for help formatting this field. */ function train_processor_version_sample(string $formattedParent): void diff --git a/DocumentAi/src/V1/BatchProcessMetadata/IndividualProcessStatus.php b/DocumentAi/src/V1/BatchProcessMetadata/IndividualProcessStatus.php index 49e03ee4c83c..c269b8a5cc9d 100644 --- a/DocumentAi/src/V1/BatchProcessMetadata/IndividualProcessStatus.php +++ b/DocumentAi/src/V1/BatchProcessMetadata/IndividualProcessStatus.php @@ -16,8 +16,9 @@ class IndividualProcessStatus extends \Google\Protobuf\Internal\Message { /** - * The source of the document, same as the [input_gcs_source][google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus.input_gcs_source] field in the - * request when the batch process started. + * The source of the document, same as the + * [input_gcs_source][google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus.input_gcs_source] + * field in the request when the batch process started. * * Generated from protobuf field string input_gcs_source = 1; */ @@ -30,8 +31,8 @@ class IndividualProcessStatus extends \Google\Protobuf\Internal\Message private $status = null; /** * The Cloud Storage output destination (in the request as - * [DocumentOutputConfig.GcsOutputConfig.gcs_uri][google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.gcs_uri]) of the processed - * document if it was successful, otherwise empty. + * [DocumentOutputConfig.GcsOutputConfig.gcs_uri][google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.gcs_uri]) + * of the processed document if it was successful, otherwise empty. * * Generated from protobuf field string output_gcs_destination = 3; */ @@ -50,14 +51,15 @@ class IndividualProcessStatus extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $input_gcs_source - * The source of the document, same as the [input_gcs_source][google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus.input_gcs_source] field in the - * request when the batch process started. + * The source of the document, same as the + * [input_gcs_source][google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus.input_gcs_source] + * field in the request when the batch process started. * @type \Google\Rpc\Status $status * The status processing the document. * @type string $output_gcs_destination * The Cloud Storage output destination (in the request as - * [DocumentOutputConfig.GcsOutputConfig.gcs_uri][google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.gcs_uri]) of the processed - * document if it was successful, otherwise empty. + * [DocumentOutputConfig.GcsOutputConfig.gcs_uri][google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.gcs_uri]) + * of the processed document if it was successful, otherwise empty. * @type \Google\Cloud\DocumentAI\V1\HumanReviewStatus $human_review_status * The status of human review on the processed document. * } @@ -68,8 +70,9 @@ public function __construct($data = NULL) { } /** - * The source of the document, same as the [input_gcs_source][google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus.input_gcs_source] field in the - * request when the batch process started. + * The source of the document, same as the + * [input_gcs_source][google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus.input_gcs_source] + * field in the request when the batch process started. * * Generated from protobuf field string input_gcs_source = 1; * @return string @@ -80,8 +83,9 @@ public function getInputGcsSource() } /** - * The source of the document, same as the [input_gcs_source][google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus.input_gcs_source] field in the - * request when the batch process started. + * The source of the document, same as the + * [input_gcs_source][google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus.input_gcs_source] + * field in the request when the batch process started. * * Generated from protobuf field string input_gcs_source = 1; * @param string $var @@ -133,8 +137,8 @@ public function setStatus($var) /** * The Cloud Storage output destination (in the request as - * [DocumentOutputConfig.GcsOutputConfig.gcs_uri][google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.gcs_uri]) of the processed - * document if it was successful, otherwise empty. + * [DocumentOutputConfig.GcsOutputConfig.gcs_uri][google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.gcs_uri]) + * of the processed document if it was successful, otherwise empty. * * Generated from protobuf field string output_gcs_destination = 3; * @return string @@ -146,8 +150,8 @@ public function getOutputGcsDestination() /** * The Cloud Storage output destination (in the request as - * [DocumentOutputConfig.GcsOutputConfig.gcs_uri][google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.gcs_uri]) of the processed - * document if it was successful, otherwise empty. + * [DocumentOutputConfig.GcsOutputConfig.gcs_uri][google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.gcs_uri]) + * of the processed document if it was successful, otherwise empty. * * Generated from protobuf field string output_gcs_destination = 3; * @param string $var diff --git a/DocumentAi/src/V1/BatchProcessRequest.php b/DocumentAi/src/V1/BatchProcessRequest.php index c97e6c96ae63..963bc1d14986 100644 --- a/DocumentAi/src/V1/BatchProcessRequest.php +++ b/DocumentAi/src/V1/BatchProcessRequest.php @@ -17,7 +17,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 @@ -67,7 +68,8 @@ class BatchProcessRequest extends \Google\Protobuf\Internal\Message private $labels; /** - * @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 @@ -90,7 +92,8 @@ public static function build(string $name): self * 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 @@ -122,7 +125,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 @@ -137,7 +141,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/Client/DocumentProcessorServiceClient.php b/DocumentAi/src/V1/Client/DocumentProcessorServiceClient.php index 45299e42b25b..ee2355f5ef2e 100644 --- a/DocumentAi/src/V1/Client/DocumentProcessorServiceClient.php +++ b/DocumentAi/src/V1/Client/DocumentProcessorServiceClient.php @@ -436,8 +436,9 @@ public function batchProcessDocuments(BatchProcessRequest $request, array $callO } /** - * Creates a processor from the [ProcessorType][google.cloud.documentai.v1.ProcessorType] provided. - * The processor will be at `ENABLED` state by default after its creation. + * Creates a processor from the + * [ProcessorType][google.cloud.documentai.v1.ProcessorType] provided. The + * processor will be at `ENABLED` state by default after its creation. * * The async variant is * {@see DocumentProcessorServiceClient::createProcessorAsync()} . @@ -629,7 +630,8 @@ public function evaluateProcessorVersion(EvaluateProcessorVersionRequest $reques } /** - * Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] + * Fetches processor types. Note that we don't use + * [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] * here, because it isn't paginated. * * The async variant is @@ -928,8 +930,10 @@ public function reviewDocument(ReviewDocumentRequest $request, array $callOption } /** - * 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]. * * The async variant is diff --git a/DocumentAi/src/V1/CreateProcessorRequest.php b/DocumentAi/src/V1/CreateProcessorRequest.php index a3e8a6c7c008..c68fac4ebfb3 100644 --- a/DocumentAi/src/V1/CreateProcessorRequest.php +++ b/DocumentAi/src/V1/CreateProcessorRequest.php @@ -10,24 +10,28 @@ /** * Request message for the - * [CreateProcessor][google.cloud.documentai.v1.DocumentProcessorService.CreateProcessor] method. Notice - * this request is sent to a regionalized backend service. If the - * [ProcessorType][google.cloud.documentai.v1.ProcessorType] isn't available in that region, the creation fails. + * [CreateProcessor][google.cloud.documentai.v1.DocumentProcessorService.CreateProcessor] + * method. Notice this request is sent to a regionalized backend service. If the + * [ProcessorType][google.cloud.documentai.v1.ProcessorType] isn't available in + * that region, the creation fails. * * Generated from protobuf message google.cloud.documentai.v1.CreateProcessorRequest */ 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][google.cloud.documentai.v1.Processor.type] and - * [Processor.display_name][google.cloud.documentai.v1.Processor.display_name] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] + * Required. The processor to be created, requires + * [Processor.type][google.cloud.documentai.v1.Processor.type] and + * [Processor.display_name][google.cloud.documentai.v1.Processor.display_name] + * to be set. Also, the + * [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] * field must be set if the processor is under CMEK. * * Generated from protobuf field .google.cloud.documentai.v1.Processor processor = 2 [(.google.api.field_behavior) = REQUIRED]; @@ -35,11 +39,14 @@ class CreateProcessorRequest extends \Google\Protobuf\Internal\Message private $processor = null; /** - * @param string $parent Required. The parent (project and location) under which to create the processor. - * Format: `projects/{project}/locations/{location}` + * @param string $parent Required. 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. - * @param \Google\Cloud\DocumentAI\V1\Processor $processor Required. The processor to be created, requires [Processor.type][google.cloud.documentai.v1.Processor.type] and - * [Processor.display_name][google.cloud.documentai.v1.Processor.display_name] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] + * @param \Google\Cloud\DocumentAI\V1\Processor $processor Required. The processor to be created, requires + * [Processor.type][google.cloud.documentai.v1.Processor.type] and + * [Processor.display_name][google.cloud.documentai.v1.Processor.display_name] + * to be set. Also, the + * [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] * field must be set if the processor is under CMEK. * * @return \Google\Cloud\DocumentAI\V1\CreateProcessorRequest @@ -60,11 +67,14 @@ public static function build(string $parent, \Google\Cloud\DocumentAI\V1\Process * 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][google.cloud.documentai.v1.Processor.type] and - * [Processor.display_name][google.cloud.documentai.v1.Processor.display_name] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] + * Required. The processor to be created, requires + * [Processor.type][google.cloud.documentai.v1.Processor.type] and + * [Processor.display_name][google.cloud.documentai.v1.Processor.display_name] + * to be set. Also, the + * [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] * field must be set if the processor is under CMEK. * } */ @@ -74,8 +84,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 @@ -86,8 +96,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 @@ -102,8 +112,11 @@ public function setParent($var) } /** - * Required. The processor to be created, requires [Processor.type][google.cloud.documentai.v1.Processor.type] and - * [Processor.display_name][google.cloud.documentai.v1.Processor.display_name] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] + * Required. The processor to be created, requires + * [Processor.type][google.cloud.documentai.v1.Processor.type] and + * [Processor.display_name][google.cloud.documentai.v1.Processor.display_name] + * to be set. Also, the + * [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] * field must be set if the processor is under CMEK. * * Generated from protobuf field .google.cloud.documentai.v1.Processor processor = 2 [(.google.api.field_behavior) = REQUIRED]; @@ -125,8 +138,11 @@ public function clearProcessor() } /** - * Required. The processor to be created, requires [Processor.type][google.cloud.documentai.v1.Processor.type] and - * [Processor.display_name][google.cloud.documentai.v1.Processor.display_name] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] + * Required. The processor to be created, requires + * [Processor.type][google.cloud.documentai.v1.Processor.type] and + * [Processor.display_name][google.cloud.documentai.v1.Processor.display_name] + * to be set. Also, the + * [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] * field must be set if the processor is under CMEK. * * Generated from protobuf field .google.cloud.documentai.v1.Processor processor = 2 [(.google.api.field_behavior) = REQUIRED]; diff --git a/DocumentAi/src/V1/DeleteProcessorMetadata.php b/DocumentAi/src/V1/DeleteProcessorMetadata.php index 0c4a43a40dbf..95359c1f8ea2 100644 --- a/DocumentAi/src/V1/DeleteProcessorMetadata.php +++ b/DocumentAi/src/V1/DeleteProcessorMetadata.php @@ -10,7 +10,8 @@ /** * The long-running operation metadata for the - * [DeleteProcessor][google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessor] method. + * [DeleteProcessor][google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessor] + * method. * * Generated from protobuf message google.cloud.documentai.v1.DeleteProcessorMetadata */ diff --git a/DocumentAi/src/V1/DeleteProcessorRequest.php b/DocumentAi/src/V1/DeleteProcessorRequest.php index eb2d18fe3429..886e6f7d768b 100644 --- a/DocumentAi/src/V1/DeleteProcessorRequest.php +++ b/DocumentAi/src/V1/DeleteProcessorRequest.php @@ -10,7 +10,8 @@ /** * Request message for the - * [DeleteProcessor][google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessor] method. + * [DeleteProcessor][google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessor] + * method. * * Generated from protobuf message google.cloud.documentai.v1.DeleteProcessorRequest */ diff --git a/DocumentAi/src/V1/DisableProcessorMetadata.php b/DocumentAi/src/V1/DisableProcessorMetadata.php index 044c3e9c73b6..775058edf461 100644 --- a/DocumentAi/src/V1/DisableProcessorMetadata.php +++ b/DocumentAi/src/V1/DisableProcessorMetadata.php @@ -10,7 +10,8 @@ /** * The long-running operation metadata for the - * [DisableProcessor][google.cloud.documentai.v1.DocumentProcessorService.DisableProcessor] method. + * [DisableProcessor][google.cloud.documentai.v1.DocumentProcessorService.DisableProcessor] + * method. * * Generated from protobuf message google.cloud.documentai.v1.DisableProcessorMetadata */ diff --git a/DocumentAi/src/V1/DisableProcessorRequest.php b/DocumentAi/src/V1/DisableProcessorRequest.php index 575dfe00ec56..55e51e24d0de 100644 --- a/DocumentAi/src/V1/DisableProcessorRequest.php +++ b/DocumentAi/src/V1/DisableProcessorRequest.php @@ -10,7 +10,8 @@ /** * Request message for the - * [DisableProcessor][google.cloud.documentai.v1.DocumentProcessorService.DisableProcessor] method. + * [DisableProcessor][google.cloud.documentai.v1.DocumentProcessorService.DisableProcessor] + * method. * * Generated from protobuf message google.cloud.documentai.v1.DisableProcessorRequest */ diff --git a/DocumentAi/src/V1/DisableProcessorResponse.php b/DocumentAi/src/V1/DisableProcessorResponse.php index 5b1db499a5d0..f1f15d776735 100644 --- a/DocumentAi/src/V1/DisableProcessorResponse.php +++ b/DocumentAi/src/V1/DisableProcessorResponse.php @@ -10,8 +10,8 @@ /** * Response message for the - * [DisableProcessor][google.cloud.documentai.v1.DocumentProcessorService.DisableProcessor] method. - * Intentionally empty proto for adding fields in future. + * [DisableProcessor][google.cloud.documentai.v1.DocumentProcessorService.DisableProcessor] + * method. Intentionally empty proto for adding fields in future. * * Generated from protobuf message google.cloud.documentai.v1.DisableProcessorResponse */ diff --git a/DocumentAi/src/V1/Document.php b/DocumentAi/src/V1/Document.php index 1d12d75d8d18..680a4cb3d531 100644 --- a/DocumentAi/src/V1/Document.php +++ b/DocumentAi/src/V1/Document.php @@ -45,22 +45,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; */ @@ -111,14 +114,17 @@ class Document extends \Google\Protobuf\Internal\Message * @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. @@ -316,8 +322,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 @@ -328,8 +335,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 @@ -344,7 +352,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 @@ -355,7 +364,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 @@ -370,9 +380,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 @@ -383,9 +394,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/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 d783a0631b05..d9a35c1a6238 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 0bc6ad4e5ef1..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; */ @@ -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 @@ -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 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 c73fb0b00828..3e9e5a4c50d4 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; */ @@ -54,7 +55,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 @@ -71,7 +73,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 @@ -92,7 +95,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 2f93fe847d26..9c3e222bb6da 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; */ @@ -54,9 +56,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 @@ -71,7 +75,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 @@ -92,7 +97,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 @@ -107,7 +113,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 @@ -128,7 +135,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/Token/StyleInfo.php b/DocumentAi/src/V1/Document/Page/Token/StyleInfo.php index 4e3fa356cff6..c86a19f223c7 100644 --- a/DocumentAi/src/V1/Document/Page/Token/StyleInfo.php +++ b/DocumentAi/src/V1/Document/Page/Token/StyleInfo.php @@ -22,8 +22,9 @@ class StyleInfo extends \Google\Protobuf\Internal\Message */ private $font_size = 0; /** - * Font size in pixels, equal to _unrounded [font_size][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_size]_ * - * _resolution_ ÷ `72.0`. + * Font size in pixels, equal to _unrounded + * [font_size][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_size]_ + * * _resolution_ ÷ `72.0`. * * Generated from protobuf field double pixel_font_size = 2; */ @@ -41,8 +42,9 @@ class StyleInfo extends \Google\Protobuf\Internal\Message */ private $font_type = ''; /** - * Whether the text is bold (equivalent to [font_weight][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_weight] is at least - * `700`). + * Whether the text is bold (equivalent to + * [font_weight][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_weight] + * is at least `700`). * * Generated from protobuf field bool bold = 5; */ @@ -118,15 +120,17 @@ class StyleInfo extends \Google\Protobuf\Internal\Message * @type int $font_size * Font size in points (`1` point is `¹⁄₇₂` inches). * @type float $pixel_font_size - * Font size in pixels, equal to _unrounded [font_size][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_size]_ * - * _resolution_ ÷ `72.0`. + * Font size in pixels, equal to _unrounded + * [font_size][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_size]_ + * * _resolution_ ÷ `72.0`. * @type float $letter_spacing * Letter spacing in points. * @type string $font_type * Name or style of the font. * @type bool $bold - * Whether the text is bold (equivalent to [font_weight][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_weight] is at least - * `700`). + * Whether the text is bold (equivalent to + * [font_weight][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_weight] + * is at least `700`). * @type bool $italic * Whether the text is italic. * @type bool $underlined @@ -182,8 +186,9 @@ public function setFontSize($var) } /** - * Font size in pixels, equal to _unrounded [font_size][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_size]_ * - * _resolution_ ÷ `72.0`. + * Font size in pixels, equal to _unrounded + * [font_size][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_size]_ + * * _resolution_ ÷ `72.0`. * * Generated from protobuf field double pixel_font_size = 2; * @return float @@ -194,8 +199,9 @@ public function getPixelFontSize() } /** - * Font size in pixels, equal to _unrounded [font_size][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_size]_ * - * _resolution_ ÷ `72.0`. + * Font size in pixels, equal to _unrounded + * [font_size][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_size]_ + * * _resolution_ ÷ `72.0`. * * Generated from protobuf field double pixel_font_size = 2; * @param float $var @@ -262,8 +268,9 @@ public function setFontType($var) } /** - * Whether the text is bold (equivalent to [font_weight][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_weight] is at least - * `700`). + * Whether the text is bold (equivalent to + * [font_weight][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_weight] + * is at least `700`). * * Generated from protobuf field bool bold = 5; * @return bool @@ -274,8 +281,9 @@ public function getBold() } /** - * Whether the text is bold (equivalent to [font_weight][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_weight] is at least - * `700`). + * Whether the text is bold (equivalent to + * [font_weight][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_weight] + * is at least `700`). * * Generated from protobuf field bool bold = 5; * @param bool $var 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 c0e7c2c2845e..f824b299a264 100644 --- a/DocumentAi/src/V1/Document/PageAnchor/PageRef.php +++ b/DocumentAi/src/V1/Document/PageAnchor/PageRef.php @@ -16,7 +16,9 @@ class PageRef extends \Google\Protobuf\Internal\Message { /** - * Required. Index into the [Document.pages][google.cloud.documentai.v1.Document.pages] element, for example using + * 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. @@ -25,28 +27,32 @@ class PageRef extends \Google\Protobuf\Internal\Message */ 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. - * If `layout_type` is set, the bounding polygon must be exactly the same - * to the layout element it's referring to. + * Optional. Identifies the bounding polygon of a layout element on the + * page. If `layout_type` is set, the bounding polygon must be exactly the + * same to the layout element it's referring to. * * 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]; */ @@ -59,20 +65,26 @@ 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 + * 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. - * If `layout_type` is set, the bounding polygon must be exactly the same - * to the layout element it's referring to. + * Optional. Identifies the bounding polygon of a layout element on the + * page. If `layout_type` is set, the bounding polygon must be exactly the + * same to the layout element it's referring to. * @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) { @@ -81,7 +93,9 @@ public function __construct($data = NULL) { } /** - * Required. Index into the [Document.pages][google.cloud.documentai.v1.Document.pages] element, for example using + * 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. @@ -95,7 +109,9 @@ public function getPage() } /** - * Required. Index into the [Document.pages][google.cloud.documentai.v1.Document.pages] element, for example using + * 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. @@ -113,7 +129,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 @@ -124,7 +141,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 @@ -139,7 +157,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 @@ -152,7 +172,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 @@ -169,9 +191,9 @@ public function setLayoutId($var) } /** - * Optional. Identifies the bounding polygon of a layout element on the page. - * If `layout_type` is set, the bounding polygon must be exactly the same - * to the layout element it's referring to. + * Optional. Identifies the bounding polygon of a layout element on the + * page. If `layout_type` is set, the bounding polygon must be exactly the + * same to the layout element it's referring to. * * Generated from protobuf field .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\DocumentAI\V1\BoundingPoly|null @@ -192,9 +214,9 @@ public function clearBoundingPoly() } /** - * Optional. Identifies the bounding polygon of a layout element on the page. - * If `layout_type` is set, the bounding polygon must be exactly the same - * to the layout element it's referring to. + * Optional. Identifies the bounding polygon of a layout element on the + * page. If `layout_type` is set, the bounding polygon must be exactly the + * same to the layout element it's referring to. * * Generated from protobuf field .google.cloud.documentai.v1.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\DocumentAI\V1\BoundingPoly $var @@ -209,7 +231,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 @@ -220,7 +243,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 6375ff7fccbe..ffbf6a13ecb1 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; */ @@ -78,7 +79,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 @@ -107,7 +109,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 @@ -128,7 +131,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/EnableProcessorMetadata.php b/DocumentAi/src/V1/EnableProcessorMetadata.php index 4321d7eb4090..8883938b22c3 100644 --- a/DocumentAi/src/V1/EnableProcessorMetadata.php +++ b/DocumentAi/src/V1/EnableProcessorMetadata.php @@ -10,7 +10,8 @@ /** * The long-running operation metadata for the - * [EnableProcessor][google.cloud.documentai.v1.DocumentProcessorService.EnableProcessor] method. + * [EnableProcessor][google.cloud.documentai.v1.DocumentProcessorService.EnableProcessor] + * method. * * Generated from protobuf message google.cloud.documentai.v1.EnableProcessorMetadata */ diff --git a/DocumentAi/src/V1/EnableProcessorRequest.php b/DocumentAi/src/V1/EnableProcessorRequest.php index 797214123655..69f0290c3ae4 100644 --- a/DocumentAi/src/V1/EnableProcessorRequest.php +++ b/DocumentAi/src/V1/EnableProcessorRequest.php @@ -10,7 +10,8 @@ /** * Request message for the - * [EnableProcessor][google.cloud.documentai.v1.DocumentProcessorService.EnableProcessor] method. + * [EnableProcessor][google.cloud.documentai.v1.DocumentProcessorService.EnableProcessor] + * method. * * Generated from protobuf message google.cloud.documentai.v1.EnableProcessorRequest */ diff --git a/DocumentAi/src/V1/EnableProcessorResponse.php b/DocumentAi/src/V1/EnableProcessorResponse.php index fb2ad3323e41..573c89ac5fa2 100644 --- a/DocumentAi/src/V1/EnableProcessorResponse.php +++ b/DocumentAi/src/V1/EnableProcessorResponse.php @@ -10,8 +10,8 @@ /** * Response message for the - * [EnableProcessor][google.cloud.documentai.v1.DocumentProcessorService.EnableProcessor] method. - * Intentionally empty proto for adding fields in future. + * [EnableProcessor][google.cloud.documentai.v1.DocumentProcessorService.EnableProcessor] + * method. Intentionally empty proto for adding fields in future. * * Generated from protobuf message google.cloud.documentai.v1.EnableProcessorResponse */ diff --git a/DocumentAi/src/V1/EvaluateProcessorVersionRequest.php b/DocumentAi/src/V1/EvaluateProcessorVersionRequest.php index a7f5d5e64ecd..bd08972c749c 100644 --- a/DocumentAi/src/V1/EvaluateProcessorVersionRequest.php +++ b/DocumentAi/src/V1/EvaluateProcessorVersionRequest.php @@ -9,29 +9,35 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Evaluates the given [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] against the supplied documents. + * Evaluates the given + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] against the + * supplied documents. * * Generated from protobuf message google.cloud.documentai.v1.EvaluateProcessorVersionRequest */ class EvaluateProcessorVersionRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. + * Required. The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to + * evaluate. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * * Generated from protobuf field string processor_version = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ private $processor_version = ''; /** - * Optional. The documents used in the evaluation. If unspecified, use the processor's - * dataset as evaluation input. + * Optional. The documents used in the evaluation. If unspecified, use the + * processor's dataset as evaluation input. * * Generated from protobuf field .google.cloud.documentai.v1.BatchDocumentsInputConfig evaluation_documents = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $evaluation_documents = null; /** - * @param string $processorVersion Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. + * @param string $processorVersion Required. The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to + * evaluate. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * Please see {@see DocumentProcessorServiceClient::processorVersionName()} for help formatting this field. * @@ -52,11 +58,13 @@ public static function build(string $processorVersion): self * Optional. Data for populating the Message object. * * @type string $processor_version - * Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. + * Required. The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to + * evaluate. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * @type \Google\Cloud\DocumentAI\V1\BatchDocumentsInputConfig $evaluation_documents - * Optional. The documents used in the evaluation. If unspecified, use the processor's - * dataset as evaluation input. + * Optional. The documents used in the evaluation. If unspecified, use the + * processor's dataset as evaluation input. * } */ public function __construct($data = NULL) { @@ -65,7 +73,9 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. + * Required. The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to + * evaluate. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * * Generated from protobuf field string processor_version = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -77,7 +87,9 @@ public function getProcessorVersion() } /** - * Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. + * Required. The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to + * evaluate. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * * Generated from protobuf field string processor_version = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -93,8 +105,8 @@ public function setProcessorVersion($var) } /** - * Optional. The documents used in the evaluation. If unspecified, use the processor's - * dataset as evaluation input. + * Optional. The documents used in the evaluation. If unspecified, use the + * processor's dataset as evaluation input. * * Generated from protobuf field .google.cloud.documentai.v1.BatchDocumentsInputConfig evaluation_documents = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\DocumentAI\V1\BatchDocumentsInputConfig|null @@ -115,8 +127,8 @@ public function clearEvaluationDocuments() } /** - * Optional. The documents used in the evaluation. If unspecified, use the processor's - * dataset as evaluation input. + * Optional. The documents used in the evaluation. If unspecified, use the + * processor's dataset as evaluation input. * * Generated from protobuf field .google.cloud.documentai.v1.BatchDocumentsInputConfig evaluation_documents = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\DocumentAI\V1\BatchDocumentsInputConfig $var diff --git a/DocumentAi/src/V1/FetchProcessorTypesRequest.php b/DocumentAi/src/V1/FetchProcessorTypesRequest.php index 47792e9acdf2..679b71159dac 100644 --- a/DocumentAi/src/V1/FetchProcessorTypesRequest.php +++ b/DocumentAi/src/V1/FetchProcessorTypesRequest.php @@ -10,8 +10,9 @@ /** * Request message for the - * [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes] method. - * Some processor types may require the project be added to an allowlist. + * [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes] + * method. Some processor types may require the project be added to an + * allowlist. * * Generated from protobuf message google.cloud.documentai.v1.FetchProcessorTypesRequest */ diff --git a/DocumentAi/src/V1/FetchProcessorTypesResponse.php b/DocumentAi/src/V1/FetchProcessorTypesResponse.php index 812b11f22a0f..dd5747eca369 100644 --- a/DocumentAi/src/V1/FetchProcessorTypesResponse.php +++ b/DocumentAi/src/V1/FetchProcessorTypesResponse.php @@ -10,7 +10,8 @@ /** * Response message for the - * [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes] method. + * [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes] + * method. * * Generated from protobuf message google.cloud.documentai.v1.FetchProcessorTypesResponse */ diff --git a/DocumentAi/src/V1/Gapic/DocumentProcessorServiceGapicClient.php b/DocumentAi/src/V1/Gapic/DocumentProcessorServiceGapicClient.php index 38e3a24c9cea..27f2ccb8a23a 100644 --- a/DocumentAi/src/V1/Gapic/DocumentProcessorServiceGapicClient.php +++ b/DocumentAi/src/V1/Gapic/DocumentProcessorServiceGapicClient.php @@ -611,7 +611,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 @@ -692,8 +693,9 @@ public function batchProcessDocuments($name, array $optionalArgs = []) } /** - * Creates a processor from the [ProcessorType][google.cloud.documentai.v1.ProcessorType] provided. - * The processor will be at `ENABLED` state by default after its creation. + * Creates a processor from the + * [ProcessorType][google.cloud.documentai.v1.ProcessorType] provided. The + * processor will be at `ENABLED` state by default after its creation. * * Sample code: * ``` @@ -707,10 +709,13 @@ 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][google.cloud.documentai.v1.Processor.type] and - * [Processor.display_name][google.cloud.documentai.v1.Processor.display_name] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] + * @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][google.cloud.documentai.v1.Processor.type] and + * [Processor.display_name][google.cloud.documentai.v1.Processor.display_name] + * to be set. Also, the + * [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] * field must be set if the processor is under CMEK. * @param array $optionalArgs { * Optional. @@ -1152,14 +1157,16 @@ public function enableProcessor($name, array $optionalArgs = []) * } * ``` * - * @param string $processorVersion Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. + * @param string $processorVersion Required. The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to + * evaluate. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * @param array $optionalArgs { * Optional. * * @type BatchDocumentsInputConfig $evaluationDocuments - * Optional. The documents used in the evaluation. If unspecified, use the processor's - * dataset as evaluation input. + * Optional. The documents used in the evaluation. If unspecified, use the + * processor's dataset as evaluation input. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on @@ -1199,7 +1206,8 @@ public function evaluateProcessorVersion( } /** - * Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] + * Fetches processor types. Note that we don't use + * [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] * here, because it isn't paginated. * * Sample code: @@ -1262,7 +1270,8 @@ public function fetchProcessorTypes($parent, array $optionalArgs = []) * } * ``` * - * @param string $name Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. + * @param string $name Required. The resource name of the + * [Evaluation][google.cloud.documentai.v1.Evaluation] to get. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}` * @param array $optionalArgs { * Optional. @@ -1467,7 +1476,9 @@ public function getProcessorVersion($name, array $optionalArgs = []) * } * ``` * - * @param string $parent Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list evaluations for. + * @param string $parent Required. The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list + * evaluations for. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * @param array $optionalArgs { * Optional. @@ -1623,8 +1634,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. * @@ -1701,8 +1713,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. * @@ -1767,11 +1779,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. @@ -1786,7 +1802,8 @@ public function listProcessors($parent, array $optionalArgs = []) * Whether human review should be skipped for this request. Default to * `false`. * @type FieldMask $fieldMask - * Specifies which fields to include in the [ProcessResponse.document][google.cloud.documentai.v1.ProcessResponse.document] + * Specifies which fields to include in the + * [ProcessResponse.document][google.cloud.documentai.v1.ProcessResponse.document] * output. 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 ProcessOptions $processOptions @@ -1896,8 +1913,9 @@ public function processDocument($name, array $optionalArgs = []) * } * ``` * - * @param string $humanReviewConfig Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be - * reviewed with. + * @param string $humanReviewConfig Required. The resource name of the + * [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the + * document will be reviewed with. * @param array $optionalArgs { * Optional. * @@ -1959,8 +1977,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: @@ -2000,9 +2020,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. @@ -2083,8 +2106,9 @@ public function setDefaultProcessorVersion( * } * ``` * - * @param string $parent Required. The parent (project, location and processor) to create the new version for. - * Format: `projects/{project}/locations/{location}/processors/{processor}`. + * @param string $parent Required. The parent (project, location and processor) to create the new + * version for. Format: + * `projects/{project}/locations/{location}/processors/{processor}`. * @param ProcessorVersion $processorVersion Required. The processor version to be created. * @param array $optionalArgs { * Optional. @@ -2096,10 +2120,11 @@ public function setDefaultProcessorVersion( * @type DocumentSchema $documentSchema * Optional. The schema the processor version will be trained with. * @type InputData $inputData - * Optional. The input data used to train the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. + * Optional. The input data used to train the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. * @type string $baseProcessorVersion - * Optional. The processor version to use as a base for training. This processor version - * must be a child of `parent`. Format: + * Optional. The processor version to use as a base for training. This + * processor version must be a child of `parent`. Format: * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an diff --git a/DocumentAi/src/V1/GetEvaluationRequest.php b/DocumentAi/src/V1/GetEvaluationRequest.php index f29706db5760..3f6b6397979c 100644 --- a/DocumentAi/src/V1/GetEvaluationRequest.php +++ b/DocumentAi/src/V1/GetEvaluationRequest.php @@ -16,7 +16,8 @@ class GetEvaluationRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. + * Required. The resource name of the + * [Evaluation][google.cloud.documentai.v1.Evaluation] to get. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -24,7 +25,8 @@ class GetEvaluationRequest extends \Google\Protobuf\Internal\Message private $name = ''; /** - * @param string $name Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. + * @param string $name Required. The resource name of the + * [Evaluation][google.cloud.documentai.v1.Evaluation] to get. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}` * Please see {@see DocumentProcessorServiceClient::evaluationName()} for help formatting this field. * @@ -45,7 +47,8 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. + * Required. The resource name of the + * [Evaluation][google.cloud.documentai.v1.Evaluation] to get. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}` * } */ @@ -55,7 +58,8 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. + * Required. The resource name of the + * [Evaluation][google.cloud.documentai.v1.Evaluation] to get. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -67,7 +71,8 @@ public function getName() } /** - * Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. + * Required. The resource name of the + * [Evaluation][google.cloud.documentai.v1.Evaluation] to get. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/DocumentAi/src/V1/GetProcessorRequest.php b/DocumentAi/src/V1/GetProcessorRequest.php index b30cc50bfae5..a436dc92b9f1 100644 --- a/DocumentAi/src/V1/GetProcessorRequest.php +++ b/DocumentAi/src/V1/GetProcessorRequest.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Request message for the [GetProcessor][google.cloud.documentai.v1.DocumentProcessorService.GetProcessor] + * Request message for the + * [GetProcessor][google.cloud.documentai.v1.DocumentProcessorService.GetProcessor] * method. * * Generated from protobuf message google.cloud.documentai.v1.GetProcessorRequest diff --git a/DocumentAi/src/V1/GetProcessorTypeRequest.php b/DocumentAi/src/V1/GetProcessorTypeRequest.php index 3291e6d676c4..c93b93eddb47 100644 --- a/DocumentAi/src/V1/GetProcessorTypeRequest.php +++ b/DocumentAi/src/V1/GetProcessorTypeRequest.php @@ -10,7 +10,8 @@ /** * Request message for the - * [GetProcessorType][google.cloud.documentai.v1.DocumentProcessorService.GetProcessorType] method. + * [GetProcessorType][google.cloud.documentai.v1.DocumentProcessorService.GetProcessorType] + * method. * * Generated from protobuf message google.cloud.documentai.v1.GetProcessorTypeRequest */ diff --git a/DocumentAi/src/V1/GetProcessorVersionRequest.php b/DocumentAi/src/V1/GetProcessorVersionRequest.php index 6e00df63688e..8596ab9e93dd 100644 --- a/DocumentAi/src/V1/GetProcessorVersionRequest.php +++ b/DocumentAi/src/V1/GetProcessorVersionRequest.php @@ -10,7 +10,8 @@ /** * Request message for the - * [GetProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.GetProcessorVersion] method. + * [GetProcessorVersion][google.cloud.documentai.v1.DocumentProcessorService.GetProcessorVersion] + * method. * * Generated from protobuf message google.cloud.documentai.v1.GetProcessorVersionRequest */ diff --git a/DocumentAi/src/V1/HumanReviewStatus.php b/DocumentAi/src/V1/HumanReviewStatus.php index 7c05ed063c39..d40f6f0f9913 100644 --- a/DocumentAi/src/V1/HumanReviewStatus.php +++ b/DocumentAi/src/V1/HumanReviewStatus.php @@ -29,9 +29,11 @@ class HumanReviewStatus extends \Google\Protobuf\Internal\Message private $state_message = ''; /** * The name of the operation triggered by the processed document. This field - * is populated only when the [state][google.cloud.documentai.v1.HumanReviewStatus.state] is `HUMAN_REVIEW_IN_PROGRESS`. It has - * the same response type and metadata as the long-running operation returned - * by [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]. + * is populated only when the + * [state][google.cloud.documentai.v1.HumanReviewStatus.state] is + * `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as + * the long-running operation returned by + * [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]. * * Generated from protobuf field string human_review_operation = 3; */ @@ -49,9 +51,11 @@ class HumanReviewStatus extends \Google\Protobuf\Internal\Message * A message providing more details about the human review state. * @type string $human_review_operation * The name of the operation triggered by the processed document. This field - * is populated only when the [state][google.cloud.documentai.v1.HumanReviewStatus.state] is `HUMAN_REVIEW_IN_PROGRESS`. It has - * the same response type and metadata as the long-running operation returned - * by [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]. + * is populated only when the + * [state][google.cloud.documentai.v1.HumanReviewStatus.state] is + * `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as + * the long-running operation returned by + * [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]. * } */ public function __construct($data = NULL) { @@ -113,9 +117,11 @@ public function setStateMessage($var) /** * The name of the operation triggered by the processed document. This field - * is populated only when the [state][google.cloud.documentai.v1.HumanReviewStatus.state] is `HUMAN_REVIEW_IN_PROGRESS`. It has - * the same response type and metadata as the long-running operation returned - * by [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]. + * is populated only when the + * [state][google.cloud.documentai.v1.HumanReviewStatus.state] is + * `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as + * the long-running operation returned by + * [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]. * * Generated from protobuf field string human_review_operation = 3; * @return string @@ -127,9 +133,11 @@ public function getHumanReviewOperation() /** * The name of the operation triggered by the processed document. This field - * is populated only when the [state][google.cloud.documentai.v1.HumanReviewStatus.state] is `HUMAN_REVIEW_IN_PROGRESS`. It has - * the same response type and metadata as the long-running operation returned - * by [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]. + * is populated only when the + * [state][google.cloud.documentai.v1.HumanReviewStatus.state] is + * `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as + * the long-running operation returned by + * [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]. * * Generated from protobuf field string human_review_operation = 3; * @param string $var diff --git a/DocumentAi/src/V1/HumanReviewStatus/State.php b/DocumentAi/src/V1/HumanReviewStatus/State.php index 5da0162c4568..2cb38208abcf 100644 --- a/DocumentAi/src/V1/HumanReviewStatus/State.php +++ b/DocumentAi/src/V1/HumanReviewStatus/State.php @@ -41,7 +41,8 @@ class State const IN_PROGRESS = 3; /** * Some error happened during triggering human review, see the - * [state_message][google.cloud.documentai.v1.HumanReviewStatus.state_message] for details. + * [state_message][google.cloud.documentai.v1.HumanReviewStatus.state_message] + * for details. * * Generated from protobuf enum ERROR = 4; */ diff --git a/DocumentAi/src/V1/ListEvaluationsRequest.php b/DocumentAi/src/V1/ListEvaluationsRequest.php index ad9d039a546b..3ca00303ab73 100644 --- a/DocumentAi/src/V1/ListEvaluationsRequest.php +++ b/DocumentAi/src/V1/ListEvaluationsRequest.php @@ -9,14 +9,17 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Retrieves a list of evaluations for a given [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. + * Retrieves a list of evaluations for a given + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. * * Generated from protobuf message google.cloud.documentai.v1.ListEvaluationsRequest */ class ListEvaluationsRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list evaluations for. + * Required. The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list + * evaluations for. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -39,7 +42,9 @@ class ListEvaluationsRequest extends \Google\Protobuf\Internal\Message private $page_token = ''; /** - * @param string $parent Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list evaluations for. + * @param string $parent Required. The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list + * evaluations for. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * Please see {@see DocumentProcessorServiceClient::processorVersionName()} for help formatting this field. * @@ -60,7 +65,9 @@ public static function build(string $parent): self * Optional. Data for populating the Message object. * * @type string $parent - * Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list evaluations for. + * Required. The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list + * evaluations for. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * @type int $page_size * The standard list page size. @@ -77,7 +84,9 @@ public function __construct($data = NULL) { } /** - * Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list evaluations for. + * Required. The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list + * evaluations for. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { @@ -89,7 +98,9 @@ public function getParent() } /** - * Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list evaluations for. + * Required. The resource name of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list + * evaluations for. * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { diff --git a/DocumentAi/src/V1/ListProcessorTypesRequest.php b/DocumentAi/src/V1/ListProcessorTypesRequest.php index 4687d456a055..f6a6ff74339f 100644 --- a/DocumentAi/src/V1/ListProcessorTypesRequest.php +++ b/DocumentAi/src/V1/ListProcessorTypesRequest.php @@ -10,8 +10,9 @@ /** * Request message for the - * [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] method. - * Some processor types may require the project be added to an allowlist. + * [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] + * method. Some processor types may require the project be added to an + * allowlist. * * Generated from protobuf message google.cloud.documentai.v1.ListProcessorTypesRequest */ diff --git a/DocumentAi/src/V1/ListProcessorTypesResponse.php b/DocumentAi/src/V1/ListProcessorTypesResponse.php index 1b5c2fca8332..cad6cb143783 100644 --- a/DocumentAi/src/V1/ListProcessorTypesResponse.php +++ b/DocumentAi/src/V1/ListProcessorTypesResponse.php @@ -10,7 +10,8 @@ /** * Response message for the - * [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] method. + * [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes] + * method. * * Generated from protobuf message google.cloud.documentai.v1.ListProcessorTypesResponse */ diff --git a/DocumentAi/src/V1/ListProcessorVersionsRequest.php b/DocumentAi/src/V1/ListProcessorVersionsRequest.php index 91005ac879f7..0855408ca8f3 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) = { */ @@ -39,8 +40,9 @@ class ListProcessorVersionsRequest extends \Google\Protobuf\Internal\Message private $page_token = ''; /** - * @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}` * Please see {@see DocumentProcessorServiceClient::processorName()} for help formatting this field. * * @return \Google\Cloud\DocumentAI\V1\ListProcessorVersionsRequest @@ -60,8 +62,9 @@ public static function build(string $parent): self * 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. @@ -77,8 +80,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 @@ -89,8 +93,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 4b0946a0f25f..ed6ea01b0f2c 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) = { */ @@ -39,8 +39,8 @@ class ListProcessorsRequest extends \Google\Protobuf\Internal\Message private $page_token = ''; /** - * @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}` * Please see {@see DocumentProcessorServiceClient::locationName()} for help formatting this field. * * @return \Google\Cloud\DocumentAI\V1\ListProcessorsRequest @@ -60,8 +60,8 @@ public static function build(string $parent): self * 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. @@ -77,8 +77,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 @@ -89,8 +89,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/ListProcessorsResponse.php b/DocumentAi/src/V1/ListProcessorsResponse.php index 626893ecbab0..bd8c34e6e2f1 100644 --- a/DocumentAi/src/V1/ListProcessorsResponse.php +++ b/DocumentAi/src/V1/ListProcessorsResponse.php @@ -10,7 +10,8 @@ /** * Response message for the - * [ListProcessors][google.cloud.documentai.v1.DocumentProcessorService.ListProcessors] method. + * [ListProcessors][google.cloud.documentai.v1.DocumentProcessorService.ListProcessors] + * method. * * Generated from protobuf message google.cloud.documentai.v1.ListProcessorsResponse */ diff --git a/DocumentAi/src/V1/OcrConfig.php b/DocumentAi/src/V1/OcrConfig.php index 30f924135328..aa89f0c91389 100644 --- a/DocumentAi/src/V1/OcrConfig.php +++ b/DocumentAi/src/V1/OcrConfig.php @@ -55,7 +55,9 @@ class OcrConfig extends \Google\Protobuf\Internal\Message private $enable_symbol = false; /** * Turn on font identification model and return font style information. - * Deprecated, use [PremiumFeatures.compute_style_info][google.cloud.documentai.v1.OcrConfig.PremiumFeatures.compute_style_info] instead. + * Deprecated, use + * [PremiumFeatures.compute_style_info][google.cloud.documentai.v1.OcrConfig.PremiumFeatures.compute_style_info] + * instead. * * Generated from protobuf field bool compute_style_info = 8 [deprecated = true]; * @deprecated @@ -101,7 +103,9 @@ class OcrConfig extends \Google\Protobuf\Internal\Message * Includes symbol level OCR information if set to true. * @type bool $compute_style_info * Turn on font identification model and return font style information. - * Deprecated, use [PremiumFeatures.compute_style_info][google.cloud.documentai.v1.OcrConfig.PremiumFeatures.compute_style_info] instead. + * Deprecated, use + * [PremiumFeatures.compute_style_info][google.cloud.documentai.v1.OcrConfig.PremiumFeatures.compute_style_info] + * instead. * @type bool $disable_character_boxes_detection * Turn off character box detector in OCR engine. Character box detection is * enabled by default in OCR 2.0 (and later) processors. @@ -272,7 +276,9 @@ public function setEnableSymbol($var) /** * Turn on font identification model and return font style information. - * Deprecated, use [PremiumFeatures.compute_style_info][google.cloud.documentai.v1.OcrConfig.PremiumFeatures.compute_style_info] instead. + * Deprecated, use + * [PremiumFeatures.compute_style_info][google.cloud.documentai.v1.OcrConfig.PremiumFeatures.compute_style_info] + * instead. * * Generated from protobuf field bool compute_style_info = 8 [deprecated = true]; * @return bool @@ -286,7 +292,9 @@ public function getComputeStyleInfo() /** * Turn on font identification model and return font style information. - * Deprecated, use [PremiumFeatures.compute_style_info][google.cloud.documentai.v1.OcrConfig.PremiumFeatures.compute_style_info] instead. + * Deprecated, use + * [PremiumFeatures.compute_style_info][google.cloud.documentai.v1.OcrConfig.PremiumFeatures.compute_style_info] + * instead. * * Generated from protobuf field bool compute_style_info = 8 [deprecated = true]; * @param bool $var diff --git a/DocumentAi/src/V1/ProcessOptions.php b/DocumentAi/src/V1/ProcessOptions.php index f5261cb564e1..04141b7386a6 100644 --- a/DocumentAi/src/V1/ProcessOptions.php +++ b/DocumentAi/src/V1/ProcessOptions.php @@ -23,9 +23,11 @@ class ProcessOptions extends \Google\Protobuf\Internal\Message */ private $ocr_config = null; /** - * Optional. Override the schema of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will return an Invalid - * Argument error if this field is set when the underlying - * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] doesn't support schema override. + * Optional. Override the schema of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will + * return an Invalid Argument error if this field is set when the underlying + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] doesn't + * support schema override. * * Generated from protobuf field .google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -49,9 +51,11 @@ class ProcessOptions extends \Google\Protobuf\Internal\Message * Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. * Returns error if set on other processor types. * @type \Google\Cloud\DocumentAI\V1\DocumentSchema $schema_override - * Optional. Override the schema of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will return an Invalid - * Argument error if this field is set when the underlying - * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] doesn't support schema override. + * Optional. Override the schema of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will + * return an Invalid Argument error if this field is set when the underlying + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] doesn't + * support schema override. * } */ public function __construct($data = NULL) { @@ -193,9 +197,11 @@ public function setOcrConfig($var) } /** - * Optional. Override the schema of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will return an Invalid - * Argument error if this field is set when the underlying - * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] doesn't support schema override. + * Optional. Override the schema of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will + * return an Invalid Argument error if this field is set when the underlying + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] doesn't + * support schema override. * * Generated from protobuf field .google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\DocumentAI\V1\DocumentSchema|null @@ -216,9 +222,11 @@ public function clearSchemaOverride() } /** - * Optional. Override the schema of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will return an Invalid - * Argument error if this field is set when the underlying - * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] doesn't support schema override. + * Optional. Override the schema of the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Will + * return an Invalid Argument error if this field is set when the underlying + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] doesn't + * support schema override. * * Generated from protobuf field .google.cloud.documentai.v1.DocumentSchema schema_override = 8 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\DocumentAI\V1\DocumentSchema $var diff --git a/DocumentAi/src/V1/ProcessRequest.php b/DocumentAi/src/V1/ProcessRequest.php index 77b8d1de93dc..80d84227d6ab 100644 --- a/DocumentAi/src/V1/ProcessRequest.php +++ b/DocumentAi/src/V1/ProcessRequest.php @@ -10,18 +10,23 @@ /** * Request message for the - * [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] method. + * [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] + * method. * * Generated from protobuf message google.cloud.documentai.v1.ProcessRequest */ 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) = { @@ -35,7 +40,8 @@ class ProcessRequest extends \Google\Protobuf\Internal\Message */ private $skip_human_review = false; /** - * Specifies which fields to include in the [ProcessResponse.document][google.cloud.documentai.v1.ProcessResponse.document] + * Specifies which fields to include in the + * [ProcessResponse.document][google.cloud.documentai.v1.ProcessResponse.document] * output. Only supports top-level document and pages field, so it must be in * the form of `{document_field_name}` or `pages.{page_field_name}`. * @@ -61,11 +67,15 @@ class ProcessRequest extends \Google\Protobuf\Internal\Message protected $source; /** - * @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}` * * @return \Google\Cloud\DocumentAI\V1\ProcessRequest @@ -91,17 +101,22 @@ public static function build(string $name): self * @type \Google\Cloud\DocumentAI\V1\GcsDocument $gcs_document * A raw document on Google Cloud Storage. * @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 should be skipped for this request. Default to * `false`. * @type \Google\Protobuf\FieldMask $field_mask - * Specifies which fields to include in the [ProcessResponse.document][google.cloud.documentai.v1.ProcessResponse.document] + * Specifies which fields to include in the + * [ProcessResponse.document][google.cloud.documentai.v1.ProcessResponse.document] * output. 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\ProcessOptions $process_options @@ -213,11 +228,15 @@ public function setGcsDocument($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) = { @@ -229,11 +248,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) = { @@ -277,7 +300,8 @@ public function setSkipHumanReview($var) } /** - * Specifies which fields to include in the [ProcessResponse.document][google.cloud.documentai.v1.ProcessResponse.document] + * Specifies which fields to include in the + * [ProcessResponse.document][google.cloud.documentai.v1.ProcessResponse.document] * output. Only supports top-level document and pages field, so it must be in * the form of `{document_field_name}` or `pages.{page_field_name}`. * @@ -300,7 +324,8 @@ public function clearFieldMask() } /** - * Specifies which fields to include in the [ProcessResponse.document][google.cloud.documentai.v1.ProcessResponse.document] + * Specifies which fields to include in the + * [ProcessResponse.document][google.cloud.documentai.v1.ProcessResponse.document] * output. Only supports top-level document and pages field, so it must be in * the form of `{document_field_name}` or `pages.{page_field_name}`. * diff --git a/DocumentAi/src/V1/ProcessResponse.php b/DocumentAi/src/V1/ProcessResponse.php index 297d6a35b52d..bf2379e49104 100644 --- a/DocumentAi/src/V1/ProcessResponse.php +++ b/DocumentAi/src/V1/ProcessResponse.php @@ -10,7 +10,8 @@ /** * Response message for the - * [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] method. + * [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] + * method. * * Generated from protobuf message google.cloud.documentai.v1.ProcessResponse */ diff --git a/DocumentAi/src/V1/Processor.php b/DocumentAi/src/V1/Processor.php index 3c4ff0be7656..1c0793461805 100644 --- a/DocumentAi/src/V1/Processor.php +++ b/DocumentAi/src/V1/Processor.php @@ -56,7 +56,8 @@ class Processor extends \Google\Protobuf\Internal\Message */ private $processor_version_aliases; /** - * 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]; */ @@ -97,7 +98,8 @@ class Processor extends \Google\Protobuf\Internal\Message * @type array<\Google\Cloud\DocumentAI\V1\ProcessorVersionAlias>|\Google\Protobuf\Internal\RepeatedField $processor_version_aliases * Output only. The processor version aliases. * @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 @@ -273,7 +275,8 @@ public function setProcessorVersionAliases($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 @@ -284,7 +287,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/ReviewDocumentOperationMetadata.php b/DocumentAi/src/V1/ReviewDocumentOperationMetadata.php index 7f22bdf322c6..5be3e52f8db9 100644 --- a/DocumentAi/src/V1/ReviewDocumentOperationMetadata.php +++ b/DocumentAi/src/V1/ReviewDocumentOperationMetadata.php @@ -10,7 +10,8 @@ /** * The long-running operation metadata for the - * [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument] method. + * [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument] + * method. * * Generated from protobuf message google.cloud.documentai.v1.ReviewDocumentOperationMetadata */ diff --git a/DocumentAi/src/V1/ReviewDocumentRequest.php b/DocumentAi/src/V1/ReviewDocumentRequest.php index ca1664b39c8e..e91cdc317a00 100644 --- a/DocumentAi/src/V1/ReviewDocumentRequest.php +++ b/DocumentAi/src/V1/ReviewDocumentRequest.php @@ -10,15 +10,17 @@ /** * Request message for the - * [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument] method. + * [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument] + * method. * * Generated from protobuf message google.cloud.documentai.v1.ReviewDocumentRequest */ class ReviewDocumentRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be - * reviewed with. + * Required. The resource name of the + * [HumanReviewConfig][google.cloud.documentai.v1.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) = { */ @@ -44,8 +46,9 @@ class ReviewDocumentRequest extends \Google\Protobuf\Internal\Message protected $source; /** - * @param string $humanReviewConfig Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be - * reviewed with. Please see + * @param string $humanReviewConfig Required. The resource name of the + * [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the + * document will be reviewed with. Please see * {@see DocumentProcessorServiceClient::humanReviewConfigName()} for help formatting this field. * * @return \Google\Cloud\DocumentAI\V1\ReviewDocumentRequest @@ -67,8 +70,9 @@ public static function build(string $humanReviewConfig): self * @type \Google\Cloud\DocumentAI\V1\Document $inline_document * An inline document proto. * @type string $human_review_config - * Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be - * reviewed with. + * Required. The resource name of the + * [HumanReviewConfig][google.cloud.documentai.v1.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 @@ -114,8 +118,9 @@ public function setInlineDocument($var) } /** - * Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be - * reviewed with. + * Required. The resource name of the + * [HumanReviewConfig][google.cloud.documentai.v1.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 @@ -126,8 +131,9 @@ public function getHumanReviewConfig() } /** - * Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be - * reviewed with. + * Required. The resource name of the + * [HumanReviewConfig][google.cloud.documentai.v1.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/ReviewDocumentResponse.php b/DocumentAi/src/V1/ReviewDocumentResponse.php index 076819827de5..e6ab07dbc3c3 100644 --- a/DocumentAi/src/V1/ReviewDocumentResponse.php +++ b/DocumentAi/src/V1/ReviewDocumentResponse.php @@ -10,7 +10,8 @@ /** * Response message for the - * [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument] method. + * [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument] + * method. * * Generated from protobuf message google.cloud.documentai.v1.ReviewDocumentResponse */ diff --git a/DocumentAi/src/V1/SetDefaultProcessorVersionRequest.php b/DocumentAi/src/V1/SetDefaultProcessorVersionRequest.php index 14de7ad1d620..7f3deceb62b8 100644 --- a/DocumentAi/src/V1/SetDefaultProcessorVersionRequest.php +++ b/DocumentAi/src/V1/SetDefaultProcessorVersionRequest.php @@ -18,14 +18,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) = { @@ -39,10 +42,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}` * } */ @@ -52,7 +58,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 @@ -63,7 +71,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 @@ -78,8 +88,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) = { @@ -91,8 +102,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/TrainProcessorVersionRequest.php b/DocumentAi/src/V1/TrainProcessorVersionRequest.php index 7c79a6bd7bb9..c41e756c0948 100644 --- a/DocumentAi/src/V1/TrainProcessorVersionRequest.php +++ b/DocumentAi/src/V1/TrainProcessorVersionRequest.php @@ -18,8 +18,9 @@ class TrainProcessorVersionRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The parent (project, location and processor) to create the new version for. - * Format: `projects/{project}/locations/{location}/processors/{processor}`. + * Required. The parent (project, location and processor) to create the new + * version for. Format: + * `projects/{project}/locations/{location}/processors/{processor}`. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -37,14 +38,15 @@ class TrainProcessorVersionRequest extends \Google\Protobuf\Internal\Message */ private $document_schema = null; /** - * Optional. The input data used to train the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. + * Optional. The input data used to train the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. * * Generated from protobuf field .google.cloud.documentai.v1.TrainProcessorVersionRequest.InputData input_data = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $input_data = null; /** - * Optional. The processor version to use as a base for training. This processor version - * must be a child of `parent`. Format: + * Optional. The processor version to use as a base for training. This + * processor version must be a child of `parent`. Format: * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. * * Generated from protobuf field string base_processor_version = 8 [(.google.api.field_behavior) = OPTIONAL]; @@ -53,8 +55,9 @@ class TrainProcessorVersionRequest extends \Google\Protobuf\Internal\Message protected $processor_flags; /** - * @param string $parent Required. The parent (project, location and processor) to create the new version for. - * Format: `projects/{project}/locations/{location}/processors/{processor}`. Please see + * @param string $parent Required. The parent (project, location and processor) to create the new + * version for. Format: + * `projects/{project}/locations/{location}/processors/{processor}`. Please see * {@see DocumentProcessorServiceClient::processorName()} for help formatting this field. * @param \Google\Cloud\DocumentAI\V1\ProcessorVersion $processorVersion Required. The processor version to be created. * @@ -80,17 +83,19 @@ public static function build(string $parent, \Google\Cloud\DocumentAI\V1\Process * @type \Google\Cloud\DocumentAI\V1\TrainProcessorVersionRequest\FoundationModelTuningOptions $foundation_model_tuning_options * Options to control foundation model tuning of a processor. * @type string $parent - * Required. The parent (project, location and processor) to create the new version for. - * Format: `projects/{project}/locations/{location}/processors/{processor}`. + * Required. The parent (project, location and processor) to create the new + * version for. Format: + * `projects/{project}/locations/{location}/processors/{processor}`. * @type \Google\Cloud\DocumentAI\V1\ProcessorVersion $processor_version * Required. The processor version to be created. * @type \Google\Cloud\DocumentAI\V1\DocumentSchema $document_schema * Optional. The schema the processor version will be trained with. * @type \Google\Cloud\DocumentAI\V1\TrainProcessorVersionRequest\InputData $input_data - * Optional. The input data used to train the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. + * Optional. The input data used to train the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. * @type string $base_processor_version - * Optional. The processor version to use as a base for training. This processor version - * must be a child of `parent`. Format: + * Optional. The processor version to use as a base for training. This + * processor version must be a child of `parent`. Format: * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. * } */ @@ -162,8 +167,9 @@ public function setFoundationModelTuningOptions($var) } /** - * Required. The parent (project, location and processor) to create the new version for. - * Format: `projects/{project}/locations/{location}/processors/{processor}`. + * Required. The parent (project, location and processor) to create the new + * version for. 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 @@ -174,8 +180,9 @@ public function getParent() } /** - * Required. The parent (project, location and processor) to create the new version for. - * Format: `projects/{project}/locations/{location}/processors/{processor}`. + * Required. The parent (project, location and processor) to create the new + * version for. 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 @@ -262,7 +269,8 @@ public function setDocumentSchema($var) } /** - * Optional. The input data used to train the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. + * Optional. The input data used to train the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. * * Generated from protobuf field .google.cloud.documentai.v1.TrainProcessorVersionRequest.InputData input_data = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\DocumentAI\V1\TrainProcessorVersionRequest\InputData|null @@ -283,7 +291,8 @@ public function clearInputData() } /** - * Optional. The input data used to train the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. + * Optional. The input data used to train the + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. * * Generated from protobuf field .google.cloud.documentai.v1.TrainProcessorVersionRequest.InputData input_data = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\DocumentAI\V1\TrainProcessorVersionRequest\InputData $var @@ -298,8 +307,8 @@ public function setInputData($var) } /** - * Optional. The processor version to use as a base for training. This processor version - * must be a child of `parent`. Format: + * Optional. The processor version to use as a base for training. This + * processor version must be a child of `parent`. Format: * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. * * Generated from protobuf field string base_processor_version = 8 [(.google.api.field_behavior) = OPTIONAL]; @@ -311,8 +320,8 @@ public function getBaseProcessorVersion() } /** - * Optional. The processor version to use as a base for training. This processor version - * must be a child of `parent`. Format: + * Optional. The processor version to use as a base for training. This + * processor version must be a child of `parent`. Format: * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. * * Generated from protobuf field string base_processor_version = 8 [(.google.api.field_behavior) = OPTIONAL]; diff --git a/DocumentAi/src/V1/TrainProcessorVersionRequest/FoundationModelTuningOptions.php b/DocumentAi/src/V1/TrainProcessorVersionRequest/FoundationModelTuningOptions.php index 4bf65b9547f3..8572dd583155 100644 --- a/DocumentAi/src/V1/TrainProcessorVersionRequest/FoundationModelTuningOptions.php +++ b/DocumentAi/src/V1/TrainProcessorVersionRequest/FoundationModelTuningOptions.php @@ -16,16 +16,16 @@ class FoundationModelTuningOptions extends \Google\Protobuf\Internal\Message { /** - * Optional. The number of steps to run for model tuning. Valid values are between - * 1 and 400. If not provided, recommended steps will be used. + * Optional. The number of steps to run for model tuning. Valid values are + * between 1 and 400. If not provided, recommended steps will be used. * * Generated from protobuf field int32 train_steps = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $train_steps = 0; /** - * Optional. The multiplier to apply to the recommended learning rate. Valid values - * are between 0.1 and 10. If not provided, recommended learning rate will - * be used. + * Optional. The multiplier to apply to the recommended learning rate. Valid + * values are between 0.1 and 10. If not provided, recommended learning rate + * will be used. * * Generated from protobuf field float learning_rate_multiplier = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -38,12 +38,12 @@ class FoundationModelTuningOptions extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type int $train_steps - * Optional. The number of steps to run for model tuning. Valid values are between - * 1 and 400. If not provided, recommended steps will be used. + * Optional. The number of steps to run for model tuning. Valid values are + * between 1 and 400. If not provided, recommended steps will be used. * @type float $learning_rate_multiplier - * Optional. The multiplier to apply to the recommended learning rate. Valid values - * are between 0.1 and 10. If not provided, recommended learning rate will - * be used. + * Optional. The multiplier to apply to the recommended learning rate. Valid + * values are between 0.1 and 10. If not provided, recommended learning rate + * will be used. * } */ public function __construct($data = NULL) { @@ -52,8 +52,8 @@ public function __construct($data = NULL) { } /** - * Optional. The number of steps to run for model tuning. Valid values are between - * 1 and 400. If not provided, recommended steps will be used. + * Optional. The number of steps to run for model tuning. Valid values are + * between 1 and 400. If not provided, recommended steps will be used. * * Generated from protobuf field int32 train_steps = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -64,8 +64,8 @@ public function getTrainSteps() } /** - * Optional. The number of steps to run for model tuning. Valid values are between - * 1 and 400. If not provided, recommended steps will be used. + * Optional. The number of steps to run for model tuning. Valid values are + * between 1 and 400. If not provided, recommended steps will be used. * * Generated from protobuf field int32 train_steps = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -80,9 +80,9 @@ public function setTrainSteps($var) } /** - * Optional. The multiplier to apply to the recommended learning rate. Valid values - * are between 0.1 and 10. If not provided, recommended learning rate will - * be used. + * Optional. The multiplier to apply to the recommended learning rate. Valid + * values are between 0.1 and 10. If not provided, recommended learning rate + * will be used. * * Generated from protobuf field float learning_rate_multiplier = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return float @@ -93,9 +93,9 @@ public function getLearningRateMultiplier() } /** - * Optional. The multiplier to apply to the recommended learning rate. Valid values - * are between 0.1 and 10. If not provided, recommended learning rate will - * be used. + * Optional. The multiplier to apply to the recommended learning rate. Valid + * values are between 0.1 and 10. If not provided, recommended learning rate + * will be used. * * Generated from protobuf field float learning_rate_multiplier = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param float $var diff --git a/DocumentAi/src/V1/TrainProcessorVersionRequest/InputData.php b/DocumentAi/src/V1/TrainProcessorVersionRequest/InputData.php index 856f8daaf9ed..c82fa1453462 100644 --- a/DocumentAi/src/V1/TrainProcessorVersionRequest/InputData.php +++ b/DocumentAi/src/V1/TrainProcessorVersionRequest/InputData.php @@ -9,7 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * The input data used to train a new [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. + * The input data used to train a new + * [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. * * Generated from protobuf message google.cloud.documentai.v1.TrainProcessorVersionRequest.InputData */