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
<pclass="firstline">Deletes a document schema. Returns NOT_FOUND if the document schema does not exist.</p>
85
+
<pclass="firstline">Deletes a document schema. Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it.</p>
<pclass="firstline">Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new propertiesand updating existing properties will result into INVALID_ARGUMENT.</p>
97
+
<pclass="firstline">Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT.</p>
98
98
<h3>Method Details</h3>
99
99
<divclass="method">
100
100
<codeclass="details" id="close">close()</code>
@@ -117,7 +117,7 @@ <h3>Method Details</h3>
117
117
"documentIsFolder": True or False, # Document Type, true refers the document is a folder, otherwise it is a typical document.
118
118
"name": "A String", # The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
{ # Defines the metadata for a schema property. Next ID: 18
120
+
{ # Defines the metadata for a schema property.
121
121
"dateTimeTypeOptions": { # Configurations for a date time property. # Date time property. It is not supported by CMEK compliant deployment.
122
122
},
123
123
"displayName": "A String", # The display-name for the property, used for front-end.
@@ -168,7 +168,7 @@ <h3>Method Details</h3>
168
168
"documentIsFolder": True or False, # Document Type, true refers the document is a folder, otherwise it is a typical document.
169
169
"name": "A String", # The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
<pre>Deletes a document schema. Returns NOT_FOUND if the document schema does not exist.
210
+
<pre>Deletes a document schema. Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it.
211
211
212
212
Args:
213
213
name: string, Required. The name of the document schema to delete. (required)
@@ -244,7 +244,7 @@ <h3>Method Details</h3>
244
244
"documentIsFolder": True or False, # Document Type, true refers the document is a folder, otherwise it is a typical document.
245
245
"name": "A String", # The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
{ # Defines the metadata for a schema property. Next ID: 18
247
+
{ # Defines the metadata for a schema property.
248
248
"dateTimeTypeOptions": { # Configurations for a date time property. # Date time property. It is not supported by CMEK compliant deployment.
249
249
},
250
250
"displayName": "A String", # The display-name for the property, used for front-end.
@@ -306,7 +306,7 @@ <h3>Method Details</h3>
306
306
"documentIsFolder": True or False, # Document Type, true refers the document is a folder, otherwise it is a typical document.
307
307
"name": "A String", # The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
<pre>Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new propertiesand updating existing properties will result into INVALID_ARGUMENT.
365
+
<pre>Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT.
366
366
367
367
Args:
368
368
name: string, Required. The name of the document schema to update. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. (required)
@@ -377,7 +377,7 @@ <h3>Method Details</h3>
377
377
"documentIsFolder": True or False, # Document Type, true refers the document is a folder, otherwise it is a typical document.
378
378
"name": "A String", # The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
{ # Defines the metadata for a schema property. Next ID: 18
380
+
{ # Defines the metadata for a schema property.
381
381
"dateTimeTypeOptions": { # Configurations for a date time property. # Date time property. It is not supported by CMEK compliant deployment.
382
382
},
383
383
"displayName": "A String", # The display-name for the property, used for front-end.
@@ -429,7 +429,7 @@ <h3>Method Details</h3>
429
429
"documentIsFolder": True or False, # Document Type, true refers the document is a folder, otherwise it is a typical document.
430
430
"name": "A String", # The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
Copy file name to clipboardexpand all lines: docs/dyn/contentwarehouse_v1.projects.locations.documents.referenceId.html
+67-4
Original file line number
Diff line number
Diff line change
@@ -133,7 +133,7 @@ <h3>Method Details</h3>
133
133
body: object, The request body.
134
134
The object takes the form of:
135
135
136
-
{ # Request message for DocumentService.GetDocument. Next ID: 4
136
+
{ # Request message for DocumentService.GetDocument.
137
137
"requestMetadata": { # Meta information is used to improve the performance of the service. # The meta information collected about the end user, used to enforce access control for the service.
138
138
"userInfo": { # Provides user unique identification and groups information.
139
139
"groupIds": [ # The unique group identifications which the user is belong to. The format is "group:yyyy@example.com";
@@ -152,7 +152,7 @@ <h3>Method Details</h3>
152
152
Returns:
153
153
An object of the form:
154
154
155
-
{ # Defines the structure for content warehouse document proto. Next ID: 20
155
+
{ # Defines the structure for content warehouse document proto.
156
156
"asyncEnabled": True or False, # If true, makes the document visible to asynchronous policies and rules.
157
157
"cloudAiDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # Document AI format to save the structured content, including OCR.
158
158
"content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
@@ -467,6 +467,15 @@ <h3>Method Details</h3>
467
467
"mimeType": "A String", # Encoding mime type for the image.
468
468
"width": 42, # Width of the image in pixels.
469
469
},
470
+
"imageQualityScores": { # Image Quality Scores for the page image # Image Quality Scores.
471
+
"detectedDefects": [ # A list of detected defects.
472
+
{ # Image Quality Defects
473
+
"confidence": 3.14, # Confidence of detected defect. Range [0, 1] where 1 indicates strong confidence of that the defect exists.
474
+
"type": "A String", # Name of the defect type. Supported values are "quality/defect_blurry", "quality/defect_noisy", "quality/defect_dark", "quality/defect_faint", "quality/defect_text_too_small", "quality/defect_document_cutoff", "quality/defect_text_cutoff", "quality/defect_glare"
475
+
},
476
+
],
477
+
"qualityScore": 3.14, # The overall quality score. Range [0, 1] where 1 is perfect quality.
478
+
},
470
479
"layout": { # Visual element describing a layout unit on a page. # Layout for the page.
471
480
"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
472
481
"normalizedVertices": [ # The bounding polygon normalized vertices.
@@ -763,6 +772,18 @@ <h3>Method Details</h3>
763
772
],
764
773
},
765
774
},
775
+
"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
776
+
"id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
777
+
"parents": [ # References to the original elements that are replaced.
778
+
{ # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
779
+
"id": 42, # The id of the parent provenance.
780
+
"index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
781
+
"revision": 42, # The index of the index into current revision's parent_ids list.
782
+
},
783
+
],
784
+
"revision": 42, # The index of the revision that produced this element.
785
+
"type": "A String", # The type of provenance operation.
786
+
},
766
787
},
767
788
],
768
789
"tokens": [ # A list of visually detected tokens on the page.
@@ -1074,7 +1095,7 @@ <h3>Method Details</h3>
1074
1095
},
1075
1096
"enableEntitiesConversions": True or False, # Whether to convert all the entities to properties.
1076
1097
},
1077
-
"document": { # Defines the structure for content warehouse document proto. Next ID: 20 # Required. The document to update.
1098
+
"document": { # Defines the structure for content warehouse document proto. # Required. The document to update.
1078
1099
"asyncEnabled": True or False, # If true, makes the document visible to asynchronous policies and rules.
1079
1100
"cloudAiDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # Document AI format to save the structured content, including OCR.
1080
1101
"content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
@@ -1389,6 +1410,15 @@ <h3>Method Details</h3>
1389
1410
"mimeType": "A String", # Encoding mime type for the image.
1390
1411
"width": 42, # Width of the image in pixels.
1391
1412
},
1413
+
"imageQualityScores": { # Image Quality Scores for the page image # Image Quality Scores.
1414
+
"detectedDefects": [ # A list of detected defects.
1415
+
{ # Image Quality Defects
1416
+
"confidence": 3.14, # Confidence of detected defect. Range [0, 1] where 1 indicates strong confidence of that the defect exists.
1417
+
"type": "A String", # Name of the defect type. Supported values are "quality/defect_blurry", "quality/defect_noisy", "quality/defect_dark", "quality/defect_faint", "quality/defect_text_too_small", "quality/defect_document_cutoff", "quality/defect_text_cutoff", "quality/defect_glare"
1418
+
},
1419
+
],
1420
+
"qualityScore": 3.14, # The overall quality score. Range [0, 1] where 1 is perfect quality.
1421
+
},
1392
1422
"layout": { # Visual element describing a layout unit on a page. # Layout for the page.
1393
1423
"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
1394
1424
"normalizedVertices": [ # The bounding polygon normalized vertices.
@@ -1685,6 +1715,18 @@ <h3>Method Details</h3>
1685
1715
],
1686
1716
},
1687
1717
},
1718
+
"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
1719
+
"id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
1720
+
"parents": [ # References to the original elements that are replaced.
1721
+
{ # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
1722
+
"id": 42, # The id of the parent provenance.
1723
+
"index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
1724
+
"revision": 42, # The index of the index into current revision's parent_ids list.
1725
+
},
1726
+
],
1727
+
"revision": 42, # The index of the revision that produced this element.
1728
+
"type": "A String", # The type of provenance operation.
1729
+
},
1688
1730
},
1689
1731
],
1690
1732
"tokens": [ # A list of visually detected tokens on the page.
@@ -2005,7 +2047,7 @@ <h3>Method Details</h3>
2005
2047
An object of the form:
2006
2048
2007
2049
{ # Response message for DocumentService.UpdateDocument.
2008
-
"document": { # Defines the structure for content warehouse document proto. Next ID: 20 # Updated document after executing update request.
2050
+
"document": { # Defines the structure for content warehouse document proto. # Updated document after executing update request.
2009
2051
"asyncEnabled": True or False, # If true, makes the document visible to asynchronous policies and rules.
2010
2052
"cloudAiDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # Document AI format to save the structured content, including OCR.
2011
2053
"content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
@@ -2320,6 +2362,15 @@ <h3>Method Details</h3>
2320
2362
"mimeType": "A String", # Encoding mime type for the image.
2321
2363
"width": 42, # Width of the image in pixels.
2322
2364
},
2365
+
"imageQualityScores": { # Image Quality Scores for the page image # Image Quality Scores.
2366
+
"detectedDefects": [ # A list of detected defects.
2367
+
{ # Image Quality Defects
2368
+
"confidence": 3.14, # Confidence of detected defect. Range [0, 1] where 1 indicates strong confidence of that the defect exists.
2369
+
"type": "A String", # Name of the defect type. Supported values are "quality/defect_blurry", "quality/defect_noisy", "quality/defect_dark", "quality/defect_faint", "quality/defect_text_too_small", "quality/defect_document_cutoff", "quality/defect_text_cutoff", "quality/defect_glare"
2370
+
},
2371
+
],
2372
+
"qualityScore": 3.14, # The overall quality score. Range [0, 1] where 1 is perfect quality.
2373
+
},
2323
2374
"layout": { # Visual element describing a layout unit on a page. # Layout for the page.
2324
2375
"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
2325
2376
"normalizedVertices": [ # The bounding polygon normalized vertices.
@@ -2616,6 +2667,18 @@ <h3>Method Details</h3>
2616
2667
],
2617
2668
},
2618
2669
},
2670
+
"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
2671
+
"id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
2672
+
"parents": [ # References to the original elements that are replaced.
2673
+
{ # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
2674
+
"id": 42, # The id of the parent provenance.
2675
+
"index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
2676
+
"revision": 42, # The index of the index into current revision's parent_ids list.
2677
+
},
2678
+
],
2679
+
"revision": 42, # The index of the revision that produced this element.
2680
+
"type": "A String", # The type of provenance operation.
2681
+
},
2619
2682
},
2620
2683
],
2621
2684
"tokens": [ # A list of visually detected tokens on the page.
Copy file name to clipboardexpand all lines: docs/dyn/contentwarehouse_v1.projects.locations.ruleSets.html
+6-6
Original file line number
Diff line number
Diff line change
@@ -110,7 +110,7 @@ <h3>Method Details</h3>
110
110
body: object, The request body.
111
111
The object takes the form of:
112
112
113
-
{ # Represents a set of rules from a single customer. Next id: 9
113
+
{ # Represents a set of rules from a single customer.
114
114
"description": "A String", # Short description of the rule-set.
115
115
"name": "A String", # The resource name of the rule set. Managed internally. Format: projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. The name is ignored when creating a rule set.
116
116
"rules": [ # List of rules given by the customer.
@@ -199,7 +199,7 @@ <h3>Method Details</h3>
199
199
Returns:
200
200
An object of the form:
201
201
202
-
{ # Represents a set of rules from a single customer. Next id: 9
202
+
{ # Represents a set of rules from a single customer.
203
203
"description": "A String", # Short description of the rule-set.
204
204
"name": "A String", # The resource name of the rule set. Managed internally. Format: projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. The name is ignored when creating a rule set.
205
205
"rules": [ # List of rules given by the customer.
@@ -313,7 +313,7 @@ <h3>Method Details</h3>
313
313
Returns:
314
314
An object of the form:
315
315
316
-
{ # Represents a set of rules from a single customer. Next id: 9
316
+
{ # Represents a set of rules from a single customer.
317
317
"description": "A String", # Short description of the rule-set.
318
318
"name": "A String", # The resource name of the rule set. Managed internally. Format: projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. The name is ignored when creating a rule set.
319
319
"rules": [ # List of rules given by the customer.
@@ -414,7 +414,7 @@ <h3>Method Details</h3>
414
414
{ # Response message for RuleSetService.ListRuleSets.
415
415
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
416
416
"ruleSets": [ # The rule sets from the specified parent.
417
-
{ # Represents a set of rules from a single customer. Next id: 9
417
+
{ # Represents a set of rules from a single customer.
418
418
"description": "A String", # Short description of the rule-set.
419
419
"name": "A String", # The resource name of the rule set. Managed internally. Format: projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. The name is ignored when creating a rule set.
420
420
"rules": [ # List of rules given by the customer.
@@ -522,7 +522,7 @@ <h3>Method Details</h3>
522
522
The object takes the form of:
523
523
524
524
{ # Request message for RuleSetService.UpdateRuleSet.
525
-
"ruleSet": { # Represents a set of rules from a single customer. Next id: 9 # Required. The rule set to update.
525
+
"ruleSet": { # Represents a set of rules from a single customer. # Required. The rule set to update.
526
526
"description": "A String", # Short description of the rule-set.
527
527
"name": "A String", # The resource name of the rule set. Managed internally. Format: projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. The name is ignored when creating a rule set.
528
528
"rules": [ # List of rules given by the customer.
@@ -612,7 +612,7 @@ <h3>Method Details</h3>
612
612
Returns:
613
613
An object of the form:
614
614
615
-
{ # Represents a set of rules from a single customer. Next id: 9
615
+
{ # Represents a set of rules from a single customer.
616
616
"description": "A String", # Short description of the rule-set.
617
617
"name": "A String", # The resource name of the rule set. Managed internally. Format: projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. The name is ignored when creating a rule set.
618
618
"rules": [ # List of rules given by the customer.
0 commit comments