diff --git a/google-cloud-document_ai-v1/lib/google/cloud/document_ai/v1/document_processor_service/client.rb b/google-cloud-document_ai-v1/lib/google/cloud/document_ai/v1/document_processor_service/client.rb index 6399b717504e..289185ef08c3 100644 --- a/google-cloud-document_ai-v1/lib/google/cloud/document_ai/v1/document_processor_service/client.rb +++ b/google-cloud-document_ai-v1/lib/google/cloud/document_ai/v1/document_processor_service/client.rb @@ -232,17 +232,22 @@ def initialize # @param gcs_document [::Google::Cloud::DocumentAI::V1::GcsDocument, ::Hash] # A raw document on Google Cloud Storage. # @param name [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} or + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::Processor Processor} or # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} - # to use for processing. If a {::Google::Cloud::DocumentAI::V1::Processor Processor} is specified, the server will use - # its {::Google::Cloud::DocumentAI::V1::Processor#default_processor_version default version}. Format: - # `projects/{project}/locations/{location}/processors/{processor}`, or + # to use for processing. If a + # {::Google::Cloud::DocumentAI::V1::Processor 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 skip_human_review [::Boolean] # Whether human review should be skipped for this request. Default to # `false`. # @param field_mask [::Google::Protobuf::FieldMask, ::Hash] - # Specifies which fields to include in the {::Google::Cloud::DocumentAI::V1::ProcessResponse#document ProcessResponse.document} + # Specifies which fields to include in the + # {::Google::Cloud::DocumentAI::V1::ProcessResponse#document 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}`. # @param process_options [::Google::Cloud::DocumentAI::V1::ProcessOptions, ::Hash] @@ -339,7 +344,8 @@ def process_document request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] - # Required. The resource name of {::Google::Cloud::DocumentAI::V1::Processor Processor} or + # Required. The resource name of + # {::Google::Cloud::DocumentAI::V1::Processor Processor} or # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. # Format: `projects/{project}/locations/{location}/processors/{processor}`, # or @@ -438,7 +444,8 @@ def batch_process_documents request, options = nil end ## - # Fetches processor types. Note that we don't use {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processor_types ListProcessorTypes} + # Fetches processor types. Note that we don't use + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processor_types ListProcessorTypes} # here, because it isn't paginated. # # @overload fetch_processor_types(request, options = nil) @@ -725,8 +732,8 @@ def get_processor_type request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] - # 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}` # @param page_size [::Integer] # The maximum number of processors to return. # If unspecified, at most `50` processors will be returned. @@ -914,17 +921,19 @@ def get_processor request, options = nil # @param foundation_model_tuning_options [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::FoundationModelTuningOptions, ::Hash] # Options to control foundation model tuning of a processor. # @param parent [::String] - # 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}`. # @param processor_version [::Google::Cloud::DocumentAI::V1::ProcessorVersion, ::Hash] # Required. The processor version to be created. # @param document_schema [::Google::Cloud::DocumentAI::V1::DocumentSchema, ::Hash] # Optional. The schema the processor version will be trained with. # @param input_data [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::InputData, ::Hash] - # Optional. The input data used to train the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. + # Optional. The input data used to train the + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. # @param base_processor_version [::String] - # 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}`. # # @yield [response, operation] Access the result along with the RPC operation @@ -1103,8 +1112,9 @@ def get_processor_version request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] - # 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}` # @param page_size [::Integer] # The maximum number of processor versions to return. # If unspecified, at most `10` processor versions will be returned. @@ -1463,8 +1473,9 @@ def undeploy_processor_version request, options = nil end ## - # Creates a processor from the {::Google::Cloud::DocumentAI::V1::ProcessorType ProcessorType} provided. - # The processor will be at `ENABLED` state by default after its creation. + # Creates a processor from the + # {::Google::Cloud::DocumentAI::V1::ProcessorType ProcessorType} provided. The + # processor will be at `ENABLED` state by default after its creation. # # @overload create_processor(request, options = nil) # Pass arguments to `create_processor` via a request object, either of type @@ -1482,11 +1493,14 @@ def undeploy_processor_version request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] - # 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}` # @param processor [::Google::Cloud::DocumentAI::V1::Processor, ::Hash] - # Required. The processor to be created, requires {::Google::Cloud::DocumentAI::V1::Processor#type Processor.type} and - # {::Google::Cloud::DocumentAI::V1::Processor#display_name Processor.display_name} to be set. Also, the {::Google::Cloud::DocumentAI::V1::Processor#kms_key_name Processor.kms_key_name} + # Required. The processor to be created, requires + # {::Google::Cloud::DocumentAI::V1::Processor#type Processor.type} and + # {::Google::Cloud::DocumentAI::V1::Processor#display_name Processor.display_name} + # to be set. Also, the + # {::Google::Cloud::DocumentAI::V1::Processor#kms_key_name Processor.kms_key_name} # field must be set if the processor is under CMEK. # # @yield [response, operation] Access the result along with the RPC operation @@ -1834,8 +1848,10 @@ def disable_processor request, options = nil end ## - # Set the default (active) version of a {::Google::Cloud::DocumentAI::V1::Processor Processor} that will be used in - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument} and + # Set the default (active) version of a + # {::Google::Cloud::DocumentAI::V1::Processor Processor} that will be used in + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument} + # and # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}. # # @overload set_default_processor_version(request, options = nil) @@ -1854,10 +1870,13 @@ def disable_processor request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param processor [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default version. + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default + # version. # @param default_processor_version [::String] - # Required. The resource name of child {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as default. - # Format: + # Required. The resource name of child + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as + # default. Format: # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` # # @yield [response, operation] Access the result along with the RPC operation @@ -1954,8 +1973,9 @@ def set_default_processor_version request, options = nil # @param inline_document [::Google::Cloud::DocumentAI::V1::Document, ::Hash] # An inline document proto. # @param human_review_config [::String] - # 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. # @param enable_schema_validation [::Boolean] # Whether the validation should be performed on the ad-hoc review request. # @param priority [::Google::Cloud::DocumentAI::V1::ReviewDocumentRequest::Priority] @@ -2055,11 +2075,13 @@ def review_document request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param processor_version [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to evaluate. + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to + # evaluate. # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` # @param evaluation_documents [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig, ::Hash] - # 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. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] @@ -2152,7 +2174,8 @@ def evaluate_processor_version request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Evaluation Evaluation} to get. + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::Evaluation Evaluation} to get. # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}` # # @yield [response, operation] Access the result along with the RPC operation @@ -2238,7 +2261,9 @@ def get_evaluation request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to list evaluations for. + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to list + # evaluations for. # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` # @param page_size [::Integer] # The standard list page size. diff --git a/google-cloud-document_ai-v1/lib/google/cloud/document_ai/v1/document_processor_service/rest/client.rb b/google-cloud-document_ai-v1/lib/google/cloud/document_ai/v1/document_processor_service/rest/client.rb index bc0e52fe476e..06b21b88b35e 100644 --- a/google-cloud-document_ai-v1/lib/google/cloud/document_ai/v1/document_processor_service/rest/client.rb +++ b/google-cloud-document_ai-v1/lib/google/cloud/document_ai/v1/document_processor_service/rest/client.rb @@ -226,17 +226,22 @@ def initialize # @param gcs_document [::Google::Cloud::DocumentAI::V1::GcsDocument, ::Hash] # A raw document on Google Cloud Storage. # @param name [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} or + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::Processor Processor} or # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} - # to use for processing. If a {::Google::Cloud::DocumentAI::V1::Processor Processor} is specified, the server will use - # its {::Google::Cloud::DocumentAI::V1::Processor#default_processor_version default version}. Format: - # `projects/{project}/locations/{location}/processors/{processor}`, or + # to use for processing. If a + # {::Google::Cloud::DocumentAI::V1::Processor 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 skip_human_review [::Boolean] # Whether human review should be skipped for this request. Default to # `false`. # @param field_mask [::Google::Protobuf::FieldMask, ::Hash] - # Specifies which fields to include in the {::Google::Cloud::DocumentAI::V1::ProcessResponse#document ProcessResponse.document} + # Specifies which fields to include in the + # {::Google::Cloud::DocumentAI::V1::ProcessResponse#document 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}`. # @param process_options [::Google::Cloud::DocumentAI::V1::ProcessOptions, ::Hash] @@ -326,7 +331,8 @@ def process_document request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] - # Required. The resource name of {::Google::Cloud::DocumentAI::V1::Processor Processor} or + # Required. The resource name of + # {::Google::Cloud::DocumentAI::V1::Processor Processor} or # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. # Format: `projects/{project}/locations/{location}/processors/{processor}`, # or @@ -418,7 +424,8 @@ def batch_process_documents request, options = nil end ## - # Fetches processor types. Note that we don't use {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client#list_processor_types ListProcessorTypes} + # Fetches processor types. Note that we don't use + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client#list_processor_types ListProcessorTypes} # here, because it isn't paginated. # # @overload fetch_processor_types(request, options = nil) @@ -684,8 +691,8 @@ def get_processor_type request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] - # 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}` # @param page_size [::Integer] # The maximum number of processors to return. # If unspecified, at most `50` processors will be returned. @@ -859,17 +866,19 @@ def get_processor request, options = nil # @param foundation_model_tuning_options [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::FoundationModelTuningOptions, ::Hash] # Options to control foundation model tuning of a processor. # @param parent [::String] - # 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}`. # @param processor_version [::Google::Cloud::DocumentAI::V1::ProcessorVersion, ::Hash] # Required. The processor version to be created. # @param document_schema [::Google::Cloud::DocumentAI::V1::DocumentSchema, ::Hash] # Optional. The schema the processor version will be trained with. # @param input_data [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::InputData, ::Hash] - # Optional. The input data used to train the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. + # Optional. The input data used to train the + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. # @param base_processor_version [::String] - # 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}`. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] @@ -1034,8 +1043,9 @@ def get_processor_version request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] - # 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}` # @param page_size [::Integer] # The maximum number of processor versions to return. # If unspecified, at most `10` processor versions will be returned. @@ -1366,8 +1376,9 @@ def undeploy_processor_version request, options = nil end ## - # Creates a processor from the {::Google::Cloud::DocumentAI::V1::ProcessorType ProcessorType} provided. - # The processor will be at `ENABLED` state by default after its creation. + # Creates a processor from the + # {::Google::Cloud::DocumentAI::V1::ProcessorType ProcessorType} provided. The + # processor will be at `ENABLED` state by default after its creation. # # @overload create_processor(request, options = nil) # Pass arguments to `create_processor` via a request object, either of type @@ -1385,11 +1396,14 @@ def undeploy_processor_version request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] - # 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}` # @param processor [::Google::Cloud::DocumentAI::V1::Processor, ::Hash] - # Required. The processor to be created, requires {::Google::Cloud::DocumentAI::V1::Processor#type Processor.type} and - # {::Google::Cloud::DocumentAI::V1::Processor#display_name Processor.display_name} to be set. Also, the {::Google::Cloud::DocumentAI::V1::Processor#kms_key_name Processor.kms_key_name} + # Required. The processor to be created, requires + # {::Google::Cloud::DocumentAI::V1::Processor#type Processor.type} and + # {::Google::Cloud::DocumentAI::V1::Processor#display_name Processor.display_name} + # to be set. Also, the + # {::Google::Cloud::DocumentAI::V1::Processor#kms_key_name Processor.kms_key_name} # field must be set if the processor is under CMEK. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::DocumentAI::V1::Processor] @@ -1709,8 +1723,10 @@ def disable_processor request, options = nil end ## - # Set the default (active) version of a {::Google::Cloud::DocumentAI::V1::Processor Processor} that will be used in - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client#process_document ProcessDocument} and + # Set the default (active) version of a + # {::Google::Cloud::DocumentAI::V1::Processor Processor} that will be used in + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client#process_document ProcessDocument} + # and # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Rest::Client#batch_process_documents BatchProcessDocuments}. # # @overload set_default_processor_version(request, options = nil) @@ -1729,10 +1745,13 @@ def disable_processor request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param processor [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default version. + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default + # version. # @param default_processor_version [::String] - # Required. The resource name of child {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as default. - # Format: + # Required. The resource name of child + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as + # default. Format: # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] @@ -1822,8 +1841,9 @@ def set_default_processor_version request, options = nil # @param inline_document [::Google::Cloud::DocumentAI::V1::Document, ::Hash] # An inline document proto. # @param human_review_config [::String] - # 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. # @param enable_schema_validation [::Boolean] # Whether the validation should be performed on the ad-hoc review request. # @param priority [::Google::Cloud::DocumentAI::V1::ReviewDocumentRequest::Priority] @@ -1916,11 +1936,13 @@ def review_document request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param processor_version [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to evaluate. + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to + # evaluate. # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` # @param evaluation_documents [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig, ::Hash] - # 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. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] @@ -2006,7 +2028,8 @@ def evaluate_processor_version request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Evaluation Evaluation} to get. + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::Evaluation Evaluation} to get. # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}` # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::DocumentAI::V1::Evaluation] @@ -2085,7 +2108,9 @@ def get_evaluation request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to list evaluations for. + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to list + # evaluations for. # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` # @param page_size [::Integer] # The standard list page size. diff --git a/google-cloud-document_ai-v1/lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb b/google-cloud-document_ai-v1/lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb index 232215fcb1d8..e2d2f3b8d184 100644 --- a/google-cloud-document_ai-v1/lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb +++ b/google-cloud-document_ai-v1/lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb @@ -41,7 +41,8 @@ class Service # LRO endpoint to batch process many documents. The output is written # to Cloud Storage as JSON in the [Document] format. rpc :BatchProcessDocuments, ::Google::Cloud::DocumentAI::V1::BatchProcessRequest, ::Google::Longrunning::Operation - # 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. rpc :FetchProcessorTypes, ::Google::Cloud::DocumentAI::V1::FetchProcessorTypesRequest, ::Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse # Lists the processor types that exist. @@ -67,8 +68,9 @@ class Service rpc :DeployProcessorVersion, ::Google::Cloud::DocumentAI::V1::DeployProcessorVersionRequest, ::Google::Longrunning::Operation # Undeploys the processor version. rpc :UndeployProcessorVersion, ::Google::Cloud::DocumentAI::V1::UndeployProcessorVersionRequest, ::Google::Longrunning::Operation - # 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. rpc :CreateProcessor, ::Google::Cloud::DocumentAI::V1::CreateProcessorRequest, ::Google::Cloud::DocumentAI::V1::Processor # Deletes the processor, unloads all deployed model artifacts if it was # enabled and then deletes all artifacts associated with this processor. @@ -77,8 +79,10 @@ class Service rpc :EnableProcessor, ::Google::Cloud::DocumentAI::V1::EnableProcessorRequest, ::Google::Longrunning::Operation # Disables a processor rpc :DisableProcessor, ::Google::Cloud::DocumentAI::V1::DisableProcessorRequest, ::Google::Longrunning::Operation - # 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]. rpc :SetDefaultProcessorVersion, ::Google::Cloud::DocumentAI::V1::SetDefaultProcessorVersionRequest, ::Google::Longrunning::Operation # Send a document for Human Review. The input document should be processed by diff --git a/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/document.rb b/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/document.rb index 0dec9006c96c..152ac0bdc862 100644 --- a/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/document.rb +++ b/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/document.rb @@ -52,16 +52,19 @@ module V1 # Visual page layout for the {::Google::Cloud::DocumentAI::V1::Document Document}. # @!attribute [rw] entities # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>] - # A list of entities detected on {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. For document shards, - # entities in this list may cross shard boundaries. + # A list of entities detected on + # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. For document + # shards, entities in this list may cross shard boundaries. # @!attribute [rw] entity_relations # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::EntityRelation>] - # Placeholder. Relationship among {::Google::Cloud::DocumentAI::V1::Document#entities Document.entities}. + # Placeholder. Relationship among + # {::Google::Cloud::DocumentAI::V1::Document#entities Document.entities}. # @!attribute [rw] text_changes # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::TextChange>] - # Placeholder. A list of text corrections made to {::Google::Cloud::DocumentAI::V1::Document#text 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 + # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. This is usually + # used for annotating corrections to OCR mistakes. Text changes for a given + # revision may not overlap with each other. # @!attribute [rw] shard_info # @return [::Google::Cloud::DocumentAI::V1::Document::ShardInfo] # Information about the sharding if this document is sharded part of a larger @@ -87,7 +90,8 @@ class Document # Total number of shards. # @!attribute [rw] text_offset # @return [::Integer] - # The index of the first character in {::Google::Cloud::DocumentAI::V1::Document#text Document.text} in the overall + # The index of the first character in + # {::Google::Cloud::DocumentAI::V1::Document#text Document.text} in the overall # document global text. class ShardInfo include ::Google::Protobuf::MessageExts @@ -98,7 +102,8 @@ class ShardInfo # conventions as much as possible. # @!attribute [rw] text_anchor # @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor] - # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. + # Text anchor indexing into the + # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. # @!attribute [rw] color # @return [::Google::Type::Color] # Text color. @@ -147,9 +152,11 @@ class FontSize # A page in a {::Google::Cloud::DocumentAI::V1::Document Document}. # @!attribute [rw] page_number # @return [::Integer] - # 1-based index for current {::Google::Cloud::DocumentAI::V1::Document::Page Page} in a parent {::Google::Cloud::DocumentAI::V1::Document Document}. - # Useful when a page is taken out of a {::Google::Cloud::DocumentAI::V1::Document Document} for individual - # processing. + # 1-based index for current + # {::Google::Cloud::DocumentAI::V1::Document::Page Page} in a parent + # {::Google::Cloud::DocumentAI::V1::Document Document}. Useful when a page is + # taken out of a {::Google::Cloud::DocumentAI::V1::Document Document} for + # individual processing. # @!attribute [rw] image # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Image] # Rendered image for this page. This image is preprocessed to remove any @@ -271,18 +278,23 @@ class Matrix # Visual element describing a layout unit on a page. # @!attribute [rw] text_anchor # @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor] - # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. + # Text anchor indexing into the + # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. # @!attribute [rw] confidence # @return [::Float] - # Confidence of the current {::Google::Cloud::DocumentAI::V1::Document::Page::Layout 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 + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout 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]`. # @!attribute [rw] bounding_poly # @return [::Google::Cloud::DocumentAI::V1::BoundingPoly] - # The bounding polygon for the {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}. + # The bounding polygon for the + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}. # @!attribute [rw] orientation # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout::Orientation] - # Detected orientation for the {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}. + # Detected orientation for the + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}. class Layout include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods @@ -313,7 +325,8 @@ module Orientation # common line-spacing and orientation. # @!attribute [rw] layout # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout] - # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Block Block}. + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for + # {::Google::Cloud::DocumentAI::V1::Document::Page::Block Block}. # @!attribute [rw] detected_languages # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>] # A list of detected languages together with confidence. @@ -329,7 +342,8 @@ class Block # A collection of lines that a human would perceive as a paragraph. # @!attribute [rw] layout # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout] - # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Paragraph Paragraph}. + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for + # {::Google::Cloud::DocumentAI::V1::Document::Page::Paragraph Paragraph}. # @!attribute [rw] detected_languages # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>] # A list of detected languages together with confidence. @@ -346,7 +360,8 @@ class Paragraph # Does not cross column boundaries, can be horizontal, vertical, etc. # @!attribute [rw] layout # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout] - # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Line Line}. + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for + # {::Google::Cloud::DocumentAI::V1::Document::Page::Line Line}. # @!attribute [rw] detected_languages # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>] # A list of detected languages together with confidence. @@ -362,10 +377,12 @@ class Line # A detected token. # @!attribute [rw] layout # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout] - # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}. + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for + # {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}. # @!attribute [rw] detected_break # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Token::DetectedBreak] - # Detected break at the end of a {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}. + # Detected break at the end of a + # {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}. # @!attribute [rw] detected_languages # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>] # A list of detected languages together with confidence. @@ -380,7 +397,8 @@ class Token include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods - # Detected break at the end of a {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}. + # Detected break at the end of a + # {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}. # @!attribute [rw] type # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Token::DetectedBreak::Type] # Detected break type. @@ -410,8 +428,9 @@ module Type # Font size in points (`1` point is `¹⁄₇₂` inches). # @!attribute [rw] pixel_font_size # @return [::Float] - # Font size in pixels, equal to _unrounded {::Google::Cloud::DocumentAI::V1::Document::Page::Token::StyleInfo#font_size font_size}_ * - # _resolution_ ÷ `72.0`. + # Font size in pixels, equal to _unrounded + # {::Google::Cloud::DocumentAI::V1::Document::Page::Token::StyleInfo#font_size font_size}_ + # * _resolution_ ÷ `72.0`. # @!attribute [rw] letter_spacing # @return [::Float] # Letter spacing in points. @@ -420,8 +439,9 @@ module Type # Name or style of the font. # @!attribute [rw] bold # @return [::Boolean] - # Whether the text is bold (equivalent to {::Google::Cloud::DocumentAI::V1::Document::Page::Token::StyleInfo#font_weight font_weight} is at least - # `700`). + # Whether the text is bold (equivalent to + # {::Google::Cloud::DocumentAI::V1::Document::Page::Token::StyleInfo#font_weight font_weight} + # is at least `700`). # @!attribute [rw] italic # @return [::Boolean] # Whether the text is italic. @@ -462,7 +482,8 @@ class StyleInfo # A detected symbol. # @!attribute [rw] layout # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout] - # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Symbol Symbol}. + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for + # {::Google::Cloud::DocumentAI::V1::Document::Page::Symbol Symbol}. # @!attribute [rw] detected_languages # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>] # A list of detected languages together with confidence. @@ -475,10 +496,12 @@ class Symbol # page. # @!attribute [rw] layout # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout] - # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}. + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for + # {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}. # @!attribute [rw] type # @return [::String] - # Type of the {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}. + # Type of the + # {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}. # @!attribute [rw] detected_languages # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>] # A list of detected languages together with confidence. @@ -490,7 +513,8 @@ class VisualElement # A table representation similar to HTML table structure. # @!attribute [rw] layout # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout] - # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Table Table}. + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for + # {::Google::Cloud::DocumentAI::V1::Document::Page::Table Table}. # @!attribute [rw] header_rows # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableRow>] # Header rows of the table. @@ -520,7 +544,8 @@ class TableRow # A cell representation inside the table. # @!attribute [rw] layout # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout] - # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableCell TableCell}. + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for + # {::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableCell TableCell}. # @!attribute [rw] row_span # @return [::Integer] # How many rows this cell spans. @@ -539,11 +564,13 @@ class TableCell # A form field detected on the page. # @!attribute [rw] field_name # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout] - # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} name. e.g. `Address`, `Email`, - # `Grand total`, `Phone number`, etc. + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the + # {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} name. + # e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. # @!attribute [rw] field_value # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout] - # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} value. + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the + # {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} value. # @!attribute [rw] name_detected_languages # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>] # A list of detected languages for name together with confidence. @@ -579,10 +606,12 @@ class FormField # A detected barcode. # @!attribute [rw] layout # @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout] - # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}. + # {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for + # {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}. # @!attribute [rw] barcode # @return [::Google::Cloud::DocumentAI::V1::Barcode] - # Detailed barcode information of the {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}. + # Detailed barcode information of the + # {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}. class DetectedBarcode include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods @@ -643,7 +672,8 @@ class DetectedDefect # @!attribute [rw] text_anchor # @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor] # Optional. Provenance of the entity. - # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. + # Text anchor indexing into the + # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. # @!attribute [rw] type # @return [::String] # Required. Entity type from a schema e.g. `Address`. @@ -658,28 +688,29 @@ class DetectedDefect # Optional. Confidence of detected Schema entity. Range `[0, 1]`. # @!attribute [rw] page_anchor # @return [::Google::Cloud::DocumentAI::V1::Document::PageAnchor] - # 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. # @!attribute [rw] id # @return [::String] # Optional. Canonical id. This will be a unique value in the entity list # for this document. # @!attribute [rw] normalized_value # @return [::Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue] - # 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. # @!attribute [rw] properties # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>] - # 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. # @!attribute [rw] provenance # @return [::Google::Cloud::DocumentAI::V1::Document::Provenance] # Optional. The history of this annotation. # @!attribute [rw] redacted # @return [::Boolean] - # Optional. Whether the entity will be redacted for de-identification purposes. + # Optional. Whether the entity will be redacted for de-identification + # purposes. class Entity include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods @@ -730,7 +761,8 @@ class NormalizedValue end end - # Relationship between {::Google::Cloud::DocumentAI::V1::Document::Entity Entities}. + # Relationship between + # {::Google::Cloud::DocumentAI::V1::Document::Entity Entities}. # @!attribute [rw] subject_id # @return [::String] # Subject entity id. @@ -745,10 +777,12 @@ class EntityRelation extend ::Google::Protobuf::MessageExts::ClassMethods end - # Text reference indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. + # Text reference indexing into the + # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. # @!attribute [rw] text_segments # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment>] - # The text segments from the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. + # The text segments from the + # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. # @!attribute [rw] content # @return [::String] # Contains the content of the text span so that users do @@ -758,15 +792,20 @@ class TextAnchor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods - # A text segment in the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. The indices may be out of bounds - # which indicate that the text extends into another document shard for - # large sharded documents. See {::Google::Cloud::DocumentAI::V1::Document::ShardInfo#text_offset ShardInfo.text_offset} + # A text segment in the + # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. The indices + # may be out of bounds which indicate that the text extends into another + # document shard for large sharded documents. See + # {::Google::Cloud::DocumentAI::V1::Document::ShardInfo#text_offset ShardInfo.text_offset} # @!attribute [rw] start_index # @return [::Integer] - # {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment} start UTF-8 char index in the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. + # {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment} + # start UTF-8 char index in the + # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. # @!attribute [rw] end_index # @return [::Integer] - # {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment} half open end UTF-8 char index in the + # {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment} + # half open end UTF-8 char index in the # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. class TextSegment include ::Google::Protobuf::MessageExts @@ -774,9 +813,10 @@ class TextSegment end end - # Referencing the visual context of the entity in the {::Google::Cloud::DocumentAI::V1::Document#pages 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 + # {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages}. Page anchors + # can be cross-page, consist of multiple bounding polygons and optionally + # reference specific layout element types. # @!attribute [rw] page_refs # @return [::Array<::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef>] # One or more references to visual page elements @@ -787,25 +827,31 @@ class PageAnchor # Represents a weak reference to a page element within a document. # @!attribute [rw] page # @return [::Integer] - # Required. Index into the {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages} element, for example using + # Required. Index into the + # {::Google::Cloud::DocumentAI::V1::Document#pages 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. # @!attribute [rw] layout_type # @return [::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef::LayoutType] - # 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. # @!attribute [rw] layout_id # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::String] - # Optional. Deprecated. Use {::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly} instead. + # Optional. Deprecated. Use + # {::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly} + # instead. # @!attribute [rw] bounding_poly # @return [::Google::Cloud::DocumentAI::V1::BoundingPoly] - # 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. # @!attribute [rw] confidence # @return [::Float] - # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. + # Optional. Confidence of detected page element, if applicable. Range + # `[0, 1]`. class PageRef include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods @@ -815,25 +861,38 @@ module LayoutType # Layout Unspecified. LAYOUT_TYPE_UNSPECIFIED = 0 - # References a {::Google::Cloud::DocumentAI::V1::Document::Page#blocks Page.blocks} element. + # References a + # {::Google::Cloud::DocumentAI::V1::Document::Page#blocks Page.blocks} + # element. BLOCK = 1 - # References a {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs} element. + # References a + # {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs} + # element. PARAGRAPH = 2 - # References a {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element. + # References a + # {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element. LINE = 3 - # References a {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens} element. + # References a + # {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens} + # element. TOKEN = 4 - # References a {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements} element. + # References a + # {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements} + # element. VISUAL_ELEMENT = 5 - # Refrrences a {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables} element. + # Refrrences a + # {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables} + # element. TABLE = 6 - # References a {::Google::Cloud::DocumentAI::V1::Document::Page#form_fields Page.form_fields} element. + # References a + # {::Google::Cloud::DocumentAI::V1::Document::Page#form_fields Page.form_fields} + # element. FORM_FIELD = 7 end end @@ -965,8 +1024,9 @@ class HumanReview # @!attribute [rw] text_anchor # @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor] # Provenance of the correction. - # Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. There can only be a - # single `TextAnchor.text_segments` element. If the start and + # Text anchor indexing into the + # {::Google::Cloud::DocumentAI::V1::Document#text 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. # @!attribute [rw] changed_text diff --git a/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/document_io.rb b/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/document_io.rb index 2cf7ab6a8b7c..cc6a3c8d3ae6 100644 --- a/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/document_io.rb +++ b/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/document_io.rb @@ -151,7 +151,9 @@ class ShardingConfig # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Boolean] # Turn on font identification model and return font style information. - # Deprecated, use {::Google::Cloud::DocumentAI::V1::OcrConfig::PremiumFeatures#compute_style_info PremiumFeatures.compute_style_info} instead. + # Deprecated, use + # {::Google::Cloud::DocumentAI::V1::OcrConfig::PremiumFeatures#compute_style_info PremiumFeatures.compute_style_info} + # instead. # @!attribute [rw] disable_character_boxes_detection # @return [::Boolean] # Turn off character box detector in OCR engine. Character box detection is diff --git a/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/document_processor_service.rb b/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/document_processor_service.rb index 87f2928ee80c..012b0e5d35dd 100644 --- a/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/document_processor_service.rb +++ b/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/document_processor_service.rb @@ -38,9 +38,11 @@ module V1 # Returns error if set on other processor types. # @!attribute [rw] schema_override # @return [::Google::Cloud::DocumentAI::V1::DocumentSchema] - # Optional. Override the schema of the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. Will return an Invalid - # Argument error if this field is set when the underlying - # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} doesn't support schema override. + # Optional. Override the schema of the + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. Will + # return an Invalid Argument error if this field is set when the underlying + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} doesn't + # support schema override. class ProcessOptions include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods @@ -56,7 +58,8 @@ class IndividualPageSelector end # Request message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument} + # method. # @!attribute [rw] inline_document # @return [::Google::Cloud::DocumentAI::V1::Document] # An inline document proto. @@ -68,11 +71,15 @@ class IndividualPageSelector # A raw document on Google Cloud Storage. # @!attribute [rw] name # @return [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} or + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::Processor Processor} or # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} - # to use for processing. If a {::Google::Cloud::DocumentAI::V1::Processor Processor} is specified, the server will use - # its {::Google::Cloud::DocumentAI::V1::Processor#default_processor_version default version}. Format: - # `projects/{project}/locations/{location}/processors/{processor}`, or + # to use for processing. If a + # {::Google::Cloud::DocumentAI::V1::Processor 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}` # @!attribute [rw] skip_human_review # @return [::Boolean] @@ -80,7 +87,8 @@ class IndividualPageSelector # `false`. # @!attribute [rw] field_mask # @return [::Google::Protobuf::FieldMask] - # Specifies which fields to include in the {::Google::Cloud::DocumentAI::V1::ProcessResponse#document ProcessResponse.document} + # Specifies which fields to include in the + # {::Google::Cloud::DocumentAI::V1::ProcessResponse#document 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}`. # @!attribute [rw] process_options @@ -118,9 +126,11 @@ class LabelsEntry # @!attribute [rw] human_review_operation # @return [::String] # The name of the operation triggered by the processed document. This field - # is populated only when the {::Google::Cloud::DocumentAI::V1::HumanReviewStatus#state state} is `HUMAN_REVIEW_IN_PROGRESS`. It has - # the same response type and metadata as the long-running operation returned - # by {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument}. + # is populated only when the + # {::Google::Cloud::DocumentAI::V1::HumanReviewStatus#state state} is + # `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as + # the long-running operation returned by + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument}. class HumanReviewStatus include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods @@ -142,13 +152,15 @@ module State IN_PROGRESS = 3 # Some error happened during triggering human review, see the - # {::Google::Cloud::DocumentAI::V1::HumanReviewStatus#state_message state_message} for details. + # {::Google::Cloud::DocumentAI::V1::HumanReviewStatus#state_message state_message} + # for details. ERROR = 4 end end # Response message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument} + # method. # @!attribute [rw] document # @return [::Google::Cloud::DocumentAI::V1::Document] # The document payload, will populate fields based on the processor's @@ -165,7 +177,8 @@ class ProcessResponse # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}. # @!attribute [rw] name # @return [::String] - # Required. The resource name of {::Google::Cloud::DocumentAI::V1::Processor Processor} or + # Required. The resource name of + # {::Google::Cloud::DocumentAI::V1::Processor Processor} or # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. # Format: `projects/{project}/locations/{location}/processors/{processor}`, # or @@ -241,16 +254,17 @@ class BatchProcessMetadata # The status of a each individual document in the batch process. # @!attribute [rw] input_gcs_source # @return [::String] - # The source of the document, same as the {::Google::Cloud::DocumentAI::V1::BatchProcessMetadata::IndividualProcessStatus#input_gcs_source input_gcs_source} field in the - # request when the batch process started. + # The source of the document, same as the + # {::Google::Cloud::DocumentAI::V1::BatchProcessMetadata::IndividualProcessStatus#input_gcs_source input_gcs_source} + # field in the request when the batch process started. # @!attribute [rw] status # @return [::Google::Rpc::Status] # The status processing the document. # @!attribute [rw] output_gcs_destination # @return [::String] # The Cloud Storage output destination (in the request as - # {::Google::Cloud::DocumentAI::V1::DocumentOutputConfig::GcsOutputConfig#gcs_uri DocumentOutputConfig.GcsOutputConfig.gcs_uri}) of the processed - # document if it was successful, otherwise empty. + # {::Google::Cloud::DocumentAI::V1::DocumentOutputConfig::GcsOutputConfig#gcs_uri DocumentOutputConfig.GcsOutputConfig.gcs_uri}) + # of the processed document if it was successful, otherwise empty. # @!attribute [rw] human_review_status # @return [::Google::Cloud::DocumentAI::V1::HumanReviewStatus] # The status of human review on the processed document. @@ -285,8 +299,9 @@ module State end # Request message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes} method. - # Some processor types may require the project be added to an allowlist. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes} + # method. Some processor types may require the project be added to an + # allowlist. # @!attribute [rw] parent # @return [::String] # Required. The location of processor types to list. @@ -297,7 +312,8 @@ class FetchProcessorTypesRequest end # Response message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#fetch_processor_types FetchProcessorTypes} + # method. # @!attribute [rw] processor_types # @return [::Array<::Google::Cloud::DocumentAI::V1::ProcessorType>] # The list of processor types. @@ -307,8 +323,9 @@ class FetchProcessorTypesResponse end # Request message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processor_types ListProcessorTypes} method. - # Some processor types may require the project be added to an allowlist. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processor_types ListProcessorTypes} + # method. Some processor types may require the project be added to an + # allowlist. # @!attribute [rw] parent # @return [::String] # Required. The location of processor types to list. @@ -327,7 +344,8 @@ class ListProcessorTypesRequest end # Response message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processor_types ListProcessorTypes} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processor_types ListProcessorTypes} + # method. # @!attribute [rw] processor_types # @return [::Array<::Google::Cloud::DocumentAI::V1::ProcessorType>] # The processor types. @@ -342,8 +360,8 @@ class ListProcessorTypesResponse # Request message for list all processors belongs to a project. # @!attribute [rw] parent # @return [::String] - # 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}` # @!attribute [rw] page_size # @return [::Integer] # The maximum number of processors to return. @@ -359,7 +377,8 @@ class ListProcessorsRequest end # Response message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processors ListProcessors} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#list_processors ListProcessors} + # method. # @!attribute [rw] processors # @return [::Array<::Google::Cloud::DocumentAI::V1::Processor>] # The list of processors. @@ -372,7 +391,8 @@ class ListProcessorsResponse end # Request message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor_type GetProcessorType} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor_type GetProcessorType} + # method. # @!attribute [rw] name # @return [::String] # Required. The processor type resource name. @@ -381,7 +401,8 @@ class GetProcessorTypeRequest extend ::Google::Protobuf::MessageExts::ClassMethods end - # Request message for the {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor GetProcessor} + # Request message for the + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor GetProcessor} # method. # @!attribute [rw] name # @return [::String] @@ -392,7 +413,8 @@ class GetProcessorRequest end # Request message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor_version GetProcessorVersion} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#get_processor_version GetProcessorVersion} + # method. # @!attribute [rw] name # @return [::String] # Required. The processor resource name. @@ -404,8 +426,9 @@ class GetProcessorVersionRequest # Request message for list all processor versions belongs to a processor. # @!attribute [rw] parent # @return [::String] - # 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}` # @!attribute [rw] page_size # @return [::Integer] # The maximum number of processor versions to return. @@ -517,17 +540,21 @@ class UndeployProcessorVersionMetadata end # Request message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#create_processor CreateProcessor} method. Notice - # this request is sent to a regionalized backend service. If the - # {::Google::Cloud::DocumentAI::V1::ProcessorType ProcessorType} isn't available in that region, the creation fails. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#create_processor CreateProcessor} + # method. Notice this request is sent to a regionalized backend service. If the + # {::Google::Cloud::DocumentAI::V1::ProcessorType ProcessorType} isn't available in + # that region, the creation fails. # @!attribute [rw] parent # @return [::String] - # 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}` # @!attribute [rw] processor # @return [::Google::Cloud::DocumentAI::V1::Processor] - # Required. The processor to be created, requires {::Google::Cloud::DocumentAI::V1::Processor#type Processor.type} and - # {::Google::Cloud::DocumentAI::V1::Processor#display_name Processor.display_name} to be set. Also, the {::Google::Cloud::DocumentAI::V1::Processor#kms_key_name Processor.kms_key_name} + # Required. The processor to be created, requires + # {::Google::Cloud::DocumentAI::V1::Processor#type Processor.type} and + # {::Google::Cloud::DocumentAI::V1::Processor#display_name Processor.display_name} + # to be set. Also, the + # {::Google::Cloud::DocumentAI::V1::Processor#kms_key_name Processor.kms_key_name} # field must be set if the processor is under CMEK. class CreateProcessorRequest include ::Google::Protobuf::MessageExts @@ -535,7 +562,8 @@ class CreateProcessorRequest end # Request message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#delete_processor DeleteProcessor} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#delete_processor DeleteProcessor} + # method. # @!attribute [rw] name # @return [::String] # Required. The processor resource name to be deleted. @@ -545,7 +573,8 @@ class DeleteProcessorRequest end # The long-running operation metadata for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#delete_processor DeleteProcessor} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#delete_processor DeleteProcessor} + # method. # @!attribute [rw] common_metadata # @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata] # The basic metadata of the long-running operation. @@ -555,7 +584,8 @@ class DeleteProcessorMetadata end # Request message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor} + # method. # @!attribute [rw] name # @return [::String] # Required. The processor resource name to be enabled. @@ -565,15 +595,16 @@ class EnableProcessorRequest end # Response message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor} method. - # Intentionally empty proto for adding fields in future. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor} + # method. Intentionally empty proto for adding fields in future. class EnableProcessorResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The long-running operation metadata for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#enable_processor EnableProcessor} + # method. # @!attribute [rw] common_metadata # @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata] # The basic metadata of the long-running operation. @@ -583,7 +614,8 @@ class EnableProcessorMetadata end # Request message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor} + # method. # @!attribute [rw] name # @return [::String] # Required. The processor resource name to be disabled. @@ -593,15 +625,16 @@ class DisableProcessorRequest end # Response message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor} method. - # Intentionally empty proto for adding fields in future. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor} + # method. Intentionally empty proto for adding fields in future. class DisableProcessorResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The long-running operation metadata for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#disable_processor DisableProcessor} + # method. # @!attribute [rw] common_metadata # @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata] # The basic metadata of the long-running operation. @@ -615,11 +648,14 @@ class DisableProcessorMetadata # method. # @!attribute [rw] processor # @return [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default version. + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default + # version. # @!attribute [rw] default_processor_version # @return [::String] - # Required. The resource name of child {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as default. - # Format: + # Required. The resource name of child + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as + # default. Format: # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` class SetDefaultProcessorVersionRequest include ::Google::Protobuf::MessageExts @@ -656,8 +692,9 @@ class SetDefaultProcessorVersionMetadata # Options to control foundation model tuning of a processor. # @!attribute [rw] parent # @return [::String] - # 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}`. # @!attribute [rw] processor_version # @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion] # Required. The processor version to be created. @@ -666,17 +703,19 @@ class SetDefaultProcessorVersionMetadata # Optional. The schema the processor version will be trained with. # @!attribute [rw] input_data # @return [::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::InputData] - # Optional. The input data used to train the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. + # Optional. The input data used to train the + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. # @!attribute [rw] base_processor_version # @return [::String] - # 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}`. class TrainProcessorVersionRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods - # The input data used to train a new {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. + # The input data used to train a new + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. # @!attribute [rw] training_documents # @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig] # The documents used for training the new version. @@ -711,13 +750,13 @@ module TrainingMethod # Options to control foundation model tuning of the processor. # @!attribute [rw] train_steps # @return [::Integer] - # 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. # @!attribute [rw] learning_rate_multiplier # @return [::Float] - # 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. class FoundationModelTuningOptions include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods @@ -773,14 +812,16 @@ class DatasetValidation end # Request message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument} + # method. # @!attribute [rw] inline_document # @return [::Google::Cloud::DocumentAI::V1::Document] # An inline document proto. # @!attribute [rw] human_review_config # @return [::String] - # 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. # @!attribute [rw] enable_schema_validation # @return [::Boolean] # Whether the validation should be performed on the ad-hoc review request. @@ -806,7 +847,8 @@ module Priority end # Response message for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument} + # method. # @!attribute [rw] gcs_destination # @return [::String] # The Cloud Storage uri for the human reviewed document if the review is @@ -835,7 +877,8 @@ module State end # The long-running operation metadata for the - # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument} method. + # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#review_document ReviewDocument} + # method. # @!attribute [rw] common_metadata # @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata] # The basic metadata of the long-running operation. @@ -847,15 +890,19 @@ class ReviewDocumentOperationMetadata extend ::Google::Protobuf::MessageExts::ClassMethods end - # Evaluates the given {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} against the supplied documents. + # Evaluates the given + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} against the + # supplied documents. # @!attribute [rw] processor_version # @return [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to evaluate. + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to + # evaluate. # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` # @!attribute [rw] evaluation_documents # @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig] - # 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. class EvaluateProcessorVersionRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods @@ -886,17 +933,21 @@ class EvaluateProcessorVersionResponse # Retrieves a specific Evaluation. # @!attribute [rw] name # @return [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Evaluation Evaluation} to get. + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::Evaluation Evaluation} to get. # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}` class GetEvaluationRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Retrieves a list of evaluations for a given {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. + # Retrieves a list of evaluations for a given + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}. # @!attribute [rw] parent # @return [::String] - # Required. The resource name of the {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to list evaluations for. + # Required. The resource name of the + # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to list + # evaluations for. # `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` # @!attribute [rw] page_size # @return [::Integer] diff --git a/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/processor.rb b/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/processor.rb index 6a4da90f28e9..01478fdfb726 100644 --- a/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/processor.rb +++ b/google-cloud-document_ai-v1/proto_docs/google/cloud/documentai/v1/processor.rb @@ -156,7 +156,8 @@ class ProcessorVersionAlias # Output only. The processor version aliases. # @!attribute [r] process_endpoint # @return [::String] - # 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. # @!attribute [rw] create_time # @return [::Google::Protobuf::Timestamp] # The time the processor was created.