Represents an OcrConfig.
Package
@google-cloud/documentaiConstructors
(constructor)(properties)
constructor(properties?: google.cloud.documentai.v1.IOcrConfig);Constructs a new OcrConfig.
| Parameter | |
|---|---|
| Name | Description |
properties |
IOcrConfig
Properties to set |
Properties
advancedOcrOptions
public advancedOcrOptions: string[];OcrConfig advancedOcrOptions.
computeStyleInfo
public computeStyleInfo: boolean;OcrConfig computeStyleInfo.
disableCharacterBoxesDetection
public disableCharacterBoxesDetection: boolean;OcrConfig disableCharacterBoxesDetection.
enableImageQualityScores
public enableImageQualityScores: boolean;OcrConfig enableImageQualityScores.
enableNativePdfParsing
public enableNativePdfParsing: boolean;OcrConfig enableNativePdfParsing.
enableSymbol
public enableSymbol: boolean;OcrConfig enableSymbol.
hints
public hints?: (google.cloud.documentai.v1.OcrConfig.IHints|null);OcrConfig hints.
premiumFeatures
public premiumFeatures?: (google.cloud.documentai.v1.OcrConfig.IPremiumFeatures|null);OcrConfig premiumFeatures.
Methods
create(properties)
public static create(properties?: google.cloud.documentai.v1.IOcrConfig): google.cloud.documentai.v1.OcrConfig;Creates a new OcrConfig instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IOcrConfig
Properties to set |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | OcrConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1.OcrConfig;Decodes an OcrConfig message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | OcrConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1.OcrConfig;Decodes an OcrConfig message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | OcrConfig |
encode(message, writer)
public static encode(message: google.cloud.documentai.v1.IOcrConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified OcrConfig message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IOcrConfig
OcrConfig message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.documentai.v1.IOcrConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified OcrConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IOcrConfig
OcrConfig message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.documentai.v1.OcrConfig;Creates an OcrConfig message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | OcrConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for OcrConfig
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this OcrConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.documentai.v1.OcrConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an OcrConfig message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
OcrConfig
OcrConfig |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an OcrConfig message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|