Send a document for Human Review. The input document should be processed by the specified processor.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: documentai1 --scope <scope> projects locations-processors-human-review-config-review-document ...

Required Scalar Argument

  • <human-review-config> (string)
    • Required. The resource name of the HumanReviewConfig that the document will be reviewed with.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudDocumentaiV1ReviewDocumentRequest:
  document-schema:
    description: string
    display-name: string
    metadata:
      document-allow-multiple-labels: boolean
      document-splitter: boolean
      prefixed-naming-on-properties: boolean
      skip-naming-validation: boolean
  enable-schema-validation: boolean
  inline-document:
    content: string
    error:
      code: integer
      message: string
    mime-type: string
    shard-info:
      shard-count: int64
      shard-index: string
      text-offset: string
    text: string
    uri: string
  priority: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .document-schema description=no
    • Description of the schema.
  • display-name=stet
    • Display name to show to users.
  • metadata document-allow-multiple-labels=true
    • If true, on a given page, there can be multiple document annotations covering it.
  • document-splitter=true
    • If true, a document entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
  • prefixed-naming-on-properties=false
    • If set, all the nested entities must be prefixed with the parents.

  • skip-naming-validation=false

    • If set, we will skip the naming format validation in the schema. So the string values in DocumentSchema.EntityType.name and DocumentSchema.EntityType.Property.name will not be checked.

  • ... enable-schema-validation=false

    • Whether the validation should be performed on the ad-hoc review request.
  • inline-document content=diam
    • Optional. Inline document content, represented as a stream of bytes. Note: As with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
  • error code=52
    • The status code, which should be an enum value of google.rpc.Code.

  • message=et

    • A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

  • .. mime-type=et

  • shard-info shard-count=-95
    • Total number of shards.
  • shard-index=stet
    • The 0-based index of this shard.

  • text-offset=dolor

    • The index of the first character in Document.text in the overall document global text.

  • .. text=duo

    • Optional. UTF-8 encoded text in reading order from the document.

  • uri=vero

    • Optional. Currently supports Google Cloud Storage URI of the form gs://bucket_name/object_name. Object versioning is not supported. For more information, refer to Google Cloud Storage Request URIs.

  • .. priority=vero

    • The priority of the human review task.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").