docs: [google-cloud-documentai] updated comments (#12676)

BEGIN_COMMIT_OVERRIDE
docs: updated comments
END_COMMIT_OVERRIDE

- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 631869949

Source-Link:
googleapis/googleapis@a5dcade

Source-Link:
googleapis/googleapis-gen@697b6d8
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRvY3VtZW50YWkvLk93bEJvdC55YW1sIiwiaCI6IjY5N2I2ZDg4ZjBlYjc3YmNiYTRjYzg2NGI2YTg1MjQ0OTBkNDk5MTcifQ==

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
Co-authored-by: ohmayr <omairnaveed@ymail.com>

Author: 3 people

packages/google-cloud-documentai/google/cloud/documentai/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.27.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-cloud-documentai/google/cloud/documentai_v1/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.27.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-cloud-documentai/google/cloud/documentai_v1/services/document_processor_service/async_client.py

@@ -58,7 +58,7 @@ def __init__(
         credentials: Optional[ga_credentials.Credentials] = None,
         credentials_file: Optional[str] = None,
         scopes: Optional[Sequence[str]] = None,
-        channel: Optional[grpc.Channel] = None,
+        channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]] = None,
         api_mtls_endpoint: Optional[str] = None,
         client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None,
         ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None,
@@ -78,14 +78,17 @@ def __init__(
                 credentials identify the application to the service; if none
                 are specified, the client will attempt to ascertain the
                 credentials from the environment.
-                This argument is ignored if ``channel`` is provided.
+                This argument is ignored if a ``channel`` instance is provided.
             credentials_file (Optional[str]): A file with credentials that can
                 be loaded with :func:`google.auth.load_credentials_from_file`.
-                This argument is ignored if ``channel`` is provided.
+                This argument is ignored if a ``channel`` instance is provided.
             scopes (Optional(Sequence[str])): A list of scopes. This argument is
-                ignored if ``channel`` is provided.
-            channel (Optional[grpc.Channel]): A ``Channel`` instance through
-                which to make calls.
+                ignored if a ``channel`` instance is provided.
+            channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]):
+                A ``Channel`` instance through which to make calls, or a Callable
+                that constructs and returns one. If set to None, ``self.create_channel``
+                is used to create the channel. If a Callable is given, it will be called
+                with the same arguments as used in ``self.create_channel``.
             api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint.
                 If provided, it overrides the ``host`` argument and tries to create
                 a mutual TLS channel with client SSL credentials from
@@ -95,11 +98,11 @@ def __init__(
                 private key bytes, both in PEM format. It is ignored if
                 ``api_mtls_endpoint`` is None.
             ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials
-                for the grpc channel. It is ignored if ``channel`` is provided.
+                for the grpc channel. It is ignored if a ``channel`` instance is provided.
             client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]):
                 A callback to provide client certificate bytes and private key bytes,
                 both in PEM format. It is used to configure a mutual TLS channel. It is
-                ignored if ``channel`` or ``ssl_channel_credentials`` is provided.
+                ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided.
             quota_project_id (Optional[str]): An optional project to use for billing
                 and quota.
             client_info (google.api_core.gapic_v1.client_info.ClientInfo):
@@ -126,7 +129,7 @@ def __init__(
         if client_cert_source:
             warnings.warn("client_cert_source is deprecated", DeprecationWarning)
 
-        if channel:
+        if isinstance(channel, grpc.Channel):
             # Ignore credentials if a channel was passed.
             credentials = False
             # If a channel was explicitly provided, set it.
@@ -167,7 +170,9 @@ def __init__(
         )
 
         if not self._grpc_channel:
-            self._grpc_channel = type(self).create_channel(
+            # initialize with the provided callable or the default channel
+            channel_init = channel or type(self).create_channel
+            self._grpc_channel = channel_init(
                 self._host,
                 # use the credentials which are saved
                 credentials=self._credentials,

packages/google-cloud-documentai/google/cloud/documentai_v1/services/document_processor_service/client.py

@@ -16,7 +16,9 @@
 from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union
 import warnings
 
+from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1, grpc_helpers_async, operations_v1
+from google.api_core import retry_async as retries
 from google.auth import credentials as ga_credentials  # type: ignore
 from google.auth.transport.grpc import SslCredentials  # type: ignore
 from google.cloud.location import locations_pb2  # type: ignore
@@ -73,7 +75,6 @@ def create_channel(
                 the credentials from the environment.
             credentials_file (Optional[str]): A file with credentials that can
                 be loaded with :func:`google.auth.load_credentials_from_file`.
-                This argument is ignored if ``channel`` is provided.
             scopes (Optional[Sequence[str]]): A optional list of scopes needed for this
                 service. These are only used when credentials are not specified and
                 are passed to :func:`google.auth.default`.
@@ -103,7 +104,7 @@ def __init__(
         credentials: Optional[ga_credentials.Credentials] = None,
         credentials_file: Optional[str] = None,
         scopes: Optional[Sequence[str]] = None,
-        channel: Optional[aio.Channel] = None,
+        channel: Optional[Union[aio.Channel, Callable[..., aio.Channel]]] = None,
         api_mtls_endpoint: Optional[str] = None,
         client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None,
         ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None,
@@ -123,15 +124,18 @@ def __init__(
                 credentials identify the application to the service; if none
                 are specified, the client will attempt to ascertain the
                 credentials from the environment.
-                This argument is ignored if ``channel`` is provided.
+                This argument is ignored if a ``channel`` instance is provided.
             credentials_file (Optional[str]): A file with credentials that can
                 be loaded with :func:`google.auth.load_credentials_from_file`.
-                This argument is ignored if ``channel`` is provided.
+                This argument is ignored if a ``channel`` instance is provided.
             scopes (Optional[Sequence[str]]): A optional list of scopes needed for this
                 service. These are only used when credentials are not specified and
                 are passed to :func:`google.auth.default`.
-            channel (Optional[aio.Channel]): A ``Channel`` instance through
-                which to make calls.
+            channel (Optional[Union[aio.Channel, Callable[..., aio.Channel]]]):
+                A ``Channel`` instance through which to make calls, or a Callable
+                that constructs and returns one. If set to None, ``self.create_channel``
+                is used to create the channel. If a Callable is given, it will be called
+                with the same arguments as used in ``self.create_channel``.
             api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint.
                 If provided, it overrides the ``host`` argument and tries to create
                 a mutual TLS channel with client SSL credentials from
@@ -141,11 +145,11 @@ def __init__(
                 private key bytes, both in PEM format. It is ignored if
                 ``api_mtls_endpoint`` is None.
             ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials
-                for the grpc channel. It is ignored if ``channel`` is provided.
+                for the grpc channel. It is ignored if a ``channel`` instance is provided.
             client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]):
                 A callback to provide client certificate bytes and private key bytes,
                 both in PEM format. It is used to configure a mutual TLS channel. It is
-                ignored if ``channel`` or ``ssl_channel_credentials`` is provided.
+                ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided.
             quota_project_id (Optional[str]): An optional project to use for billing
                 and quota.
             client_info (google.api_core.gapic_v1.client_info.ClientInfo):
@@ -172,7 +176,7 @@ def __init__(
         if client_cert_source:
             warnings.warn("client_cert_source is deprecated", DeprecationWarning)
 
-        if channel:
+        if isinstance(channel, aio.Channel):
             # Ignore credentials if a channel was passed.
             credentials = False
             # If a channel was explicitly provided, set it.
@@ -212,7 +216,9 @@ def __init__(
         )
 
         if not self._grpc_channel:
-            self._grpc_channel = type(self).create_channel(
+            # initialize with the provided callable or the default channel
+            channel_init = channel or type(self).create_channel
+            self._grpc_channel = channel_init(
                 self._host,
                 # use the credentials which are saved
                 credentials=self._credentials,
@@ -915,6 +921,151 @@ def list_evaluations(
             )
         return self._stubs["list_evaluations"]
 
+    def _prep_wrapped_messages(self, client_info):
+        """Precompute the wrapped methods, overriding the base class method to use async wrappers."""
+        self._wrapped_methods = {
+            self.process_document: gapic_v1.method_async.wrap_method(
+                self.process_document,
+                default_retry=retries.AsyncRetry(
+                    initial=0.1,
+                    maximum=60.0,
+                    multiplier=1.3,
+                    predicate=retries.if_exception_type(
+                        core_exceptions.DeadlineExceeded,
+                        core_exceptions.ServiceUnavailable,
+                    ),
+                    deadline=300.0,
+                ),
+                default_timeout=300.0,
+                client_info=client_info,
+            ),
+            self.batch_process_documents: gapic_v1.method_async.wrap_method(
+                self.batch_process_documents,
+                default_retry=retries.AsyncRetry(
+                    initial=0.1,
+                    maximum=60.0,
+                    multiplier=1.3,
+                    predicate=retries.if_exception_type(
+                        core_exceptions.DeadlineExceeded,
+                        core_exceptions.ServiceUnavailable,
+                    ),
+                    deadline=120.0,
+                ),
+                default_timeout=120.0,
+                client_info=client_info,
+            ),
+            self.fetch_processor_types: gapic_v1.method_async.wrap_method(
+                self.fetch_processor_types,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.list_processor_types: gapic_v1.method_async.wrap_method(
+                self.list_processor_types,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.get_processor_type: gapic_v1.method_async.wrap_method(
+                self.get_processor_type,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.list_processors: gapic_v1.method_async.wrap_method(
+                self.list_processors,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.get_processor: gapic_v1.method_async.wrap_method(
+                self.get_processor,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.train_processor_version: gapic_v1.method_async.wrap_method(
+                self.train_processor_version,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.get_processor_version: gapic_v1.method_async.wrap_method(
+                self.get_processor_version,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.list_processor_versions: gapic_v1.method_async.wrap_method(
+                self.list_processor_versions,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.delete_processor_version: gapic_v1.method_async.wrap_method(
+                self.delete_processor_version,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.deploy_processor_version: gapic_v1.method_async.wrap_method(
+                self.deploy_processor_version,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.undeploy_processor_version: gapic_v1.method_async.wrap_method(
+                self.undeploy_processor_version,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.create_processor: gapic_v1.method_async.wrap_method(
+                self.create_processor,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.delete_processor: gapic_v1.method_async.wrap_method(
+                self.delete_processor,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.enable_processor: gapic_v1.method_async.wrap_method(
+                self.enable_processor,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.disable_processor: gapic_v1.method_async.wrap_method(
+                self.disable_processor,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.set_default_processor_version: gapic_v1.method_async.wrap_method(
+                self.set_default_processor_version,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.review_document: gapic_v1.method_async.wrap_method(
+                self.review_document,
+                default_retry=retries.AsyncRetry(
+                    initial=0.1,
+                    maximum=60.0,
+                    multiplier=1.3,
+                    predicate=retries.if_exception_type(
+                        core_exceptions.DeadlineExceeded,
+                        core_exceptions.ServiceUnavailable,
+                    ),
+                    deadline=120.0,
+                ),
+                default_timeout=120.0,
+                client_info=client_info,
+            ),
+            self.evaluate_processor_version: gapic_v1.method_async.wrap_method(
+                self.evaluate_processor_version,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.get_evaluation: gapic_v1.method_async.wrap_method(
+                self.get_evaluation,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+            self.list_evaluations: gapic_v1.method_async.wrap_method(
+                self.list_evaluations,
+                default_timeout=None,
+                client_info=client_info,
+            ),
+        }
+
     def close(self):
         return self.grpc_channel.close()
 

packages/google-cloud-documentai/google/cloud/documentai_v1/services/document_processor_service/transports/grpc.py

@@ -611,7 +611,8 @@ class StyleInfo(proto.Message):
                     pixel_font_size (float):
                         Font size in pixels, equal to *unrounded
                         [font_size][google.cloud.documentai.v1.Document.Page.Token.StyleInfo.font_size]*
-                        \* *resolution* ÷ ``72.0``.
+
+                        -  *resolution* ÷ ``72.0``.
                     letter_spacing (float):
                         Letter spacing in points.
                     font_type (str):

packages/google-cloud-documentai/google/cloud/documentai_v1/services/document_processor_service/transports/grpc_asyncio.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.27.0"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}