Interface ProcessDocumentRequestOrBuilder (2.25.0)

Version 2.25.0

• 2.59.0 (latest)
• 2.58.0
• 2.57.0
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public interface ProcessDocumentRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutomlParams()

public abstract AutoMlParams getAutomlParams()

Controls AutoML model prediction behavior. AutoMlParams cannot be used together with other Params.

.google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;

Returns
Type	Description
AutoMlParams	The automlParams.

getAutomlParamsOrBuilder()

public abstract AutoMlParamsOrBuilder getAutomlParamsOrBuilder()

Controls AutoML model prediction behavior. AutoMlParams cannot be used together with other Params.

.google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;

Returns
Type	Description
AutoMlParamsOrBuilder

getDocumentType()

public abstract String getDocumentType()

Specifies a known document type for deeper structure detection. Valid values are currently "general" and "invoice". If not provided, "general"\ is used as default. If any other value is given, the request is rejected.

string document_type = 3;

Returns
Type	Description
String	The documentType.

getDocumentTypeBytes()

public abstract ByteString getDocumentTypeBytes()

Specifies a known document type for deeper structure detection. Valid values are currently "general" and "invoice". If not provided, "general"\ is used as default. If any other value is given, the request is rejected.

string document_type = 3;

Returns
Type	Description
ByteString	The bytes for documentType.

getEntityExtractionParams()

public abstract EntityExtractionParams getEntityExtractionParams()

Controls entity extraction behavior. If not specified, the system will decide reasonable defaults.

.google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;

Returns
Type	Description
EntityExtractionParams	The entityExtractionParams.

getEntityExtractionParamsOrBuilder()

public abstract EntityExtractionParamsOrBuilder getEntityExtractionParamsOrBuilder()

Controls entity extraction behavior. If not specified, the system will decide reasonable defaults.

.google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;

Returns
Type	Description
EntityExtractionParamsOrBuilder

getFormExtractionParams()

public abstract FormExtractionParams getFormExtractionParams()

Controls form extraction behavior. If not specified, the system will decide reasonable defaults.

.google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;

Returns
Type	Description
FormExtractionParams	The formExtractionParams.

getFormExtractionParamsOrBuilder()

public abstract FormExtractionParamsOrBuilder getFormExtractionParamsOrBuilder()

Controls form extraction behavior. If not specified, the system will decide reasonable defaults.

.google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;

Returns
Type	Description
FormExtractionParamsOrBuilder

getInputConfig()

public abstract InputConfig getInputConfig()

Required. Information about the input file.

.google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
InputConfig	The inputConfig.

getInputConfigOrBuilder()

public abstract InputConfigOrBuilder getInputConfigOrBuilder()

Required. Information about the input file.

.google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
InputConfigOrBuilder

getOcrParams()

public abstract OcrParams getOcrParams()

Controls OCR behavior. If not specified, the system will decide reasonable defaults.

.google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;

Returns
Type	Description
OcrParams	The ocrParams.

getOcrParamsOrBuilder()

public abstract OcrParamsOrBuilder getOcrParamsOrBuilder()

Controls OCR behavior. If not specified, the system will decide reasonable defaults.

.google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;

Returns
Type	Description
OcrParamsOrBuilder

getOutputConfig()

public abstract OutputConfig getOutputConfig()

Optional. The desired output location. This field is only needed in BatchProcessDocumentsRequest.

.google.cloud.documentai.v1beta2.OutputConfig output_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
OutputConfig	The outputConfig.

getOutputConfigOrBuilder()

public abstract OutputConfigOrBuilder getOutputConfigOrBuilder()

Optional. The desired output location. This field is only needed in BatchProcessDocumentsRequest.

.google.cloud.documentai.v1beta2.OutputConfig output_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
OutputConfigOrBuilder

getParent()

public abstract String getParent()

Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.

string parent = 9;

Returns
Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.

string parent = 9;

Returns
Type	Description
ByteString	The bytes for parent.

getTableExtractionParams()

public abstract TableExtractionParams getTableExtractionParams()

Controls table extraction behavior. If not specified, the system will decide reasonable defaults.

.google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;

Returns
Type	Description
TableExtractionParams	The tableExtractionParams.

getTableExtractionParamsOrBuilder()

public abstract TableExtractionParamsOrBuilder getTableExtractionParamsOrBuilder()

Controls table extraction behavior. If not specified, the system will decide reasonable defaults.

.google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;

Returns
Type	Description
TableExtractionParamsOrBuilder

hasAutomlParams()

public abstract boolean hasAutomlParams()

Controls AutoML model prediction behavior. AutoMlParams cannot be used together with other Params.

.google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;

Returns
Type	Description
boolean	Whether the automlParams field is set.

hasEntityExtractionParams()

public abstract boolean hasEntityExtractionParams()

Controls entity extraction behavior. If not specified, the system will decide reasonable defaults.

.google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;

Returns
Type	Description
boolean	Whether the entityExtractionParams field is set.

hasFormExtractionParams()

public abstract boolean hasFormExtractionParams()

Controls form extraction behavior. If not specified, the system will decide reasonable defaults.

.google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;

Returns
Type	Description
boolean	Whether the formExtractionParams field is set.

hasInputConfig()

public abstract boolean hasInputConfig()

Required. Information about the input file.

.google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the inputConfig field is set.

hasOcrParams()

public abstract boolean hasOcrParams()

Controls OCR behavior. If not specified, the system will decide reasonable defaults.

.google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;

Returns
Type	Description
boolean	Whether the ocrParams field is set.

hasOutputConfig()

public abstract boolean hasOutputConfig()

Optional. The desired output location. This field is only needed in BatchProcessDocumentsRequest.

.google.cloud.documentai.v1beta2.OutputConfig output_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the outputConfig field is set.

hasTableExtractionParams()

public abstract boolean hasTableExtractionParams()

Controls table extraction behavior. If not specified, the system will decide reasonable defaults.

.google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;

Returns
Type	Description
boolean	Whether the tableExtractionParams field is set.