Skip to content

Commit f03ceed

Browse files
feat(documentai): update the api
#### documentai:v1 The following keys were added: - schemas.GoogleCloudDocumentaiV1BatchDocumentsInputConfig.properties.rawDocuments.$ref (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1ProcessorVersion.properties.googleManaged.readOnly (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1RawDocuments (Total Keys: 4) #### documentai:v1beta3 The following keys were added: - schemas.GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig.properties.rawDocuments.$ref (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta3ProcessorVersion.properties.googleManaged.readOnly (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta3RawDocuments (Total Keys: 4)
1 parent 028172c commit f03ceed

8 files changed

+137
-11
lines changed

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,14 @@ <h3>Method Details</h3>
150150
&quot;gcsPrefix&quot;: { # Specifies all documents on Cloud Storage with a common prefix. # The set of documents that match the specified Cloud Storage `gcs_prefix`.
151151
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
152152
},
153+
&quot;rawDocuments&quot;: { # Specifies a set of raw documents. # The set of documents specified inline.
154+
&quot;documents&quot;: [ # Specifies raw document content and mime type.
155+
{ # Payload message of raw document content (bytes).
156+
&quot;content&quot;: &quot;A String&quot;, # Inline document content.
157+
&quot;mimeType&quot;: &quot;A String&quot;, # An IANA MIME type (RFC6838) indicating the nature and format of the content.
158+
},
159+
],
160+
},
153161
},
154162
&quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
155163
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.

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

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,14 @@ <h3>Method Details</h3>
145145
&quot;gcsPrefix&quot;: { # Specifies all documents on Cloud Storage with a common prefix. # The set of documents that match the specified Cloud Storage `gcs_prefix`.
146146
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
147147
},
148+
&quot;rawDocuments&quot;: { # Specifies a set of raw documents. # The set of documents specified inline.
149+
&quot;documents&quot;: [ # Specifies raw document content and mime type.
150+
{ # Payload message of raw document content (bytes).
151+
&quot;content&quot;: &quot;A String&quot;, # Inline document content.
152+
&quot;mimeType&quot;: &quot;A String&quot;, # An IANA MIME type (RFC6838) indicating the nature and format of the content.
153+
},
154+
],
155+
},
148156
},
149157
&quot;processOptions&quot;: { # Options for Process API # Inference-time options for the process API
150158
&quot;ocrConfig&quot;: { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
@@ -297,6 +305,14 @@ <h3>Method Details</h3>
297305
&quot;gcsPrefix&quot;: { # Specifies all documents on Cloud Storage with a common prefix. # The set of documents that match the specified Cloud Storage `gcs_prefix`.
298306
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
299307
},
308+
&quot;rawDocuments&quot;: { # Specifies a set of raw documents. # The set of documents specified inline.
309+
&quot;documents&quot;: [ # Specifies raw document content and mime type.
310+
{ # Payload message of raw document content (bytes).
311+
&quot;content&quot;: &quot;A String&quot;, # Inline document content.
312+
&quot;mimeType&quot;: &quot;A String&quot;, # An IANA MIME type (RFC6838) indicating the nature and format of the content.
313+
},
314+
],
315+
},
300316
},
301317
}
302318

@@ -381,7 +397,7 @@ <h3>Method Details</h3>
381397
&quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
382398
},
383399
},
384-
&quot;googleManaged&quot;: True or False, # Denotes that this `ProcessorVersion` is managed by Google.
400+
&quot;googleManaged&quot;: True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
385401
&quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
386402
&quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.
387403
&quot;latestEvaluation&quot;: { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version.
@@ -476,7 +492,7 @@ <h3>Method Details</h3>
476492
&quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
477493
},
478494
},
479-
&quot;googleManaged&quot;: True or False, # Denotes that this `ProcessorVersion` is managed by Google.
495+
&quot;googleManaged&quot;: True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
480496
&quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
481497
&quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.
482498
&quot;latestEvaluation&quot;: { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version.
@@ -2335,6 +2351,14 @@ <h3>Method Details</h3>
23352351
&quot;gcsPrefix&quot;: { # Specifies all documents on Cloud Storage with a common prefix. # The set of documents that match the specified Cloud Storage `gcs_prefix`.
23362352
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
23372353
},
2354+
&quot;rawDocuments&quot;: { # Specifies a set of raw documents. # The set of documents specified inline.
2355+
&quot;documents&quot;: [ # Specifies raw document content and mime type.
2356+
{ # Payload message of raw document content (bytes).
2357+
&quot;content&quot;: &quot;A String&quot;, # Inline document content.
2358+
&quot;mimeType&quot;: &quot;A String&quot;, # An IANA MIME type (RFC6838) indicating the nature and format of the content.
2359+
},
2360+
],
2361+
},
23382362
},
23392363
&quot;trainingDocuments&quot;: { # The common config to specify a set of documents used as input. # The documents used for training the new version.
23402364
&quot;gcsDocuments&quot;: { # Specifies a set of documents on Cloud Storage. # The set of documents individually specified on Cloud Storage.
@@ -2348,6 +2372,14 @@ <h3>Method Details</h3>
23482372
&quot;gcsPrefix&quot;: { # Specifies all documents on Cloud Storage with a common prefix. # The set of documents that match the specified Cloud Storage `gcs_prefix`.
23492373
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
23502374
},
2375+
&quot;rawDocuments&quot;: { # Specifies a set of raw documents. # The set of documents specified inline.
2376+
&quot;documents&quot;: [ # Specifies raw document content and mime type.
2377+
{ # Payload message of raw document content (bytes).
2378+
&quot;content&quot;: &quot;A String&quot;, # Inline document content.
2379+
&quot;mimeType&quot;: &quot;A String&quot;, # An IANA MIME type (RFC6838) indicating the nature and format of the content.
2380+
},
2381+
],
2382+
},
23512383
},
23522384
},
23532385
&quot;processorVersion&quot;: { # A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version. # Required. The processor version to be created.
@@ -2388,7 +2420,7 @@ <h3>Method Details</h3>
23882420
&quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
23892421
},
23902422
},
2391-
&quot;googleManaged&quot;: True or False, # Denotes that this `ProcessorVersion` is managed by Google.
2423+
&quot;googleManaged&quot;: True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
23922424
&quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
23932425
&quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.
23942426
&quot;latestEvaluation&quot;: { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version.

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1122,6 +1122,14 @@ <h3>Method Details</h3>
11221122
&quot;gcsPrefix&quot;: { # Specifies all documents on Cloud Storage with a common prefix. # The set of documents that match the specified Cloud Storage `gcs_prefix`.
11231123
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
11241124
},
1125+
&quot;rawDocuments&quot;: { # Specifies a set of raw documents. # The set of documents specified inline.
1126+
&quot;documents&quot;: [ # Specifies raw document content and mime type.
1127+
{ # Payload message of raw document content (bytes).
1128+
&quot;content&quot;: &quot;A String&quot;, # Inline document content.
1129+
&quot;mimeType&quot;: &quot;A String&quot;, # An IANA MIME type (RFC6838) indicating the nature and format of the content.
1130+
},
1131+
],
1132+
},
11251133
},
11261134
&quot;datasetSplit&quot;: &quot;A String&quot;, # Target dataset split where the documents must be stored.
11271135
},

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,14 @@ <h3>Method Details</h3>
164164
&quot;gcsPrefix&quot;: { # Specifies all documents on Cloud Storage with a common prefix. # The set of documents that match the specified Cloud Storage `gcs_prefix`.
165165
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
166166
},
167+
&quot;rawDocuments&quot;: { # Specifies a set of raw documents. # The set of documents specified inline.
168+
&quot;documents&quot;: [ # Specifies raw document content and mime type.
169+
{ # Payload message of raw document content (bytes).
170+
&quot;content&quot;: &quot;A String&quot;, # Inline document content.
171+
&quot;mimeType&quot;: &quot;A String&quot;, # An IANA MIME type (RFC6838) indicating the nature and format of the content.
172+
},
173+
],
174+
},
167175
},
168176
&quot;outputConfig&quot;: { # The output configuration in the BatchProcessDocuments method. # The overall output config for batch process.
169177
&quot;gcsDestination&quot;: &quot;A String&quot;, # The output Cloud Storage directory to put the processed documents.

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

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,14 @@ <h3>Method Details</h3>
154154
&quot;gcsPrefix&quot;: { # Specifies all documents on Cloud Storage with a common prefix. # The set of documents that match the specified Cloud Storage `gcs_prefix`.
155155
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
156156
},
157+
&quot;rawDocuments&quot;: { # Specifies a set of raw documents. # The set of documents specified inline.
158+
&quot;documents&quot;: [ # Specifies raw document content and mime type.
159+
{ # Payload message of raw document content (bytes).
160+
&quot;content&quot;: &quot;A String&quot;, # Inline document content.
161+
&quot;mimeType&quot;: &quot;A String&quot;, # An IANA MIME type (RFC6838) indicating the nature and format of the content.
162+
},
163+
],
164+
},
157165
},
158166
&quot;outputConfig&quot;: { # The output configuration in the BatchProcessDocuments method. # The overall output config for batch process.
159167
&quot;gcsDestination&quot;: &quot;A String&quot;, # The output Cloud Storage directory to put the processed documents.
@@ -309,6 +317,14 @@ <h3>Method Details</h3>
309317
&quot;gcsPrefix&quot;: { # Specifies all documents on Cloud Storage with a common prefix. # The set of documents that match the specified Cloud Storage `gcs_prefix`.
310318
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
311319
},
320+
&quot;rawDocuments&quot;: { # Specifies a set of raw documents. # The set of documents specified inline.
321+
&quot;documents&quot;: [ # Specifies raw document content and mime type.
322+
{ # Payload message of raw document content (bytes).
323+
&quot;content&quot;: &quot;A String&quot;, # Inline document content.
324+
&quot;mimeType&quot;: &quot;A String&quot;, # An IANA MIME type (RFC6838) indicating the nature and format of the content.
325+
},
326+
],
327+
},
312328
},
313329
}
314330

@@ -399,7 +415,7 @@ <h3>Method Details</h3>
399415
&quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
400416
},
401417
},
402-
&quot;googleManaged&quot;: True or False, # Denotes that this `ProcessorVersion` is managed by Google.
418+
&quot;googleManaged&quot;: True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
403419
&quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
404420
&quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.
405421
&quot;latestEvaluation&quot;: { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version.
@@ -542,7 +558,7 @@ <h3>Method Details</h3>
542558
&quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
543559
},
544560
},
545-
&quot;googleManaged&quot;: True or False, # Denotes that this `ProcessorVersion` is managed by Google.
561+
&quot;googleManaged&quot;: True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
546562
&quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
547563
&quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.
548564
&quot;latestEvaluation&quot;: { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version.
@@ -3254,6 +3270,14 @@ <h3>Method Details</h3>
32543270
&quot;gcsPrefix&quot;: { # Specifies all documents on Cloud Storage with a common prefix. # The set of documents that match the specified Cloud Storage `gcs_prefix`.
32553271
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
32563272
},
3273+
&quot;rawDocuments&quot;: { # Specifies a set of raw documents. # The set of documents specified inline.
3274+
&quot;documents&quot;: [ # Specifies raw document content and mime type.
3275+
{ # Payload message of raw document content (bytes).
3276+
&quot;content&quot;: &quot;A String&quot;, # Inline document content.
3277+
&quot;mimeType&quot;: &quot;A String&quot;, # An IANA MIME type (RFC6838) indicating the nature and format of the content.
3278+
},
3279+
],
3280+
},
32573281
},
32583282
&quot;trainingDocuments&quot;: { # The common config to specify a set of documents used as input. # The documents used for training the new version.
32593283
&quot;gcsDocuments&quot;: { # Specifies a set of documents on Cloud Storage. # The set of documents individually specified on Cloud Storage.
@@ -3267,6 +3291,14 @@ <h3>Method Details</h3>
32673291
&quot;gcsPrefix&quot;: { # Specifies all documents on Cloud Storage with a common prefix. # The set of documents that match the specified Cloud Storage `gcs_prefix`.
32683292
&quot;gcsUriPrefix&quot;: &quot;A String&quot;, # The URI prefix.
32693293
},
3294+
&quot;rawDocuments&quot;: { # Specifies a set of raw documents. # The set of documents specified inline.
3295+
&quot;documents&quot;: [ # Specifies raw document content and mime type.
3296+
{ # Payload message of raw document content (bytes).
3297+
&quot;content&quot;: &quot;A String&quot;, # Inline document content.
3298+
&quot;mimeType&quot;: &quot;A String&quot;, # An IANA MIME type (RFC6838) indicating the nature and format of the content.
3299+
},
3300+
],
3301+
},
32703302
},
32713303
},
32723304
&quot;processorVersion&quot;: { # A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version. # Required. The processor version to be created.
@@ -3313,7 +3345,7 @@ <h3>Method Details</h3>
33133345
&quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
33143346
},
33153347
},
3316-
&quot;googleManaged&quot;: True or False, # Denotes that this `ProcessorVersion` is managed by Google.
3348+
&quot;googleManaged&quot;: True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
33173349
&quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
33183350
&quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.
33193351
&quot;latestEvaluation&quot;: { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version.

googleapiclient/discovery_cache/documents/documentai.v1.json

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1042,7 +1042,7 @@
10421042
}
10431043
}
10441044
},
1045-
"revision": "20230714",
1045+
"revision": "20230719",
10461046
"rootUrl": "https://documentai.googleapis.com/",
10471047
"schemas": {
10481048
"GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": {
@@ -1928,6 +1928,10 @@
19281928
"gcsPrefix": {
19291929
"$ref": "GoogleCloudDocumentaiV1GcsPrefix",
19301930
"description": "The set of documents that match the specified Cloud Storage `gcs_prefix`."
1931+
},
1932+
"rawDocuments": {
1933+
"$ref": "GoogleCloudDocumentaiV1RawDocuments",
1934+
"description": "The set of documents specified inline."
19311935
}
19321936
},
19331937
"type": "object"
@@ -4237,7 +4241,8 @@
42374241
"description": "The schema of the processor version. Describes the output."
42384242
},
42394243
"googleManaged": {
4240-
"description": "Denotes that this `ProcessorVersion` is managed by Google.",
4244+
"description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.",
4245+
"readOnly": true,
42414246
"type": "boolean"
42424247
},
42434248
"kmsKeyName": {
@@ -4317,6 +4322,20 @@
43174322
},
43184323
"type": "object"
43194324
},
4325+
"GoogleCloudDocumentaiV1RawDocuments": {
4326+
"description": "Specifies a set of raw documents.",
4327+
"id": "GoogleCloudDocumentaiV1RawDocuments",
4328+
"properties": {
4329+
"documents": {
4330+
"description": "Specifies raw document content and mime type.",
4331+
"items": {
4332+
"$ref": "GoogleCloudDocumentaiV1RawDocument"
4333+
},
4334+
"type": "array"
4335+
}
4336+
},
4337+
"type": "object"
4338+
},
43204339
"GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata": {
43214340
"description": "The long-running operation metadata for the ReviewDocument method.",
43224341
"id": "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata",

googleapiclient/discovery_cache/documents/documentai.v1beta2.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@
292292
}
293293
}
294294
},
295-
"revision": "20230714",
295+
"revision": "20230719",
296296
"rootUrl": "https://documentai.googleapis.com/",
297297
"schemas": {
298298
"GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": {

0 commit comments

Comments
 (0)