feat(documentai): update the api

#### documentai:v1 The following keys were added: - schemas.GoogleCloudDocumentaiV1ProcessorVersion.properties.genAiModelInfo (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo (Total Keys: 13) #### documentai:v1beta3 The following keys were added: - schemas.GoogleCloudDocumentaiV1beta3ProcessorVersion.properties.genAiModelInfo (Total Keys: 2) - schemas.GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo (Total Keys: 13)
googleapis · Jul 25, 2024 · 0e0445b · 0e0445b
1 parent 7e0a228
commit 0e0445b
Show file tree

Hide file tree

Showing 4 changed files with 184 additions and 2 deletions.
diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html
@@ -436,6 +436,16 @@ <h3>Method Details</h3>
       &quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
     },
   },
+  &quot;genAiModelInfo&quot;: { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions.
+    &quot;customGenAiModelInfo&quot;: { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user.
+      &quot;baseProcessorVersionId&quot;: &quot;A String&quot;, # The base processor version ID for the custom model.
+      &quot;customModelType&quot;: &quot;A String&quot;, # The type of custom model created by the user.
+    },
+    &quot;foundationGenAiModelInfo&quot;: { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model.
+      &quot;finetuningAllowed&quot;: True or False, # Whether finetuning is allowed for this base processor version.
+      &quot;minTrainLabeledDocuments&quot;: 42, # The minimum number of labeled documents in the training dataset required for finetuning.
+    },
+  },
   &quot;googleManaged&quot;: True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
   &quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
   &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.
@@ -535,6 +545,16 @@ <h3>Method Details</h3>
           &quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
         },
       },
+      &quot;genAiModelInfo&quot;: { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions.
+        &quot;customGenAiModelInfo&quot;: { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user.
+          &quot;baseProcessorVersionId&quot;: &quot;A String&quot;, # The base processor version ID for the custom model.
+          &quot;customModelType&quot;: &quot;A String&quot;, # The type of custom model created by the user.
+        },
+        &quot;foundationGenAiModelInfo&quot;: { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model.
+          &quot;finetuningAllowed&quot;: True or False, # Whether finetuning is allowed for this base processor version.
+          &quot;minTrainLabeledDocuments&quot;: 42, # The minimum number of labeled documents in the training dataset required for finetuning.
+        },
+      },
       &quot;googleManaged&quot;: True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
       &quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
       &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.
@@ -2691,6 +2711,16 @@ <h3>Method Details</h3>
         &quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
       },
     },
+    &quot;genAiModelInfo&quot;: { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions.
+      &quot;customGenAiModelInfo&quot;: { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user.
+        &quot;baseProcessorVersionId&quot;: &quot;A String&quot;, # The base processor version ID for the custom model.
+        &quot;customModelType&quot;: &quot;A String&quot;, # The type of custom model created by the user.
+      },
+      &quot;foundationGenAiModelInfo&quot;: { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model.
+        &quot;finetuningAllowed&quot;: True or False, # Whether finetuning is allowed for this base processor version.
+        &quot;minTrainLabeledDocuments&quot;: 42, # The minimum number of labeled documents in the training dataset required for finetuning.
+      },
+    },
     &quot;googleManaged&quot;: True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
     &quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
     &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.

diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html
@@ -474,6 +474,16 @@ <h3>Method Details</h3>
       &quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
     },
   },
+  &quot;genAiModelInfo&quot;: { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions.
+    &quot;customGenAiModelInfo&quot;: { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user.
+      &quot;baseProcessorVersionId&quot;: &quot;A String&quot;, # The base processor version ID for the custom model.
+      &quot;customModelType&quot;: &quot;A String&quot;, # The type of custom model created by the user.
+    },
+    &quot;foundationGenAiModelInfo&quot;: { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model.
+      &quot;finetuningAllowed&quot;: True or False, # Whether finetuning is allowed for this base processor version.
+      &quot;minTrainLabeledDocuments&quot;: 42, # The minimum number of labeled documents in the training dataset required for finetuning.
+    },
+  },
   &quot;googleManaged&quot;: True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
   &quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
   &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.
@@ -631,6 +641,16 @@ <h3>Method Details</h3>
           &quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
         },
       },
+      &quot;genAiModelInfo&quot;: { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions.
+        &quot;customGenAiModelInfo&quot;: { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user.
+          &quot;baseProcessorVersionId&quot;: &quot;A String&quot;, # The base processor version ID for the custom model.
+          &quot;customModelType&quot;: &quot;A String&quot;, # The type of custom model created by the user.
+        },
+        &quot;foundationGenAiModelInfo&quot;: { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model.
+          &quot;finetuningAllowed&quot;: True or False, # Whether finetuning is allowed for this base processor version.
+          &quot;minTrainLabeledDocuments&quot;: 42, # The minimum number of labeled documents in the training dataset required for finetuning.
+        },
+      },
       &quot;googleManaged&quot;: True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
       &quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
       &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.
@@ -3762,6 +3782,16 @@ <h3>Method Details</h3>
         &quot;skipNamingValidation&quot;: True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
       },
     },
+    &quot;genAiModelInfo&quot;: { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions.
+      &quot;customGenAiModelInfo&quot;: { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user.
+        &quot;baseProcessorVersionId&quot;: &quot;A String&quot;, # The base processor version ID for the custom model.
+        &quot;customModelType&quot;: &quot;A String&quot;, # The type of custom model created by the user.
+      },
+      &quot;foundationGenAiModelInfo&quot;: { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model.
+        &quot;finetuningAllowed&quot;: True or False, # Whether finetuning is allowed for this base processor version.
+        &quot;minTrainLabeledDocuments&quot;: 42, # The minimum number of labeled documents in the training dataset required for finetuning.
+      },
+    },
     &quot;googleManaged&quot;: True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
     &quot;kmsKeyName&quot;: &quot;A String&quot;, # The KMS key name used for encryption.
     &quot;kmsKeyVersionName&quot;: &quot;A String&quot;, # The KMS key version with which data is encrypted.

diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json
@@ -1042,7 +1042,7 @@
 }
 }
 },
-"revision": "20240703",
+"revision": "20240716",
 "rootUrl": "https://documentai.googleapis.com/",
 "schemas": {
 "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": {
@@ -4686,6 +4686,11 @@ true
 "$ref": "GoogleCloudDocumentaiV1DocumentSchema",
 "description": "The schema of the processor version. Describes the output."
 },
+"genAiModelInfo": {
+"$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo",
+"description": "Output only. Information about Generative AI model-based processor versions.",
+"readOnly": true
+},
 "googleManaged": {
 "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.",
 "readOnly": true,
@@ -4793,6 +4798,62 @@ true
 },
 "type": "object"
 },
+"GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo": {
+"description": "Information about Generative AI model-based processor versions.",
+"id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo",
+"properties": {
+"customGenAiModelInfo": {
+"$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
+"description": "Information for a custom Generative AI model created by the user."
+},
+"foundationGenAiModelInfo": {
+"$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
+"description": "Information for a pretrained Google-managed foundation model."
+}
+},
+"type": "object"
+},
+"GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": {
+"description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.",
+"id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
+"properties": {
+"baseProcessorVersionId": {
+"description": "The base processor version ID for the custom model.",
+"type": "string"
+},
+"customModelType": {
+"description": "The type of custom model created by the user.",
+"enum": [
+"CUSTOM_MODEL_TYPE_UNSPECIFIED",
+"VERSIONED_FOUNDATION",
+"FINE_TUNED"
+],
+"enumDescriptions": [
+"The model type is unspecified.",
+"The model is a versioned foundation model.",
+"The model is a finetuned foundation model."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": {
+"description": "Information for a pretrained Google-managed foundation model.",
+"id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
+"properties": {
+"finetuningAllowed": {
+"description": "Whether finetuning is allowed for this base processor version.",
+"type": "boolean"
+},
+"minTrainLabeledDocuments": {
+"description": "The minimum number of labeled documents in the training dataset required for finetuning.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "GoogleCloudDocumentaiV1RawDocument": {
 "description": "Payload message of raw document content (bytes).",
 "id": "GoogleCloudDocumentaiV1RawDocument",

diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json
@@ -1284,7 +1284,7 @@
 }
 }
 },
-"revision": "20240703",
+"revision": "20240716",
 "rootUrl": "https://documentai.googleapis.com/",
 "schemas": {
 "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": {
@@ -9293,6 +9293,11 @@ true
 "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchema",
 "description": "The schema of the processor version. Describes the output."
 },
+"genAiModelInfo": {
+"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo",
+"description": "Output only. Information about Generative AI model-based processor versions.",
+"readOnly": true
+},
 "googleManaged": {
 "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.",
 "readOnly": true,
@@ -9400,6 +9405,62 @@ true
 },
 "type": "object"
 },
+"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo": {
+"description": "Information about Generative AI model-based processor versions.",
+"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo",
+"properties": {
+"customGenAiModelInfo": {
+"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
+"description": "Information for a custom Generative AI model created by the user."
+},
+"foundationGenAiModelInfo": {
+"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
+"description": "Information for a pretrained Google-managed foundation model."
+}
+},
+"type": "object"
+},
+"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": {
+"description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.",
+"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
+"properties": {
+"baseProcessorVersionId": {
+"description": "The base processor version ID for the custom model.",
+"type": "string"
+},
+"customModelType": {
+"description": "The type of custom model created by the user.",
+"enum": [
+"CUSTOM_MODEL_TYPE_UNSPECIFIED",
+"VERSIONED_FOUNDATION",
+"FINE_TUNED"
+],
+"enumDescriptions": [
+"The model type is unspecified.",
+"The model is a versioned foundation model.",
+"The model is a finetuned foundation model."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": {
+"description": "Information for a pretrained Google-managed foundation model.",
+"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
+"properties": {
+"finetuningAllowed": {
+"description": "Whether finetuning is allowed for this base processor version.",
+"type": "boolean"
+},
+"minTrainLabeledDocuments": {
+"description": "The minimum number of labeled documents in the training dataset required for finetuning.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "GoogleCloudDocumentaiV1beta3PropertyMetadata": {
 "description": "Metadata about a property.",
 "id": "GoogleCloudDocumentaiV1beta3PropertyMetadata",