Class ProcessRequest (2.26.0)

ProcessRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for the ProcessDocument method.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
`inline_document`	`google.cloud.documentai_v1.types.Document` An inline document proto. This field is a member of `oneof`_ `source`.
`raw_document`	`google.cloud.documentai_v1.types.RawDocument` A raw document content (bytes). This field is a member of `oneof`_ `source`.
`gcs_document`	`google.cloud.documentai_v1.types.GcsDocument` A raw document on Google Cloud Storage. This field is a member of `oneof`_ `source`.
`name`	`str` Required. The resource name of the Processor or ProcessorVersion to use for processing. If a 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}`
`skip_human_review`	`bool` Whether human review should be skipped for this request. Default to `false`.
`field_mask`	`google.protobuf.field_mask_pb2.FieldMask` Specifies which fields to include in the 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}`.
`process_options`	`google.cloud.documentai_v1.types.ProcessOptions` Inference-time options for the process API
`labels`	`MutableMapping[str, str]` Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

Class ProcessRequest (2.26.0)

Attributes

Classes

LabelsEntry