Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: updated comments #25878

Merged
merged 2 commits into from
May 13, 2024
Merged

docs: updated comments #25878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3434ed
docs: updated comments
gcf-owl-bot[bot] May 8, 2024
7df8552
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
93 changes: 59 additions & 34 deletions ...cloud-document_ai-v1/lib/google/cloud/document_ai/v1/document_processor_service/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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)
Expand All @@ -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
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down