Console
    Contact Us Start free

    Google Cloud Document Ai V1 Client - Class ProcessRequest (2.2.2)

    Reference documentation and code samples for the Google Cloud Document Ai V1 Client class ProcessRequest.

    Request message for the ProcessDocument method.

    Generated from protobuf message google.cloud.documentai.v1.ProcessRequest

    Namespace

    Google \ Cloud \ DocumentAI \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ inline_document
    Document

    An inline document proto.

    ↳ raw_document
    RawDocument

    A raw document content (bytes).

    ↳ gcs_document
    GcsDocument

    A raw document on Google Cloud Storage.

    ↳ 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}

    ↳ skip_human_review
    bool

    Whether human review should be skipped for this request. Default to false .

    ↳ field_mask
    Google\Protobuf\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
    ProcessOptions

    Inference-time options for the process API

    ↳ labels
    array| Google\Protobuf\Internal\MapField

    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.

    ↳ imageless_mode
    bool

    Optional. Option to remove images from the document.

    getInlineDocument

    An inline document proto.

    Returns
    Type
    Description
    Document |null

    hasInlineDocument

    setInlineDocument

    An inline document proto.

    Parameter
    Name
    Description
    var
    Document
    Returns
    Type
    Description
    $this

    getRawDocument

    A raw document content (bytes).

    Returns
    Type
    Description
    RawDocument |null

    hasRawDocument

    setRawDocument

    A raw document content (bytes).

    Parameter
    Name
    Description
    var
    RawDocument
    Returns
    Type
    Description
    $this

    getGcsDocument

    A raw document on Google Cloud Storage.

    Returns
    Type
    Description
    GcsDocument |null

    hasGcsDocument

    setGcsDocument

    A raw document on Google Cloud Storage.

    Parameter
    Name
    Description
    var
    GcsDocument
    Returns
    Type
    Description
    $this

    getName

    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}

    Returns
    Type
    Description
    string

    setName

    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}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getSkipHumanReview

    Whether human review should be skipped for this request. Default to false .

    Returns
    Type
    Description
    bool

    setSkipHumanReview

    Whether human review should be skipped for this request. Default to false .

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getFieldMask

    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} .

    Returns
    Type
    Description
    Google\Protobuf\FieldMask |null

    hasFieldMask

    clearFieldMask

    setFieldMask

    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} .

    Parameter
    Name
    Description
    var
    Google\Protobuf\FieldMask
    Returns
    Type
    Description
    $this

    getProcessOptions

    Inference-time options for the process API

    Returns
    Type
    Description
    ProcessOptions |null

    hasProcessOptions

    clearProcessOptions

    setProcessOptions

    Inference-time options for the process API

    Parameter
    Name
    Description
    var
    ProcessOptions
    Returns
    Type
    Description
    $this

    getLabels

    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.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    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.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getImagelessMode

    Optional. Option to remove images from the document.

    Returns
    Type
    Description
    bool

    setImagelessMode

    Optional. Option to remove images from the document.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getSource

    Returns
    Type
    Description
    string

    static::build

    Parameter
    Name
    Description
    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}

    Returns
    Type
    Description
    ProcessRequest
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: