@maxim_mazurok/gapi.client.documentai-v1beta3 0.1.20250922 → 0.1.20251013

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://documentai.googleapis.com/$discovery/rest?version=v1beta3
-// Revision: 20250922
+// Revision: 20251013
 
 /// <reference types="gapi.client" />
 
@@ -32,17 +32,38 @@ declare namespace gapi.client {
       validationRules?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule[];
     }
     interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule {
+      childAlignmentRule?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule;
       /** Description of the validation rule. This has no use but for documentation */
       description?: string;
+      entityAlignmentRule?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule;
       fieldOccurrences?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences;
       fieldRegex?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex;
       formValidation?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation;
       /** Name of the validation rule. */
       name?: string;
     }
+    interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule {
+      alignmentType?: string;
+      /** The tolerance to use when comparing coordinates. */
+      tolerance?: number;
+    }
+    interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule {
+      /** The alignment rule to apply to the child fields. */
+      alignmentRule?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule;
+      /** The child fields to be aligned within the parent field. */
+      childFields?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField[];
+      /** The full path of the parent field. */
+      parentField?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField;
+    }
     interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant {
       floatValue?: number;
     }
+    interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule {
+      /** The alignment rule to apply to the fields. */
+      alignmentRule?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule;
+      /** The fields to be aligned. */
+      fields?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField[];
+    }
     interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField {
       /** Default value to use if the field is not present. If the field is missing and the default value is not set, the validation run as if the field is not present in the validation logic. */
       defaultValue?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant;
@@ -574,8 +595,14 @@ declare namespace gapi.client {
       documentLayout?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayout;
       /** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
       entities?: GoogleCloudDocumentaiV1beta3DocumentEntity[];
+      /** The entity revision id that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. */
+      entitiesRevisionId?: string;
+      /** A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. */
+      entitiesRevisions?: GoogleCloudDocumentaiV1beta3DocumentEntitiesRevision[];
       /** Placeholder. Relationship among Document.entities. */
       entityRelations?: GoogleCloudDocumentaiV1beta3DocumentEntityRelation[];
+      /** The entity validation output for the document. This is the validation output for `document.entities` field. */
+      entityValidationOutput?: GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutput;
       /** Any error that occurred while processing this document. */
       error?: GoogleRpcStatus;
       /** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
@@ -747,6 +774,14 @@ declare namespace gapi.client {
       /** Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. */
       type?: string;
     }
+    interface GoogleCloudDocumentaiV1beta3DocumentEntitiesRevision {
+      /** The entities in this revision. */
+      entities?: GoogleCloudDocumentaiV1beta3DocumentEntity[];
+      /** The entity validation output for this revision. */
+      entityValidationOutput?: GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutput;
+      /** The revision id. */
+      revisionId?: string;
+    }
     interface GoogleCloudDocumentaiV1beta3DocumentEntity {
       /** Optional. Confidence of detected Schema entity. Range `[0, 1]`. */
       confidence?: number;
@@ -788,6 +823,7 @@ declare namespace gapi.client {
       integerValue?: number;
       /** Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto */
       moneyValue?: GoogleTypeMoney;
+      /** A signature - a graphical representation of a person's name, often used to sign a document. */
       signatureValue?: boolean;
       /** Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. */
       text?: string;
@@ -800,6 +836,22 @@ declare namespace gapi.client {
       /** Subject entity id. */
       subjectId?: string;
     }
+    interface GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutput {
+      /** The overall result of the validation, true if all applicable rules are valid. */
+      passAllRules?: boolean;
+      /** The result of each validation rule. */
+      validationResults?: GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult[];
+    }
+    interface GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult {
+      /** The description of the validation rule. */
+      ruleDescription?: string;
+      /** The name of the validation rule. */
+      ruleName?: string;
+      /** The detailed information of the running the validation process using the entity from the document based on the validation rule. */
+      validationDetails?: string;
+      /** The result of the validation rule. */
+      validationResultType?: string;
+    }
     interface GoogleCloudDocumentaiV1beta3DocumentId {
       /** A document id within user-managed Cloud Storage. */
       gcsManagedDocId?: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId;
@@ -1955,6 +2007,8 @@ declare namespace gapi.client {
       nextPageToken?: string;
       /** A list of operations that matches the specified filter in the request. */
       operations?: GoogleLongrunningOperation[];
+      /** Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. */
+      unreachable?: string[];
     }
     interface GoogleLongrunningOperation {
       /** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
@@ -2136,6 +2190,8 @@ declare namespace gapi.client {
         prettyPrint?: boolean;
         /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
         quotaUser?: string;
+        /** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
+        returnPartialSuccess?: boolean;
         /** Upload protocol for media (e.g. "raw", "multipart"). */
         upload_protocol?: string;
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.documentai-v1beta3",
-  "version": "0.1.20250922",
+  "version": "0.1.20251013",
   "description": "TypeScript typings for Cloud Document AI API v1beta3",
   "repository": {
     "type": "git",