Document

google.cloud.documentai.v1beta3. Document

Represents a Document.

Constructor

new Document(propertiesopt)

Constructs a new Document.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1beta3.IDocument <optional>

Properties to set

Implements:
  • IDocument

Classes

ChunkedDocument
DocumentLayout
Entity
EntityRelation
Page
PageAnchor
Provenance
Revision
ShardInfo
Style
TextAnchor
TextChange

Members

chunkedDocument

Document chunkedDocument.

content

Document content.

documentLayout

Document documentLayout.

entities

Document entities.

entityRelations

Document entityRelations.

error

Document error.

mimeType

Document mimeType.

pages

Document pages.

revisions

Document revisions.

shardInfo

Document shardInfo.

source

Document source.

text

Document text.

textChanges

Document textChanges.

textStyles

Document textStyles.

uri

Document uri.

Methods

toJSON() → {Object.<string, *>}

Converts this Document to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.documentai.v1beta3.Document}

Creates a new Document instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1beta3.IDocument <optional>

Properties to set

Returns:
Type Description
google.cloud.documentai.v1beta3.Document

Document instance

(static) decode(reader, lengthopt) → {google.cloud.documentai.v1beta3.Document}

Decodes a Document message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.documentai.v1beta3.Document

Document

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.documentai.v1beta3.Document}

Decodes a Document message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.documentai.v1beta3.Document

Document

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Document message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta3.IDocument

Document message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Document message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta3.IDocument

Document message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.documentai.v1beta3.Document}

Creates a Document message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.documentai.v1beta3.Document

Document

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Document

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a Document message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta3.Document

Document

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Document message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not