Method: googleapis.documentai.v1.projects.locations.processors.process

Processes a single document.

Arguments

Parameters
name	string 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. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
location	string Location of the HTTP endpoint: us or eu. If not set, us is used by default.
body	object (GoogleCloudDocumentaiV1ProcessRequest) Required.

Raised exceptions

Exceptions
ConnectionError	In case of a network problem (such as DNS failure or refused connection).
HttpError	If the response status is >= 400 (excluding 429 and 503).
TimeoutError	If a long-running operation takes longer to finish than the specified timeout limit.
TypeError	If an operation or function receives an argument of the wrong type.
ValueError	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of GoogleCloudDocumentaiV1ProcessResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- process:
    call: googleapis.documentai.v1.projects.locations.processors.process
    args:
        name: ...
        body:
            fieldMask: ...
            inlineDocument:
                content: ...
                entities: ...
                entityRelations: ...
                error:
                    code: ...
                    details: ...
                    message: ...
                mimeType: ...
                pages: ...
                revisions: ...
                shardInfo:
                    shardCount: ...
                    shardIndex: ...
                    textOffset: ...
                text: ...
                textChanges: ...
                textStyles: ...
                uri: ...
            rawDocument:
                content: ...
                mimeType: ...
            skipHumanReview: ...
    result: processResult

JSON

[
  {
    "process": {
      "call": "googleapis.documentai.v1.projects.locations.processors.process",
      "args": {
        "name": "...",
        "body": {
          "fieldMask": "...",
          "inlineDocument": {
            "content": "...",
            "entities": "...",
            "entityRelations": "...",
            "error": {
              "code": "...",
              "details": "...",
              "message": "..."
            },
            "mimeType": "...",
            "pages": "...",
            "revisions": "...",
            "shardInfo": {
              "shardCount": "...",
              "shardIndex": "...",
              "textOffset": "..."
            },
            "text": "...",
            "textChanges": "...",
            "textStyles": "...",
            "uri": "..."
          },
          "rawDocument": {
            "content": "...",
            "mimeType": "..."
          },
          "skipHumanReview": "..."
        }
      },
      "result": "processResult"
    }
  }
]