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_v1beta2.projects.documents.html
+6-34Lines changed: 6 additions & 34 deletions
Original file line number
Diff line number
Diff line change
@@ -285,13 +285,13 @@ <h3>Method Details</h3>
285
285
An object of the form:
286
286
287
287
{ # Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
288
-
"content": "A String", # 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.
288
+
"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.
289
289
"entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
290
290
{ # A phrase in the text that is a known entity type, such as a person, an organization, or location.
291
291
"confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1].
292
292
"id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
293
-
"mentionId": "A String", # Deprecated. Use `id` field instead.
294
-
"mentionText": "A String", # Text value in the document e.g. `1600 Amphitheatre Pkwy`.
293
+
"mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
294
+
"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`.
295
295
"normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
296
296
"addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
297
297
"addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
@@ -375,7 +375,7 @@ <h3>Method Details</h3>
375
375
"type": "A String", # The type of provenance operation.
376
376
},
377
377
"redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
378
-
"textAnchor": { # Text reference indexing into the Document.text. # Provenance of the entity. Text anchor indexing into the Document.text.
378
+
"textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
379
379
"content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments.
380
380
"textSegments": [ # The text segments from the Document.text.
381
381
{ # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
@@ -915,7 +915,7 @@ <h3>Method Details</h3>
915
915
"shardIndex": "A String", # The 0-based index of this shard.
916
916
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
917
917
},
918
-
"text": "A String", # UTF-8 encoded text in reading order from the document.
918
+
"text": "A String", # Optional. UTF-8 encoded text in reading order from the document.
919
919
"textChanges": [ # A list of text corrections made to [Document.text]. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
920
920
{ # This message is used for text changes aka. OCR corrections.
921
921
"changedText": "A String", # The text that replaces the text identified in the `text_anchor`.
@@ -975,35 +975,7 @@ <h3>Method Details</h3>
975
975
"textStyle": "A String", # Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp
976
976
},
977
977
],
978
-
"translations": [ # A list of translations on Document.text. For document shards, translations in this list may cross shard boundaries.
979
-
{ # A translation of the text segment.
980
-
"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
981
-
"provenance": [ # The history of this annotation.
982
-
{ # Structure to identify provenance relationships between annotations in different revisions.
983
-
"id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
984
-
"parents": [ # References to the original elements that are replaced.
985
-
{ # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.
986
-
"id": 42, # The id of the parent provenance.
987
-
"revision": 42, # The index of the [Document.revisions] identifying the parent revision.
988
-
},
989
-
],
990
-
"revision": 42, # The index of the revision that produced this element.
991
-
"type": "A String", # The type of provenance operation.
992
-
},
993
-
],
994
-
"textAnchor": { # Text reference indexing into the Document.text. # Provenance of the translation. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index.
995
-
"content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments.
996
-
"textSegments": [ # The text segments from the Document.text.
997
-
{ # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
998
-
"endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
999
-
"startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
1000
-
},
1001
-
],
1002
-
},
1003
-
"translatedText": "A String", # Text translated into the target language.
1004
-
},
1005
-
],
1006
-
"uri": "A String", # Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.
978
+
"uri": "A String", # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.
Copy file name to clipboardExpand all lines: docs/dyn/documentai_v1beta2.projects.locations.documents.html
+6-34Lines changed: 6 additions & 34 deletions
Original file line number
Diff line number
Diff line change
@@ -285,13 +285,13 @@ <h3>Method Details</h3>
285
285
An object of the form:
286
286
287
287
{ # Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.
288
-
"content": "A String", # 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.
288
+
"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.
289
289
"entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
290
290
{ # A phrase in the text that is a known entity type, such as a person, an organization, or location.
291
291
"confidence": 3.14, # Optional. Confidence of detected Schema entity. Range [0, 1].
292
292
"id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
293
-
"mentionId": "A String", # Deprecated. Use `id` field instead.
294
-
"mentionText": "A String", # Text value in the document e.g. `1600 Amphitheatre Pkwy`.
293
+
"mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
294
+
"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`.
295
295
"normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
296
296
"addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
297
297
"addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
@@ -375,7 +375,7 @@ <h3>Method Details</h3>
375
375
"type": "A String", # The type of provenance operation.
376
376
},
377
377
"redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
378
-
"textAnchor": { # Text reference indexing into the Document.text. # Provenance of the entity. Text anchor indexing into the Document.text.
378
+
"textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
379
379
"content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments.
380
380
"textSegments": [ # The text segments from the Document.text.
381
381
{ # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
@@ -915,7 +915,7 @@ <h3>Method Details</h3>
915
915
"shardIndex": "A String", # The 0-based index of this shard.
916
916
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
917
917
},
918
-
"text": "A String", # UTF-8 encoded text in reading order from the document.
918
+
"text": "A String", # Optional. UTF-8 encoded text in reading order from the document.
919
919
"textChanges": [ # A list of text corrections made to [Document.text]. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
920
920
{ # This message is used for text changes aka. OCR corrections.
921
921
"changedText": "A String", # The text that replaces the text identified in the `text_anchor`.
@@ -975,35 +975,7 @@ <h3>Method Details</h3>
975
975
"textStyle": "A String", # Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp
976
976
},
977
977
],
978
-
"translations": [ # A list of translations on Document.text. For document shards, translations in this list may cross shard boundaries.
979
-
{ # A translation of the text segment.
980
-
"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
981
-
"provenance": [ # The history of this annotation.
982
-
{ # Structure to identify provenance relationships between annotations in different revisions.
983
-
"id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
984
-
"parents": [ # References to the original elements that are replaced.
985
-
{ # Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.
986
-
"id": 42, # The id of the parent provenance.
987
-
"revision": 42, # The index of the [Document.revisions] identifying the parent revision.
988
-
},
989
-
],
990
-
"revision": 42, # The index of the revision that produced this element.
991
-
"type": "A String", # The type of provenance operation.
992
-
},
993
-
],
994
-
"textAnchor": { # Text reference indexing into the Document.text. # Provenance of the translation. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index.
995
-
"content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments.
996
-
"textSegments": [ # The text segments from the Document.text.
997
-
{ # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
998
-
"endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
999
-
"startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
1000
-
},
1001
-
],
1002
-
},
1003
-
"translatedText": "A String", # Text translated into the target language.
1004
-
},
1005
-
],
1006
-
"uri": "A String", # Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.
978
+
"uri": "A String", # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.
Copy file name to clipboardExpand all lines: docs/dyn/documentai_v1beta3.projects.locations.html
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -135,9 +135,9 @@ <h3>Method Details</h3>
135
135
136
136
Args:
137
137
name: string, The resource that owns the locations collection, if applicable. (required)
138
-
filter: string, The standard list filter.
139
-
pageSize: integer, The standard list page size.
140
-
pageToken: string, The standard list page token.
138
+
filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160).
139
+
pageSize: integer, The maximum number of results to return. If not set, the service will select a default.
140
+
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
0 commit comments