You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/documentai_v1.projects.locations.processors.html
+8-2Lines changed: 8 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -151,6 +151,9 @@ <h3>Method Details</h3>
151
151
"gcsUriPrefix": "A String", # The URI prefix.
152
152
},
153
153
},
154
+
"labels": { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), 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.
155
+
"a_key": "A String",
156
+
},
154
157
"processOptions": { # Options for Process API # Inference-time options for the process API
155
158
"fromEnd": 42, # Only process certain pages from the end, same as above.
156
159
"fromStart": 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -159,7 +162,7 @@ <h3>Method Details</h3>
159
162
42,
160
163
],
161
164
},
162
-
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
165
+
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
163
166
"advancedOcrOptions": [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
164
167
"A String",
165
168
],
@@ -1332,6 +1335,9 @@ <h3>Method Details</h3>
1332
1335
],
1333
1336
"uri": "A String", # 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](https://cloud.google.com/storage/docs/reference-uris).
1334
1337
},
1338
+
"labels": { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), 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.
1339
+
"a_key": "A String",
1340
+
},
1335
1341
"processOptions": { # Options for Process API # Inference-time options for the process API
1336
1342
"fromEnd": 42, # Only process certain pages from the end, same as above.
1337
1343
"fromStart": 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -1340,7 +1346,7 @@ <h3>Method Details</h3>
1340
1346
42,
1341
1347
],
1342
1348
},
1343
-
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
1349
+
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
1344
1350
"advancedOcrOptions": [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
Copy file name to clipboardExpand all lines: docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html
+11-2Lines changed: 11 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -146,6 +146,9 @@ <h3>Method Details</h3>
146
146
"gcsUriPrefix": "A String", # The URI prefix.
147
147
},
148
148
},
149
+
"labels": { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), 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.
150
+
"a_key": "A String",
151
+
},
149
152
"processOptions": { # Options for Process API # Inference-time options for the process API
150
153
"fromEnd": 42, # Only process certain pages from the end, same as above.
151
154
"fromStart": 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -154,7 +157,7 @@ <h3>Method Details</h3>
154
157
42,
155
158
],
156
159
},
157
-
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
160
+
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
158
161
"advancedOcrOptions": [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
159
162
"A String",
160
163
],
@@ -427,6 +430,7 @@ <h3>Method Details</h3>
427
430
"evaluation": "A String", # The resource name of the evaluation.
428
431
"operation": "A String", # The resource name of the Long Running Operation for the evaluation.
429
432
},
433
+
"modelType": "A String", # Output only. The model type of this processor version.
430
434
"name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
431
435
"state": "A String", # The state of the processor version.
432
436
}</pre>
@@ -522,6 +526,7 @@ <h3>Method Details</h3>
522
526
"evaluation": "A String", # The resource name of the evaluation.
523
527
"operation": "A String", # The resource name of the Long Running Operation for the evaluation.
524
528
},
529
+
"modelType": "A String", # Output only. The model type of this processor version.
525
530
"name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
526
531
"state": "A String", # The state of the processor version.
527
532
},
@@ -1404,6 +1409,9 @@ <h3>Method Details</h3>
1404
1409
],
1405
1410
"uri": "A String", # 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](https://cloud.google.com/storage/docs/reference-uris).
1406
1411
},
1412
+
"labels": { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), 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.
1413
+
"a_key": "A String",
1414
+
},
1407
1415
"processOptions": { # Options for Process API # Inference-time options for the process API
1408
1416
"fromEnd": 42, # Only process certain pages from the end, same as above.
1409
1417
"fromStart": 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -1412,7 +1420,7 @@ <h3>Method Details</h3>
1412
1420
42,
1413
1421
],
1414
1422
},
1415
-
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
1423
+
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
1416
1424
"advancedOcrOptions": [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
1417
1425
"A String",
1418
1426
],
@@ -2448,6 +2456,7 @@ <h3>Method Details</h3>
2448
2456
"evaluation": "A String", # The resource name of the evaluation.
2449
2457
"operation": "A String", # The resource name of the Long Running Operation for the evaluation.
2450
2458
},
2459
+
"modelType": "A String", # Output only. The model type of this processor version.
2451
2460
"name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
2452
2461
"state": "A String", # The state of the processor version.
Copy file name to clipboardExpand all lines: docs/dyn/documentai_v1beta3.projects.locations.processors.html
+9-3Lines changed: 9 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -165,6 +165,9 @@ <h3>Method Details</h3>
165
165
"gcsUriPrefix": "A String", # The URI prefix.
166
166
},
167
167
},
168
+
"labels": { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), 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.
169
+
"a_key": "A String",
170
+
},
168
171
"outputConfig": { # The output configuration in the BatchProcessDocuments method. # The overall output config for batch process.
169
172
"gcsDestination": "A String", # The output Cloud Storage directory to put the processed documents.
170
173
},
@@ -176,7 +179,7 @@ <h3>Method Details</h3>
176
179
42,
177
180
],
178
181
},
179
-
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
182
+
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
180
183
"advancedOcrOptions": [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
181
184
"A String",
182
185
],
@@ -2238,6 +2241,9 @@ <h3>Method Details</h3>
2238
2241
],
2239
2242
"uri": "A String", # 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](https://cloud.google.com/storage/docs/reference-uris).
2240
2243
},
2244
+
"labels": { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), 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.
2245
+
"a_key": "A String",
2246
+
},
2241
2247
"processOptions": { # Options for Process API # Inference-time options for the process API
2242
2248
"fromEnd": 42, # Only process certain pages from the end, same as above.
2243
2249
"fromStart": 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -2246,7 +2252,7 @@ <h3>Method Details</h3>
2246
2252
42,
2247
2253
],
2248
2254
},
2249
-
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
2255
+
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
2250
2256
"advancedOcrOptions": [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
2251
2257
"A String",
2252
2258
],
@@ -3234,7 +3240,7 @@ <h3>Method Details</h3>
3234
3240
The object takes the form of:
3235
3241
3236
3242
{ # A singleton resource under a Processor which configures a collection of documents.
3237
-
"documentWarehouseConfig": { # Configuration specific to the Document AI Warehouse-based implementation. # Optional. Derepcated. Warehouse-based dataset configuration is not supported today.
3243
+
"documentWarehouseConfig": { # Configuration specific to the Document AI Warehouse-based implementation. # Optional. Deprecated. Warehouse-based dataset configuration is not supported.
3238
3244
"collection": "A String", # Output only. The collection in Document AI Warehouse associated with the dataset.
3239
3245
"schema": "A String", # Output only. The schema in Document AI Warehouse associated with the dataset.
Copy file name to clipboardExpand all lines: docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html
+13-4Lines changed: 13 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -155,6 +155,9 @@ <h3>Method Details</h3>
155
155
"gcsUriPrefix": "A String", # The URI prefix.
156
156
},
157
157
},
158
+
"labels": { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), 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.
159
+
"a_key": "A String",
160
+
},
158
161
"outputConfig": { # The output configuration in the BatchProcessDocuments method. # The overall output config for batch process.
159
162
"gcsDestination": "A String", # The output Cloud Storage directory to put the processed documents.
160
163
},
@@ -166,7 +169,7 @@ <h3>Method Details</h3>
166
169
42,
167
170
],
168
171
},
169
-
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
172
+
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
170
173
"advancedOcrOptions": [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
171
174
"A String",
172
175
],
@@ -494,6 +497,7 @@ <h3>Method Details</h3>
494
497
"evaluation": "A String", # The resource name of the evaluation.
495
498
"operation": "A String", # The resource name of the Long Running Operation for the evaluation.
496
499
},
500
+
"modelType": "A String", # Output only. The model type of this processor version.
497
501
"name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
498
502
"state": "A String", # The state of the processor version.
499
503
}</pre>
@@ -647,6 +651,7 @@ <h3>Method Details</h3>
647
651
"evaluation": "A String", # The resource name of the evaluation.
648
652
"operation": "A String", # The resource name of the Long Running Operation for the evaluation.
649
653
},
654
+
"modelType": "A String", # Output only. The model type of this processor version.
650
655
"name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
651
656
"state": "A String", # The state of the processor version.
652
657
},
@@ -2375,6 +2380,9 @@ <h3>Method Details</h3>
2375
2380
],
2376
2381
"uri": "A String", # 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](https://cloud.google.com/storage/docs/reference-uris).
2377
2382
},
2383
+
"labels": { # Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), 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.
2384
+
"a_key": "A String",
2385
+
},
2378
2386
"processOptions": { # Options for Process API # Inference-time options for the process API
2379
2387
"fromEnd": 42, # Only process certain pages from the end, same as above.
2380
2388
"fromStart": 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -2383,7 +2391,7 @@ <h3>Method Details</h3>
2383
2391
42,
2384
2392
],
2385
2393
},
2386
-
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
2394
+
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
2387
2395
"advancedOcrOptions": [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
2388
2396
"A String",
2389
2397
],
@@ -3377,8 +3385,8 @@ <h3>Method Details</h3>
3377
3385
},
3378
3386
},
3379
3387
"foundationModelTuningOptions": { # Options to control foundation model tuning of the processor. # Options to control foundation model tuning of a processor.
3380
-
"learningRateMultiplier": 3.14, # Optional. The multiplier to apply to the recommended learning rate. Valid values are between [0.1, 10]. If not provided, recommended learning rate will be used.
3381
-
"trainSteps": 42, # Optional. The number of steps to run for model tuning. Valid values are between [1, 400]. If not provided, recommended steps will be used.
3388
+
"learningRateMultiplier": 3.14, # Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used.
3389
+
"trainSteps": 42, # Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used.
3382
3390
},
3383
3391
"inputData": { # The input data used to train a new ProcessorVersion. # Optional. The input data used to train the ProcessorVersion.
3384
3392
"testDocuments": { # The common config to specify a set of documents used as input. # The documents used for testing the trained version.
@@ -3491,6 +3499,7 @@ <h3>Method Details</h3>
3491
3499
"evaluation": "A String", # The resource name of the evaluation.
3492
3500
"operation": "A String", # The resource name of the Long Running Operation for the evaluation.
3493
3501
},
3502
+
"modelType": "A String", # Output only. The model type of this processor version.
3494
3503
"name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
3495
3504
"state": "A String", # The state of the processor version.
0 commit comments