Skip to content

Commit 132fea0

Browse files
feat(documentai): update the api
#### documentai:v1 The following keys were added: - schemas.GoogleCloudDocumentaiV1BatchProcessRequest.properties.labels (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1ProcessRequest.properties.labels (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1ProcessorVersion.properties.modelType (Total Keys: 2) #### documentai:v1beta3 The following keys were added: - schemas.GoogleCloudDocumentaiV1beta3BatchProcessRequest.properties.labels (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1beta3ProcessRequest.properties.labels (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1beta3ProcessorVersion.properties.modelType (Total Keys: 2)
1 parent a5ce564 commit 132fea0

7 files changed

+109
-21
lines changed

docs/dyn/documentai_v1.projects.locations.processors.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,9 @@ <h3>Method Details</h3>
151151
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
152152
},
153153
},
154+
&quot;labels&quot;: { # 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+
&quot;a_key&quot;: &quot;A String&quot;,
156+
},
154157
&quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
155158
&quot;fromEnd&quot;: 42, # Only process certain pages from the end, same as above.
156159
&quot;fromStart&quot;: 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -159,7 +162,7 @@ <h3>Method Details</h3>
159162
42,
160163
],
161164
},
162-
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
165+
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
163166
&quot;advancedOcrOptions&quot;: [ # 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.
164167
&quot;A String&quot;,
165168
],
@@ -1332,6 +1335,9 @@ <h3>Method Details</h3>
13321335
],
13331336
&quot;uri&quot;: &quot;A String&quot;, # 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).
13341337
},
1338+
&quot;labels&quot;: { # 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+
&quot;a_key&quot;: &quot;A String&quot;,
1340+
},
13351341
&quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
13361342
&quot;fromEnd&quot;: 42, # Only process certain pages from the end, same as above.
13371343
&quot;fromStart&quot;: 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -1340,7 +1346,7 @@ <h3>Method Details</h3>
13401346
42,
13411347
],
13421348
},
1343-
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
1349+
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
13441350
&quot;advancedOcrOptions&quot;: [ # 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.
13451351
&quot;A String&quot;,
13461352
],

docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,9 @@ <h3>Method Details</h3>
146146
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
147147
},
148148
},
149+
&quot;labels&quot;: { # 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+
&quot;a_key&quot;: &quot;A String&quot;,
151+
},
149152
&quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
150153
&quot;fromEnd&quot;: 42, # Only process certain pages from the end, same as above.
151154
&quot;fromStart&quot;: 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -154,7 +157,7 @@ <h3>Method Details</h3>
154157
42,
155158
],
156159
},
157-
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
160+
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
158161
&quot;advancedOcrOptions&quot;: [ # 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.
159162
&quot;A String&quot;,
160163
],
@@ -427,6 +430,7 @@ <h3>Method Details</h3>
427430
&quot;evaluation&quot;: &quot;A String&quot;, # The resource name of the evaluation.
428431
&quot;operation&quot;: &quot;A String&quot;, # The resource name of the Long Running Operation for the evaluation.
429432
},
433+
&quot;modelType&quot;: &quot;A String&quot;, # Output only. The model type of this processor version.
430434
&quot;name&quot;: &quot;A String&quot;, # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
431435
&quot;state&quot;: &quot;A String&quot;, # The state of the processor version.
432436
}</pre>
@@ -522,6 +526,7 @@ <h3>Method Details</h3>
522526
&quot;evaluation&quot;: &quot;A String&quot;, # The resource name of the evaluation.
523527
&quot;operation&quot;: &quot;A String&quot;, # The resource name of the Long Running Operation for the evaluation.
524528
},
529+
&quot;modelType&quot;: &quot;A String&quot;, # Output only. The model type of this processor version.
525530
&quot;name&quot;: &quot;A String&quot;, # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
526531
&quot;state&quot;: &quot;A String&quot;, # The state of the processor version.
527532
},
@@ -1404,6 +1409,9 @@ <h3>Method Details</h3>
14041409
],
14051410
&quot;uri&quot;: &quot;A String&quot;, # 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).
14061411
},
1412+
&quot;labels&quot;: { # 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+
&quot;a_key&quot;: &quot;A String&quot;,
1414+
},
14071415
&quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
14081416
&quot;fromEnd&quot;: 42, # Only process certain pages from the end, same as above.
14091417
&quot;fromStart&quot;: 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -1412,7 +1420,7 @@ <h3>Method Details</h3>
14121420
42,
14131421
],
14141422
},
1415-
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
1423+
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
14161424
&quot;advancedOcrOptions&quot;: [ # 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.
14171425
&quot;A String&quot;,
14181426
],
@@ -2448,6 +2456,7 @@ <h3>Method Details</h3>
24482456
&quot;evaluation&quot;: &quot;A String&quot;, # The resource name of the evaluation.
24492457
&quot;operation&quot;: &quot;A String&quot;, # The resource name of the Long Running Operation for the evaluation.
24502458
},
2459+
&quot;modelType&quot;: &quot;A String&quot;, # Output only. The model type of this processor version.
24512460
&quot;name&quot;: &quot;A String&quot;, # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
24522461
&quot;state&quot;: &quot;A String&quot;, # The state of the processor version.
24532462
},

docs/dyn/documentai_v1beta3.projects.locations.processors.html

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,9 @@ <h3>Method Details</h3>
165165
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
166166
},
167167
},
168+
&quot;labels&quot;: { # 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+
&quot;a_key&quot;: &quot;A String&quot;,
170+
},
168171
&quot;outputConfig&quot;: { # The output configuration in the BatchProcessDocuments method. # The overall output config for batch process.
169172
&quot;gcsDestination&quot;: &quot;A String&quot;, # The output Cloud Storage directory to put the processed documents.
170173
},
@@ -176,7 +179,7 @@ <h3>Method Details</h3>
176179
42,
177180
],
178181
},
179-
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
182+
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
180183
&quot;advancedOcrOptions&quot;: [ # 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.
181184
&quot;A String&quot;,
182185
],
@@ -2238,6 +2241,9 @@ <h3>Method Details</h3>
22382241
],
22392242
&quot;uri&quot;: &quot;A String&quot;, # 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).
22402243
},
2244+
&quot;labels&quot;: { # 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+
&quot;a_key&quot;: &quot;A String&quot;,
2246+
},
22412247
&quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
22422248
&quot;fromEnd&quot;: 42, # Only process certain pages from the end, same as above.
22432249
&quot;fromStart&quot;: 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -2246,7 +2252,7 @@ <h3>Method Details</h3>
22462252
42,
22472253
],
22482254
},
2249-
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
2255+
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
22502256
&quot;advancedOcrOptions&quot;: [ # 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.
22512257
&quot;A String&quot;,
22522258
],
@@ -3234,7 +3240,7 @@ <h3>Method Details</h3>
32343240
The object takes the form of:
32353241

32363242
{ # A singleton resource under a Processor which configures a collection of documents.
3237-
&quot;documentWarehouseConfig&quot;: { # Configuration specific to the Document AI Warehouse-based implementation. # Optional. Derepcated. Warehouse-based dataset configuration is not supported today.
3243+
&quot;documentWarehouseConfig&quot;: { # Configuration specific to the Document AI Warehouse-based implementation. # Optional. Deprecated. Warehouse-based dataset configuration is not supported.
32383244
&quot;collection&quot;: &quot;A String&quot;, # Output only. The collection in Document AI Warehouse associated with the dataset.
32393245
&quot;schema&quot;: &quot;A String&quot;, # Output only. The schema in Document AI Warehouse associated with the dataset.
32403246
},

docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,9 @@ <h3>Method Details</h3>
155155
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
156156
},
157157
},
158+
&quot;labels&quot;: { # 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+
&quot;a_key&quot;: &quot;A String&quot;,
160+
},
158161
&quot;outputConfig&quot;: { # The output configuration in the BatchProcessDocuments method. # The overall output config for batch process.
159162
&quot;gcsDestination&quot;: &quot;A String&quot;, # The output Cloud Storage directory to put the processed documents.
160163
},
@@ -166,7 +169,7 @@ <h3>Method Details</h3>
166169
42,
167170
],
168171
},
169-
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
172+
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
170173
&quot;advancedOcrOptions&quot;: [ # 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.
171174
&quot;A String&quot;,
172175
],
@@ -494,6 +497,7 @@ <h3>Method Details</h3>
494497
&quot;evaluation&quot;: &quot;A String&quot;, # The resource name of the evaluation.
495498
&quot;operation&quot;: &quot;A String&quot;, # The resource name of the Long Running Operation for the evaluation.
496499
},
500+
&quot;modelType&quot;: &quot;A String&quot;, # Output only. The model type of this processor version.
497501
&quot;name&quot;: &quot;A String&quot;, # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
498502
&quot;state&quot;: &quot;A String&quot;, # The state of the processor version.
499503
}</pre>
@@ -647,6 +651,7 @@ <h3>Method Details</h3>
647651
&quot;evaluation&quot;: &quot;A String&quot;, # The resource name of the evaluation.
648652
&quot;operation&quot;: &quot;A String&quot;, # The resource name of the Long Running Operation for the evaluation.
649653
},
654+
&quot;modelType&quot;: &quot;A String&quot;, # Output only. The model type of this processor version.
650655
&quot;name&quot;: &quot;A String&quot;, # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
651656
&quot;state&quot;: &quot;A String&quot;, # The state of the processor version.
652657
},
@@ -2375,6 +2380,9 @@ <h3>Method Details</h3>
23752380
],
23762381
&quot;uri&quot;: &quot;A String&quot;, # 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).
23772382
},
2383+
&quot;labels&quot;: { # 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+
&quot;a_key&quot;: &quot;A String&quot;,
2385+
},
23782386
&quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
23792387
&quot;fromEnd&quot;: 42, # Only process certain pages from the end, same as above.
23802388
&quot;fromStart&quot;: 42, # Only process certain pages from the start. Process all if the document has fewer pages.
@@ -2383,7 +2391,7 @@ <h3>Method Details</h3>
23832391
42,
23842392
],
23852393
},
2386-
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
2394+
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types.
23872395
&quot;advancedOcrOptions&quot;: [ # 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.
23882396
&quot;A String&quot;,
23892397
],
@@ -3377,8 +3385,8 @@ <h3>Method Details</h3>
33773385
},
33783386
},
33793387
&quot;foundationModelTuningOptions&quot;: { # Options to control foundation model tuning of the processor. # Options to control foundation model tuning of a processor.
3380-
&quot;learningRateMultiplier&quot;: 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-
&quot;trainSteps&quot;: 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+
&quot;learningRateMultiplier&quot;: 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+
&quot;trainSteps&quot;: 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.
33823390
},
33833391
&quot;inputData&quot;: { # The input data used to train a new ProcessorVersion. # Optional. The input data used to train the ProcessorVersion.
33843392
&quot;testDocuments&quot;: { # 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>
34913499
&quot;evaluation&quot;: &quot;A String&quot;, # The resource name of the evaluation.
34923500
&quot;operation&quot;: &quot;A String&quot;, # The resource name of the Long Running Operation for the evaluation.
34933501
},
3502+
&quot;modelType&quot;: &quot;A String&quot;, # Output only. The model type of this processor version.
34943503
&quot;name&quot;: &quot;A String&quot;, # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
34953504
&quot;state&quot;: &quot;A String&quot;, # The state of the processor version.
34963505
},

0 commit comments

Comments
 (0)