@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20221027 → 0.0.20221108

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: 20221027
+// Revision: 20221108
 
 /// <reference types="gapi.client" />
 
@@ -1839,8 +1839,6 @@ declare namespace gapi.client {
             baseTypes?: string[];
             /** User defined name for the type. */
             displayName?: string;
-            /** Metadata for the entity type. */
-            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.
@@ -1865,8 +1863,6 @@ declare namespace gapi.client {
             name?: string;
             /** Occurrence type limits the number of instances an entity type appears in the document. */
             occurrenceType?: string;
-            /** Any additional metadata about the property can be added here. */
-            propertyMetadata?: GoogleCloudDocumentaiV1beta3PropertyMetadata;
             /** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
             valueType?: string;
         }
@@ -1948,9 +1944,81 @@ declare namespace gapi.client {
         // tslint:disable-next-line:no-empty-interface
         interface GoogleCloudDocumentaiV1beta3EnableProcessorResponse {
         }
-        interface GoogleCloudDocumentaiV1beta3EntityTypeMetadata {
-            /** Whether the entity type should be considered as "inactive". */
-            inactive?: boolean;
+        interface GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest {
+            /** Optional. The documents used in the evaluation. If unspecified, use the processor's dataset as evaluation input. */
+            evaluationDocuments?: GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig;
+        }
+        interface GoogleCloudDocumentaiV1beta3Evaluation {
+            /** Metrics for all the entities in aggregate. */
+            allEntitiesMetrics?: GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics;
+            /** The time that the evaluation was created. */
+            createTime?: string;
+            /** Counters for the documents used in the evaluation. */
+            documentCounters?: GoogleCloudDocumentaiV1beta3EvaluationCounters;
+            /** Metrics across confidence levels, for different entities. */
+            entityMetrics?: { [P in string]: GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics };
+            /** The KMS key name used for encryption. */
+            kmsKeyName?: string;
+            /** The KMS key version with which data is encrypted. */
+            kmsKeyVersionName?: string;
+            /** The resource name of the evaluation. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` */
+            name?: string;
+        }
+        interface GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics {
+            /** The confidence level. */
+            confidenceLevel?: number;
+            /** The metrics at the specific confidence level. */
+            metrics?: GoogleCloudDocumentaiV1beta3EvaluationMetrics;
+        }
+        interface GoogleCloudDocumentaiV1beta3EvaluationCounters {
+            /** How many documents were used in the evaluation. */
+            evaluatedDocumentsCount?: number;
+            /** How many documents were not included in the evaluation as Document AI failed to process them. */
+            failedDocumentsCount?: number;
+            /** How many documents were sent for evaluation. */
+            inputDocumentsCount?: number;
+            /** How many documents were not included in the evaluation as they didn't pass validation. */
+            invalidDocumentsCount?: number;
+        }
+        interface GoogleCloudDocumentaiV1beta3EvaluationMetrics {
+            /** The calculated f1 score. */
+            f1Score?: number;
+            /** The amount of false negatives. */
+            falseNegativesCount?: number;
+            /** The amount of false positives. */
+            falsePositivesCount?: number;
+            /** The amount of documents with a ground truth occurrence. */
+            groundTruthDocumentCount?: number;
+            /** The amount of occurrences in ground truth documents. */
+            groundTruthOccurrencesCount?: number;
+            /** The calculated precision. */
+            precision?: number;
+            /** The amount of documents with a predicted occurrence. */
+            predictedDocumentCount?: number;
+            /** The amount of occurrences in predicted documents. */
+            predictedOccurrencesCount?: number;
+            /** The calculated recall. */
+            recall?: number;
+            /** The amount of documents that had an occurrence of this label. */
+            totalDocumentsCount?: number;
+            /** The amount of true positives. */
+            truePositivesCount?: number;
+        }
+        interface GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics {
+            /** The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds. */
+            auprc?: number;
+            /** The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only. */
+            auprcExact?: number;
+            /** Metrics across confidence levels with fuzzy matching enabled. */
+            confidenceLevelMetrics?: GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics[];
+            /** Metrics across confidence levels with only exact matching. */
+            confidenceLevelMetricsExact?: GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics[];
+            /** The Estimated Calibration Error (ECE) of the confidence of the predicted entities. */
+            estimatedCalibrationError?: number;
+            /** The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only. */
+            estimatedCalibrationErrorExact?: number;
+            /** The metrics type for the label. */
+            metricsType?: string;
         }
         interface GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse {
             /** The list of processor types. */
@@ -1981,6 +2049,12 @@ declare namespace gapi.client {
             /** A message providing more details about the human review state. */
             stateMessage?: string;
         }
+        interface GoogleCloudDocumentaiV1beta3ListEvaluationsResponse {
+            /** The evaluations requested. */
+            evaluations?: GoogleCloudDocumentaiV1beta3Evaluation[];
+            /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+            nextPageToken?: string;
+        }
         interface GoogleCloudDocumentaiV1beta3ListProcessorsResponse {
             /** Points to the next processor, otherwise empty. */
             nextPageToken?: string;
@@ -2093,10 +2167,6 @@ declare namespace gapi.client {
             /** The status of human review on the processed document. */
             humanReviewStatus?: GoogleCloudDocumentaiV1beta3HumanReviewStatus;
         }
-        interface GoogleCloudDocumentaiV1beta3PropertyMetadata {
-            /** Whether the property should be considered as "inactive". */
-            inactive?: boolean;
-        }
         interface GoogleCloudDocumentaiV1beta3RawDocument {
             /** Inline document content. */
             content?: string;
@@ -2148,6 +2218,25 @@ declare namespace gapi.client {
         // tslint:disable-next-line:no-empty-interface
         interface GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse {
         }
+        interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest {
+            /**
+             * Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format:
+             * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
+             */
+            baseProcessorVersion?: string;
+            /** Optional. The schema the processor version will be trained with. */
+            documentSchema?: GoogleCloudDocumentaiV1beta3DocumentSchema;
+            /** Optional. The input data used to train the `ProcessorVersion`. */
+            inputData?: GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestInputData;
+            /** Required. The processor version to be created. */
+            processorVersion?: GoogleCloudDocumentaiV1beta3ProcessorVersion;
+        }
+        interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestInputData {
+            /** The documents used for testing the trained version. */
+            testDocuments?: GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig;
+            /** The documents used for training the new version. */
+            trainingDocuments?: GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig;
+        }
         interface GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata {
             /** The basic metadata of the long running operation. */
             commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
@@ -2575,6 +2664,72 @@ declare namespace gapi.client {
             },
             body: GoogleCloudDocumentaiV1beta3ReviewDocumentRequest): Request<GoogleLongrunningOperation>;
         }
+        interface EvaluationsResource {
+            /** Retrieves a specific evaluation. */
+            get(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /**
+                 * Required. The resource name of the Evaluation to get.
+                 * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`
+                 */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<GoogleCloudDocumentaiV1beta3Evaluation>;
+            /** Retrieves a set of evaluations for a given processor version. */
+            list(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** The standard list page size. If unspecified, at most 5 evaluations will be returned. The maximum value is 100; values above 100 will be coerced to 100. */
+                pageSize?: number;
+                /** A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page. */
+                pageToken?: string;
+                /**
+                 * Required. The resource name of the ProcessorVersion to list evaluations for.
+                 * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
+                 */
+                parent: string;
+                /** Returns response with indentations and line breaks. */
+                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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<GoogleCloudDocumentaiV1beta3ListEvaluationsResponse>;
+        }
         interface ProcessorVersionsResource {
             /** LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. */
             batchProcess(request: {
@@ -2721,6 +2876,62 @@ declare namespace gapi.client {
                 uploadType?: string;
             },
             body: GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest): Request<GoogleLongrunningOperation>;
+            /** Evaluates a ProcessorVersion against annotated documents, producing an Evaluation. */
+            evaluateProcessorVersion(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Required. The resource name of the ProcessorVersion to evaluate. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
+                processorVersion: string;
+                /** 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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+                /** Request body */
+                resource: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest;
+            }): Request<GoogleLongrunningOperation>;
+            evaluateProcessorVersion(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Required. The resource name of the ProcessorVersion to evaluate. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
+                processorVersion: string;
+                /** 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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            },
+            body: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest): Request<GoogleLongrunningOperation>;
             /** Gets a processor version detail. */
             get(request?: {
                 /** V1 error format. */
@@ -2844,6 +3055,62 @@ declare namespace gapi.client {
                 uploadType?: string;
             },
             body: GoogleCloudDocumentaiV1beta3ProcessRequest): Request<GoogleCloudDocumentaiV1beta3ProcessResponse>;
+            /** Trains a new processor version. Operation metadata is returned as cloud_documentai_core.TrainProcessorVersionMetadata. */
+            train(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project}/locations/{location}/processors/{processor}`. */
+                parent: string;
+                /** Returns response with indentations and line breaks. */
+                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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+                /** Request body */
+                resource: GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest;
+            }): Request<GoogleLongrunningOperation>;
+            train(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project}/locations/{location}/processors/{processor}`. */
+                parent: string;
+                /** Returns response with indentations and line breaks. */
+                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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            },
+            body: GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest): Request<GoogleLongrunningOperation>;
             /** Undeploys the processor version. */
             undeploy(request: {
                 /** V1 error format. */
@@ -2900,6 +3167,7 @@ declare namespace gapi.client {
                 uploadType?: string;
             },
             body: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest): Request<GoogleLongrunningOperation>;
+            evaluations: EvaluationsResource;
         }
         interface ProcessorsResource {
             /** LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.documentai-v1beta3",
-  "version": "0.0.20221027",
+  "version": "0.0.20221108",
   "description": "TypeScript typings for Cloud Document AI API v1beta3",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,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
 
-// Revision: 20221027
+// Revision: 20221108
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -2621,9 +2621,6 @@ gapi.load('client', async () => {
                             "Test string"
                         ],
                         displayName: "Test string",
-                        entityTypeMetadata: {
-                            inactive: true,
-                        },
                         enumValues: {
                             values: [
                                 "Test string"
@@ -2634,9 +2631,6 @@ gapi.load('client', async () => {
                             {
                                 name: "Test string",
                                 occurrenceType: "Test string",
-                                propertyMetadata: {
-                                    inactive: true,
-                                },
                                 valueType: "Test string",
                             }
                         ],
@@ -3512,6 +3506,24 @@ gapi.load('client', async () => {
             name: "Test string",
         }, {
         });
+        /** Evaluates a ProcessorVersion against annotated documents, producing an Evaluation. */
+        await gapi.client.documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion({
+            processorVersion: "Test string",
+        }, {
+            evaluationDocuments: {
+                gcsDocuments: {
+                    documents: [
+                        {
+                            gcsUri: "Test string",
+                            mimeType: "Test string",
+                        }
+                    ],
+                },
+                gcsPrefix: {
+                    gcsUriPrefix: "Test string",
+                },
+            },
+        });
         /** Gets a processor version detail. */
         await gapi.client.documentai.projects.locations.processors.processorVersions.get({
             name: "Test string",
@@ -5167,11 +5179,130 @@ gapi.load('client', async () => {
             },
             skipHumanReview: true,
         });
+        /** Trains a new processor version. Operation metadata is returned as cloud_documentai_core.TrainProcessorVersionMetadata. */
+        await gapi.client.documentai.projects.locations.processors.processorVersions.train({
+            parent: "Test string",
+        }, {
+            baseProcessorVersion: "Test string",
+            documentSchema: {
+                description: "Test string",
+                displayName: "Test string",
+                entityTypes: [
+                    {
+                        baseTypes: [
+                            "Test string"
+                        ],
+                        displayName: "Test string",
+                        enumValues: {
+                            values: [
+                                "Test string"
+                            ],
+                        },
+                        name: "Test string",
+                        properties: [
+                            {
+                                name: "Test string",
+                                occurrenceType: "Test string",
+                                valueType: "Test string",
+                            }
+                        ],
+                    }
+                ],
+                metadata: {
+                    documentAllowMultipleLabels: true,
+                    documentSplitter: true,
+                    prefixedNamingOnProperties: true,
+                    skipNamingValidation: true,
+                },
+            },
+            inputData: {
+                testDocuments: {
+                    gcsDocuments: {
+                        documents: [
+                            {
+                                gcsUri: "Test string",
+                                mimeType: "Test string",
+                            }
+                        ],
+                    },
+                    gcsPrefix: {
+                        gcsUriPrefix: "Test string",
+                    },
+                },
+                trainingDocuments: {
+                    gcsDocuments: {
+                        documents: [
+                            {
+                                gcsUri: "Test string",
+                                mimeType: "Test string",
+                            }
+                        ],
+                    },
+                    gcsPrefix: {
+                        gcsUriPrefix: "Test string",
+                    },
+                },
+            },
+            processorVersion: {
+                createTime: "Test string",
+                deprecationInfo: {
+                    deprecationTime: "Test string",
+                    replacementProcessorVersion: "Test string",
+                },
+                displayName: "Test string",
+                documentSchema: {
+                    description: "Test string",
+                    displayName: "Test string",
+                    entityTypes: [
+                        {
+                            baseTypes: [
+                                "Test string"
+                            ],
+                            displayName: "Test string",
+                            enumValues: {
+                                values: [
+                                    "Test string"
+                                ],
+                            },
+                            name: "Test string",
+                            properties: [
+                                {
+                                    name: "Test string",
+                                    occurrenceType: "Test string",
+                                    valueType: "Test string",
+                                }
+                            ],
+                        }
+                    ],
+                    metadata: {
+                        documentAllowMultipleLabels: true,
+                        documentSplitter: true,
+                        prefixedNamingOnProperties: true,
+                        skipNamingValidation: true,
+                    },
+                },
+                googleManaged: true,
+                kmsKeyName: "Test string",
+                kmsKeyVersionName: "Test string",
+                name: "Test string",
+                state: "Test string",
+            },
+        });
         /** Undeploys the processor version. */
         await gapi.client.documentai.projects.locations.processors.processorVersions.undeploy({
             name: "Test string",
         }, {
         });
+        /** Retrieves a specific evaluation. */
+        await gapi.client.documentai.projects.locations.processors.processorVersions.evaluations.get({
+            name: "Test string",
+        });
+        /** Retrieves a set of evaluations for a given processor version. */
+        await gapi.client.documentai.projects.locations.processors.processorVersions.evaluations.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
         /** Lists the processor types that exist. */
         await gapi.client.documentai.projects.locations.processorTypes.list({
             pageSize: 42,