Skip to content

Commit 072238b

Browse files
feat(documentai): update the api
#### documentai:v1 The following keys were deleted: - schemas.GoogleCloudDocumentaiV1DocumentEntity.properties.nonPresent.type (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta1DocumentEntity.properties.nonPresent.type (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta2DocumentEntity.properties.nonPresent.type (Total Keys: 1) The following keys were added: - schemas.GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata.properties.totalDocumentCount (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata.properties.importConfigValidationResults (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult (Total Keys: 4) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata.properties.datasetResyncStatuses (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata.properties.individualDocumentResyncStatuses (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus (Total Keys: 4) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus (Total Keys: 5) #### documentai:v1beta2 The following keys were deleted: - schemas.GoogleCloudDocumentaiV1beta1DocumentEntity.properties.nonPresent.type (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta2DocumentEntity.properties.nonPresent.type (Total Keys: 1) The following keys were added: - schemas.GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata.properties.totalDocumentCount (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata.properties.importConfigValidationResults (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult (Total Keys: 4) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata.properties.datasetResyncStatuses (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata.properties.individualDocumentResyncStatuses (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus (Total Keys: 4) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus (Total Keys: 5) #### documentai:v1beta3 The following keys were deleted: - schemas.GoogleCloudDocumentaiV1beta1DocumentEntity.properties.nonPresent.type (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta2DocumentEntity.properties.nonPresent.type (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta3DocumentEntity.properties.nonPresent.type (Total Keys: 1) The following keys were added: - schemas.GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata.properties.totalDocumentCount (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata.properties.importConfigValidationResults (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult (Total Keys: 4) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata.properties.datasetResyncStatuses (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata.properties.individualDocumentResyncStatuses (Total Keys: 2) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus (Total Keys: 4) - schemas.GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus (Total Keys: 5)
1 parent d41a450 commit 072238b

11 files changed

+295
-57
lines changed

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,6 @@ <h3>Method Details</h3>
432432
&quot;id&quot;: &quot;A String&quot;, # Optional. Canonical id. This will be a unique value in the entity list for this document.
433433
&quot;mentionId&quot;: &quot;A String&quot;, # Optional. Deprecated. Use `id` field instead.
434434
&quot;mentionText&quot;: &quot;A String&quot;, # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty.
435-
&quot;nonPresent&quot;: True or False, # Optional. This attribute indicates that the processing didn&#x27;t actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor.
436435
&quot;normalizedValue&quot;: { # 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.
437436
&quot;addressValue&quot;: { # 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 internationalization-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
438437
&quot;addressLines&quot;: [ # 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. &quot;Austin, TX&quot;), it is important that the line order is clear. The order of address lines should be &quot;envelope order&quot; 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. &quot;ja&quot; for large-to-small ordering and &quot;ja-Latn&quot; or &quot;en&quot; 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).
@@ -1246,7 +1245,6 @@ <h3>Method Details</h3>
12461245
&quot;id&quot;: &quot;A String&quot;, # Optional. Canonical id. This will be a unique value in the entity list for this document.
12471246
&quot;mentionId&quot;: &quot;A String&quot;, # Optional. Deprecated. Use `id` field instead.
12481247
&quot;mentionText&quot;: &quot;A String&quot;, # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty.
1249-
&quot;nonPresent&quot;: True or False, # Optional. This attribute indicates that the processing didn&#x27;t actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor.
12501248
&quot;normalizedValue&quot;: { # 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.
12511249
&quot;addressValue&quot;: { # 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 internationalization-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
12521250
&quot;addressLines&quot;: [ # 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. &quot;Austin, TX&quot;), it is important that the line order is clear. The order of address lines should be &quot;envelope order&quot; 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. &quot;ja&quot; for large-to-small ordering and &quot;ja-Latn&quot; or &quot;en&quot; 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).

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h3>Method Details</h3>
110110
&quot;A String&quot;,
111111
],
112112
},
113-
&quot;name&quot;: &quot;A String&quot;, # Name of the type. It must be unique within the schema file and cannot be a &#x27;Common Type&#x27;. Besides that we use the following naming conventions: - *use snake_casing* - name matching is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters [a-z0-9_-]. (For backward compatibility internal infrastructure and tooling can handle any ascii character) - The &#x27;/&#x27; is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.
113+
&quot;name&quot;: &quot;A String&quot;, # Name of the type. It must be unique within the schema file and cannot be a &#x27;Common Type&#x27;. Besides that we use the following naming conventions: - *use snake_casing* - name matching is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character) - The &#x27;/&#x27; is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.
114114
&quot;properties&quot;: [ # Describing the nested structure, or composition of an entity.
115115
{ # Defines properties that can be part of the entity type.
116116
&quot;name&quot;: &quot;A String&quot;, # The name of the property. Follows the same guidelines as the EntityType name.
@@ -136,7 +136,6 @@ <h3>Method Details</h3>
136136
&quot;id&quot;: &quot;A String&quot;, # Optional. Canonical id. This will be a unique value in the entity list for this document.
137137
&quot;mentionId&quot;: &quot;A String&quot;, # Optional. Deprecated. Use `id` field instead.
138138
&quot;mentionText&quot;: &quot;A String&quot;, # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty.
139-
&quot;nonPresent&quot;: True or False, # Optional. This attribute indicates that the processing didn&#x27;t actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor.
140139
&quot;normalizedValue&quot;: { # 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.
141140
&quot;addressValue&quot;: { # 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 internationalization-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
142141
&quot;addressLines&quot;: [ # 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. &quot;Austin, TX&quot;), it is important that the line order is clear. The order of address lines should be &quot;envelope order&quot; 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. &quot;ja&quot; for large-to-small ordering and &quot;ja-Latn&quot; or &quot;en&quot; 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).

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,6 @@ <h3>Method Details</h3>
341341
&quot;id&quot;: &quot;A String&quot;, # Optional. Canonical id. This will be a unique value in the entity list for this document.
342342
&quot;mentionId&quot;: &quot;A String&quot;, # Optional. Deprecated. Use `id` field instead.
343343
&quot;mentionText&quot;: &quot;A String&quot;, # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty.
344-
&quot;nonPresent&quot;: True or False, # Optional. This attribute indicates that the processing didn&#x27;t actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor.
345344
&quot;normalizedValue&quot;: { # 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.
346345
&quot;addressValue&quot;: { # 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 internationalization-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
347346
&quot;addressLines&quot;: [ # 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. &quot;Austin, TX&quot;), it is important that the line order is clear. The order of address lines should be &quot;envelope order&quot; 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. &quot;ja&quot; for large-to-small ordering and &quot;ja-Latn&quot; or &quot;en&quot; 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).
@@ -1155,7 +1154,6 @@ <h3>Method Details</h3>
11551154
&quot;id&quot;: &quot;A String&quot;, # Optional. Canonical id. This will be a unique value in the entity list for this document.
11561155
&quot;mentionId&quot;: &quot;A String&quot;, # Optional. Deprecated. Use `id` field instead.
11571156
&quot;mentionText&quot;: &quot;A String&quot;, # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty.
1158-
&quot;nonPresent&quot;: True or False, # Optional. This attribute indicates that the processing didn&#x27;t actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor.
11591157
&quot;normalizedValue&quot;: { # 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.
11601158
&quot;addressValue&quot;: { # 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 internationalization-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
11611159
&quot;addressLines&quot;: [ # 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. &quot;Austin, TX&quot;), it is important that the line order is clear. The order of address lines should be &quot;envelope order&quot; 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. &quot;ja&quot; for large-to-small ordering and &quot;ja-Latn&quot; or &quot;en&quot; 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).

0 commit comments

Comments
 (0)