@maxim_mazurok/gapi.client.documentai-v1 0.2.20260608 → 0.2.20260706

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=v1
-// Revision: 20260608
+// Revision: 20260706
 
 /// <reference types="gapi.client" />
 
@@ -124,7 +124,7 @@ declare namespace gapi.client {
       totalDocumentCount?: number;
     }
     interface GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus {
-      /** The document id of the auto-labeled document. This will replace the gcs_uri. */
+      /** The document ID of the auto-labeled document. This will replace the gcs_uri. */
       documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
       /** The status of the document auto-labeling. */
       status?: GoogleRpcStatus;
@@ -141,7 +141,7 @@ declare namespace gapi.client {
       totalDocumentCount?: number;
     }
     interface GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus {
-      /** The document id of the document. */
+      /** The document ID of the document. */
       documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
       /** The status of deleting the document in storage. */
       status?: GoogleRpcStatus;
@@ -166,7 +166,7 @@ declare namespace gapi.client {
       individualBatchMoveStatuses?: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus[];
     }
     interface GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus {
-      /** The document id of the document. */
+      /** The document ID of the document. */
       documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
       /** The status of moving the document. */
       status?: GoogleRpcStatus;
@@ -179,7 +179,7 @@ declare namespace gapi.client {
       individualBatchUpdateStatuses?: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus[];
     }
     interface GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus {
-      /** The document id of the document. */
+      /** The document ID of the document. */
       documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
       /** The status of updating the document in storage. */
       status?: GoogleRpcStatus;
@@ -230,21 +230,21 @@ declare namespace gapi.client {
     }
     interface GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse {}
     interface GoogleCloudDocumentaiUiv1beta3DocumentId {
-      /** A document id within user-managed Cloud Storage. */
+      /** A document ID within user-managed Cloud Storage. */
       gcsManagedDocId?: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId;
       /** Points to a specific revision of the document if set. */
       revisionRef?: GoogleCloudDocumentaiUiv1beta3RevisionRef;
-      /** A document id within unmanaged dataset. */
+      /** A document ID within unmanaged dataset. */
       unmanagedDocId?: GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId;
     }
     interface GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId {
-      /** Id of the document (indexed) managed by Content Warehouse. */
+      /** ID of the document (indexed) managed by Content Warehouse. */
       cwDocId?: string;
       /** Required. The Cloud Storage URI where the actual document is stored. */
       gcsUri?: string;
     }
     interface GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId {
-      /** Required. The id of the document. */
+      /** Required. The ID of the document. */
       docId?: string;
     }
     interface GoogleCloudDocumentaiUiv1beta3DocumentSchema {
@@ -252,7 +252,7 @@ declare namespace gapi.client {
       description?: string;
       /** Display name to show users. */
       displayName?: string;
-      /** Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. */
+      /** Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. */
       documentPrompt?: string;
       /** Entity types of the schema. */
       entityTypes?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType[];
@@ -270,7 +270,7 @@ declare namespace gapi.client {
       entityTypeMetadata?: GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata;
       /** If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently, use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file. */
       enumValues?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues;
-      /** Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - 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 `/` 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. */
+      /** Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - 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 `/` 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. */
       name?: string;
       /** Description the nested structure, or composition of an entity. */
       properties?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty[];
@@ -449,7 +449,7 @@ declare namespace gapi.client {
     interface GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus {
       /** The source Cloud Storage URI of the document. */
       inputGcsSource?: string;
-      /** The document id of imported document if it was successful, otherwise empty. */
+      /** The document ID of imported document if it was successful, otherwise empty. */
       outputDocumentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
       /** The output_gcs_destination of the processed document if it was successful, otherwise empty. */
       outputGcsDestination?: string;
@@ -466,7 +466,7 @@ declare namespace gapi.client {
       processorVersion?: string;
     }
     interface GoogleCloudDocumentaiUiv1beta3Processor {
-      /** Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} */
+      /** Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}. */
       activeSchemaVersion?: string;
       /** Output only. The time the processor was created. */
       createTime?: string;
@@ -812,7 +812,7 @@ declare namespace gapi.client {
       totalDocumentCount?: number;
     }
     interface GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus {
-      /** The document id of the document. */
+      /** The document ID of the document. */
       documentId?: GoogleCloudDocumentaiV1beta3DocumentId;
       /** The status of deleting the document in storage. */
       status?: GoogleRpcStatus;
@@ -915,21 +915,21 @@ declare namespace gapi.client {
     }
     interface GoogleCloudDocumentaiV1beta3DisableProcessorResponse {}
     interface GoogleCloudDocumentaiV1beta3DocumentId {
-      /** A document id within user-managed Cloud Storage. */
+      /** A document ID within user-managed Cloud Storage. */
       gcsManagedDocId?: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId;
       /** Points to a specific revision of the document if set. */
       revisionRef?: GoogleCloudDocumentaiV1beta3RevisionRef;
-      /** A document id within unmanaged dataset. */
+      /** A document ID within unmanaged dataset. */
       unmanagedDocId?: GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId;
     }
     interface GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId {
-      /** Id of the document (indexed) managed by Content Warehouse. */
+      /** ID of the document (indexed) managed by Content Warehouse. */
       cwDocId?: string;
       /** Required. The Cloud Storage URI where the actual document is stored. */
       gcsUri?: string;
     }
     interface GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId {
-      /** Required. The id of the document. */
+      /** Required. The ID of the document. */
       docId?: string;
     }
     interface GoogleCloudDocumentaiV1beta3DocumentSchema {
@@ -937,7 +937,7 @@ declare namespace gapi.client {
       description?: string;
       /** Display name to show users. */
       displayName?: string;
-      /** Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. */
+      /** Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. */
       documentPrompt?: string;
       /** Entity types of the schema. */
       entityTypes?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType[];
@@ -955,7 +955,7 @@ declare namespace gapi.client {
       entityTypeMetadata?: GoogleCloudDocumentaiV1beta3EntityTypeMetadata;
       /** If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently, use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file. */
       enumValues?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues;
-      /** Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - 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 `/` 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. */
+      /** Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - 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 `/` 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. */
       name?: string;
       /** Description the nested structure, or composition of an entity. */
       properties?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty[];
@@ -1086,7 +1086,7 @@ declare namespace gapi.client {
     interface GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus {
       /** The source Cloud Storage URI of the document. */
       inputGcsSource?: string;
-      /** The document id of imported document if it was successful, otherwise empty. */
+      /** The document ID of imported document if it was successful, otherwise empty. */
       outputDocumentId?: GoogleCloudDocumentaiV1beta3DocumentId;
       /** The status of the importing of the document. */
       status?: GoogleRpcStatus;
@@ -1101,7 +1101,7 @@ declare namespace gapi.client {
       processorVersion?: string;
     }
     interface GoogleCloudDocumentaiV1beta3Processor {
-      /** Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} */
+      /** Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}. */
       activeSchemaVersion?: string;
       /** Output only. The time the processor was created. */
       createTime?: string;
@@ -1344,7 +1344,7 @@ declare namespace gapi.client {
     interface GoogleCloudDocumentaiV1DisableProcessorRequest {}
     interface GoogleCloudDocumentaiV1DisableProcessorResponse {}
     interface GoogleCloudDocumentaiV1Document {
-      /** Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. */
+      /** Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. */
       blobAssets?: GoogleCloudDocumentaiV1DocumentBlobAsset[];
       /** Document chunked based on chunking config. */
       chunkedDocument?: GoogleCloudDocumentaiV1DocumentChunkedDocument;
@@ -1356,7 +1356,7 @@ declare namespace gapi.client {
       documentLayout?: GoogleCloudDocumentaiV1DocumentDocumentLayout;
       /** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
       entities?: GoogleCloudDocumentaiV1DocumentEntity[];
-      /** 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. */
+      /** The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `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?: GoogleCloudDocumentaiV1DocumentEntitiesRevision[];
@@ -1388,7 +1388,7 @@ declare namespace gapi.client {
       description?: string;
     }
     interface GoogleCloudDocumentaiV1DocumentBlobAsset {
-      /** Optional. The id of the blob asset. */
+      /** Optional. The ID of the blob asset. */
       assetId?: string;
       /** Optional. The content of the blob asset, for example, image bytes. */
       content?: string;
@@ -1442,11 +1442,11 @@ declare namespace gapi.client {
     interface GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkImageChunkField {
       /** Annotation of the image chunk field. */
       annotations?: GoogleCloudDocumentaiV1DocumentAnnotations;
-      /** Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. */
+      /** Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. */
       blobAssetId?: string;
-      /** Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, */
+      /** Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, */
       dataUri?: string;
-      /** Optional. Google Cloud Storage uri of the image. */
+      /** Optional. Google Cloud Storage URI of the image. */
       gcsUri?: string;
     }
     interface GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkTableChunkField {
@@ -1476,11 +1476,11 @@ declare namespace gapi.client {
     interface GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock {
       /** Annotation of the image block. */
       annotations?: GoogleCloudDocumentaiV1DocumentAnnotations;
-      /** Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. */
+      /** Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. */
       blobAssetId?: string;
-      /** Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, */
+      /** Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, */
       dataUri?: string;
-      /** Optional. Google Cloud Storage uri of the image. */
+      /** Optional. Google Cloud Storage URI of the image. */
       gcsUri?: string;
       /** Text extracted from the image using OCR or alt text describing the image. */
       imageText?: string;
@@ -1586,7 +1586,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. */
+      /** A signature, which is 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;
@@ -1898,7 +1898,7 @@ declare namespace gapi.client {
       type?: string;
     }
     interface GoogleCloudDocumentaiV1DocumentProvenance {
-      /** The Id of this operation. Needs to be unique within the scope of the revision. */
+      /** The ID of this operation. Needs to be unique within the scope of the revision. */
       id?: number;
       /** References to the original elements that are replaced. */
       parents?: GoogleCloudDocumentaiV1DocumentProvenanceParent[];
@@ -1916,7 +1916,7 @@ declare namespace gapi.client {
         | 'EVAL_SKIPPED';
     }
     interface GoogleCloudDocumentaiV1DocumentProvenanceParent {
-      /** The id of the parent provenance. */
+      /** The ID of the parent provenance. */
       id?: number;
       /** The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. */
       index?: number;
@@ -1924,13 +1924,13 @@ declare namespace gapi.client {
       revision?: number;
     }
     interface GoogleCloudDocumentaiV1DocumentRevision {
-      /** If the change was made by a person specify the name or id of that person. */
+      /** If the change was made by a person specify the name or ID of that person. */
       agent?: string;
       /** The time that the revision was created, internally generated by doc proto storage at the time of create. */
       createTime?: string;
       /** Human Review information of this revision. */
       humanReview?: GoogleCloudDocumentaiV1DocumentRevisionHumanReview;
-      /** Id of the revision, internally generated by doc proto storage. Unique within the context of the document. */
+      /** ID of the revision, internally generated by doc proto storage. Unique within the context of the document. */
       id?: string;
       /** The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. */
       parent?: number[];
@@ -1954,7 +1954,7 @@ declare namespace gapi.client {
       description?: string;
       /** Display name to show users. */
       displayName?: string;
-      /** Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. */
+      /** Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. */
       documentPrompt?: string;
       /** Entity types of the schema. */
       entityTypes?: GoogleCloudDocumentaiV1DocumentSchemaEntityType[];
@@ -1968,7 +1968,7 @@ declare namespace gapi.client {
       displayName?: string;
       /** If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently, use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file. */
       enumValues?: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues;
-      /** Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - 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 `/` 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. */
+      /** Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - 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 `/` 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. */
       name?: string;
       /** Description the nested structure, or composition of an entity. */
       properties?: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty[];
@@ -2350,7 +2350,7 @@ declare namespace gapi.client {
       includeAncestorHeadings?: boolean;
     }
     interface GoogleCloudDocumentaiV1Processor {
-      /** Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} */
+      /** Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}. */
       activeSchemaVersion?: string;
       /** Output only. The time the processor was created. */
       createTime?: string;
@@ -2617,7 +2617,7 @@ declare namespace gapi.client {
     interface GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions {
       /** Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used. */
       learningRateMultiplier?: number;
-      /** Optional. Resource name of a previously fine tuned version id to copy the overwritten configs from. The base_processor_version should be newer than the base processor version used to fine tune this provided processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. */
+      /** Optional. Resource name of a previously fine tuned version ID to copy the overwritten configs from. The base_processor_version should be newer than the base processor version used to fine tune this provided processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. */
       previousFineTunedProcessorVersionName?: string;
       /** Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used. */
       trainSteps?: number;

package/package.json

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