Method: googleapis.documentai.v1beta3.projects.locations.processors.processorVersions.train

Trains a new processor version. Operation metadata is returned as cloud_documentai_core.TrainProcessorVersionMetadata.

This method waits—the workflow execution is paused—until the operation is complete, fails, or times out. The default timeout value is 1800 seconds (30 minutes) and can be changed to a maximum value of 31536000 seconds (one year) for long-running operations using the connector_params field. See the Connectors reference.

The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.

The polling policy for the long-running operation can be configured. To set the connector-specific parameters (connector_params), refer to Invoke a connector call.

Arguments

Parameters
parent	string Required. The parent (project, location and processor) to create the new version for. Format: projects/{project}/locations/{location}/processors/{processor}.
location	string Location of the HTTP endpoint: us or eu. If not set, us is used by default.
body	object (GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest) 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.
OperationError	If the long-running operation finished unsuccessfully.
ResponseTypeError	If the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance of GoogleLongrunningOperation.

Subworkflow snippet

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

YAML

- train:
    call: googleapis.documentai.v1beta3.projects.locations.processors.processorVersions.train
    args:
        parent: ...
        body:
            baseProcessorVersion: ...
            documentSchema:
                description: ...
                displayName: ...
                entityTypes: ...
                metadata:
                    documentAllowMultipleLabels: ...
                    documentSplitter: ...
                    prefixedNamingOnProperties: ...
                    skipNamingValidation: ...
            inputData:
                testDocuments:
                    gcsDocuments:
                        documents: ...
                    gcsPrefix:
                        gcsUriPrefix: ...
                trainingDocuments: ...
            processorVersion:
                createTime: ...
                deprecationInfo:
                    deprecationTime: ...
                    replacementProcessorVersion: ...
                displayName: ...
                documentSchema: ...
                googleManaged: ...
                kmsKeyName: ...
                kmsKeyVersionName: ...
                name: ...
                state: ...
    result: trainResult

JSON

[
  {
    "train": {
      "call": "googleapis.documentai.v1beta3.projects.locations.processors.processorVersions.train",
      "args": {
        "parent": "...",
        "body": {
          "baseProcessorVersion": "...",
          "documentSchema": {
            "description": "...",
            "displayName": "...",
            "entityTypes": "...",
            "metadata": {
              "documentAllowMultipleLabels": "...",
              "documentSplitter": "...",
              "prefixedNamingOnProperties": "...",
              "skipNamingValidation": "..."
            }
          },
          "inputData": {
            "testDocuments": {
              "gcsDocuments": {
                "documents": "..."
              },
              "gcsPrefix": {
                "gcsUriPrefix": "..."
              }
            },
            "trainingDocuments": "..."
          },
          "processorVersion": {
            "createTime": "...",
            "deprecationInfo": {
              "deprecationTime": "...",
              "replacementProcessorVersion": "..."
            },
            "displayName": "...",
            "documentSchema": "...",
            "googleManaged": "...",
            "kmsKeyName": "...",
            "kmsKeyVersionName": "...",
            "name": "...",
            "state": "..."
          }
        }
      },
      "result": "trainResult"
    }
  }
]