google-api-python-client 2.188.0__py3-none-any.whl → 2.190.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/documentai.v1.json

@@ -15,6 +15,43 @@
 "description": "Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.",
 "discoveryVersion": "v1",
 "documentationLink": "https://cloud.google.com/document-ai/docs/",
+"endpoints": [
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://documentai.us.rep.googleapis.com/",
+"location": "us"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://documentai.eu.rep.googleapis.com/",
+"location": "eu"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://documentai.asia-south1.rep.googleapis.com/",
+"location": "asia-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://documentai.asia-southeast1.rep.googleapis.com/",
+"location": "asia-southeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://documentai.northamerica-northeast1.rep.googleapis.com/",
+"location": "northamerica-northeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://documentai.australia-southeast1.rep.googleapis.com/",
+"location": "australia-southeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://documentai.europe-west2.rep.googleapis.com/",
+"location": "europe-west2"
+}
+],
 "fullyEncodeReservedExpansion": true,
 "icons": {
 "x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -189,7 +226,7 @@
 ]
 },
 "list": {
-"description": "Lists information about the supported locations for this service.",
+"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
 "flatPath": "v1/projects/{projectsId}/locations",
 "httpMethod": "GET",
 "id": "documentai.projects.locations.list",
@@ -1122,7 +1159,7 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema.",
+"description": "Optional. Returns the schema groups sorted by creation time. The page token will point to the next Schema.",
 "location": "query",
 "type": "string"
 },
@@ -1159,7 +1196,7 @@
 "type": "string"
 },
 "updateMask": {
-"description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.",
+"description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - `display_name` - `labels`",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -1302,7 +1339,7 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion.",
+"description": "Optional. Returns the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion.",
 "location": "query",
 "type": "string"
 },
@@ -1339,7 +1376,7 @@
 "type": "string"
 },
 "updateMask": {
-"description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.",
+"description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - `display_name` - `labels`",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -1394,7 +1431,7 @@
 }
 }
 },
-"revision": "20260104",
+"revision": "20260203",
 "rootUrl": "https://documentai.googleapis.com/",
 "schemas": {
 "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": {
@@ -1418,7 +1455,7 @@
 "$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule"
 },
 "description": {
-"description": "Description of the validation rule. This has no use but for documentation",
+"description": "Description of the validation rule. This has no use but for documentation.",
 "type": "string"
 },
 "entityAlignmentRule": {
@@ -2033,7 +2070,7 @@
 "type": "string"
 },
 "displayName": {
-"description": "Display name to show to users.",
+"description": "Display name to show users.",
 "type": "string"
 },
 "documentPrompt": {
@@ -2079,10 +2116,10 @@
 },
 "enumValues": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues",
-"description": "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."
+"description": "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."
 },
 "name": {
-"description": "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.",
+"description": "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.",
 "type": "string"
 },
 "properties": {
@@ -2185,7 +2222,7 @@
 "type": "boolean"
 },
 "skipNamingValidation": {
-"description": "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.",
+"description": "If set, this 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.",
 "type": "boolean"
 }
 },
@@ -2266,7 +2303,7 @@
 "id": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics",
 "properties": {
 "f1Score": {
-"description": "The calculated f1 score.",
+"description": "The calculated F1 score.",
 "format": "float",
 "type": "number"
 },
@@ -2886,11 +2923,11 @@
 "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
 "properties": {
 "finetuningAllowed": {
-"description": "Whether finetuning is allowed for this base processor version.",
+"description": "Whether fine tuning is allowed for this base processor version.",
 "type": "boolean"
 },
 "minTrainLabeledDocuments": {
-"description": "The minimum number of labeled documents in the training dataset required for finetuning.",
+"description": "The minimum number of labeled documents in the training dataset required for fine tuning.",
 "format": "int32",
 "type": "integer"
 }
@@ -3100,7 +3137,7 @@
 "type": "string"
 },
 "displayName": {
-"description": "Display name to show to users.",
+"description": "Display name to show users.",
 "type": "string"
 },
 "entityTypes": {
@@ -3706,7 +3743,7 @@
 "type": "array"
 },
 "entitiesRevisionId": {
-"description": "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.",
+"description": "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.",
 "type": "string"
 },
 "entitiesRevisions": {
@@ -4103,7 +4140,7 @@
 "type": "string"
 },
 "mentionText": {
-"description": "Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.",
+"description": "Optional. Text value of the entity, for example, `1600 Amphitheatre Pkwy`.",
 "type": "string"
 },
 "method": {
@@ -4122,7 +4159,7 @@
 },
 "normalizedValue": {
 "$ref": "GoogleCloudDocumentaiV1DocumentEntityNormalizedValue",
-"description": "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."
+"description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (for example, address) is not supported for certain parsers. This field is also only populated for certain supported document types."
 },
 "pageAnchor": {
 "$ref": "GoogleCloudDocumentaiV1DocumentPageAnchor",
@@ -4148,7 +4185,7 @@
 "description": "Optional. Provenance of the entity. Text anchor indexing into the Document.text."
 },
 "type": {
-"description": "Required. Entity type from a schema e.g. `Address`.",
+"description": "Required. Entity type from a schema, for example, `Address`.",
 "type": "string"
 }
 },
@@ -4426,7 +4463,7 @@
 "type": "array"
 },
 "visualElements": {
-"description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.",
+"description": "A list of detected non-text visual elements, for example, checkbox, signature etc. on the page.",
 "items": {
 "$ref": "GoogleCloudDocumentaiV1DocumentPageVisualElement"
 },
@@ -4588,7 +4625,7 @@
 },
 "fieldName": {
 "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
-"description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc."
+"description": "Layout for the FormField name. For example, `Address`, `Email`, `Grand total`, `Phone number`, etc."
 },
 "fieldValue": {
 "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout",
@@ -4689,7 +4726,7 @@
 "description": "The bounding polygon for the Layout."
 },
 "confidence": {
-"description": "Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.",
+"description": "Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.",
 "format": "float",
 "type": "number"
 },
@@ -5014,7 +5051,7 @@
 "type": "object"
 },
 "GoogleCloudDocumentaiV1DocumentPageVisualElement": {
-"description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.",
+"description": "Detected non-text visual elements, for example, checkbox, signature etc. on the page.",
 "id": "GoogleCloudDocumentaiV1DocumentPageVisualElement",
 "properties": {
 "detectedLanguages": {
@@ -5167,7 +5204,7 @@ true
 "id": "GoogleCloudDocumentaiV1DocumentRevisionHumanReview",
 "properties": {
 "state": {
-"description": "Human review state. e.g. `requested`, `succeeded`, `rejected`.",
+"description": "Human review state. For example, `requested`, `succeeded`, `rejected`.",
 "type": "string"
 },
 "stateMessage": {
@@ -5186,7 +5223,11 @@ true
 "type": "string"
 },
 "displayName": {
-"description": "Display name to show to users.",
+"description": "Display name to show users.",
+"type": "string"
+},
+"documentPrompt": {
+"description": "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.",
 "type": "string"
 },
 "entityTypes": {
@@ -5220,10 +5261,10 @@ true
 },
 "enumValues": {
 "$ref": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues",
-"description": "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."
+"description": "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."
 },
 "name": {
-"description": "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.",
+"description": "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.",
 "type": "string"
 },
 "properties": {
@@ -5318,7 +5359,7 @@ true
 "type": "boolean"
 },
 "skipNamingValidation": {
-"description": "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.",
+"description": "If set, this 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.",
 "type": "boolean"
 }
 },
@@ -5564,6 +5605,13 @@ true
 "name": {
 "description": "The resource name of the evaluation. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`",
 "type": "string"
+},
+"revisions": {
+"description": "Contains all revisions of the evaluation, excluding the latest one.",
+"items": {
+"$ref": "GoogleCloudDocumentaiV1EvaluationEvaluationRevision"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -5611,12 +5659,42 @@ true
 },
 "type": "object"
 },
+"GoogleCloudDocumentaiV1EvaluationEvaluationRevision": {
+"description": "A revision of the evaluation.",
+"id": "GoogleCloudDocumentaiV1EvaluationEvaluationRevision",
+"properties": {
+"allEntitiesMetrics": {
+"$ref": "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics",
+"description": "Output only. Metrics for all the entities in aggregate.",
+"readOnly": true
+},
+"documentCounters": {
+"$ref": "GoogleCloudDocumentaiV1EvaluationCounters",
+"description": "Output only. Counters for the documents used in the evaluation.",
+"readOnly": true
+},
+"entityMetrics": {
+"additionalProperties": {
+"$ref": "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics"
+},
+"description": "Output only. Metrics across confidence levels, for different entities.",
+"readOnly": true,
+"type": "object"
+},
+"revisionId": {
+"description": "Output only. The revision ID of the evaluation.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDocumentaiV1EvaluationMetrics": {
 "description": "Evaluation metrics, either in aggregate or about a specific entity.",
 "id": "GoogleCloudDocumentaiV1EvaluationMetrics",
 "properties": {
 "f1Score": {
-"description": "The calculated f1 score.",
+"description": "The calculated F1 score.",
 "format": "float",
 "type": "number"
 },
@@ -6019,7 +6097,7 @@ true
 "additionalProperties": {
 "type": "string"
 },
-"description": "Optional. The GCP labels for the Schema.",
+"description": "Optional. The {{gcp_name_short}} labels for the Schema.",
 "type": "object"
 },
 "name": {
@@ -6620,11 +6698,11 @@ true
 "id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
 "properties": {
 "finetuningAllowed": {
-"description": "Whether finetuning is allowed for this base processor version.",
+"description": "Whether fine tuning is allowed for this base processor version.",
 "type": "boolean"
 },
 "minTrainLabeledDocuments": {
-"description": "The minimum number of labeled documents in the training dataset required for finetuning.",
+"description": "The minimum number of labeled documents in the training dataset required for fine tuning.",
 "format": "int32",
 "type": "integer"
 }
@@ -6791,7 +6869,7 @@ true
 "additionalProperties": {
 "type": "string"
 },
-"description": "Optional. The GCP labels for the SchemaVersion.",
+"description": "Optional. The {{gcp_name_short}} labels for the SchemaVersion.",
 "type": "object"
 },
 "name": {
@@ -7222,10 +7300,6 @@ true
 "readOnly": true,
 "type": "boolean"
 },
-"spannerIndexingConfig": {
-"$ref": "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig",
-"description": "Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search."
-},
 "state": {
 "description": "Required. State of the dataset. Ignored when updating dataset.",
 "enum": [
@@ -7277,12 +7351,6 @@ true
 },
 "type": "object"
 },
-"GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig": {
-"description": "Configuration specific to spanner-based indexing.",
-"id": "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig",
-"properties": {},
-"type": "object"
-},
 "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig": {
 "description": "Configuration specific to an unmanaged dataset.",
 "id": "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig",
@@ -7400,7 +7468,11 @@ true
 "type": "string"
 },
 "displayName": {
-"description": "Display name to show to users.",
+"description": "Display name to show users.",
+"type": "string"
+},
+"documentPrompt": {
+"description": "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.",
 "type": "string"
 },
 "entityTypes": {
@@ -7442,10 +7514,10 @@ true
 },
 "enumValues": {
 "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues",
-"description": "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."
+"description": "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."
 },
 "name": {
-"description": "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.",
+"description": "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.",
 "type": "string"
 },
 "properties": {
@@ -7548,7 +7620,7 @@ true
 "type": "boolean"
 },
 "skipNamingValidation": {
-"description": "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.",
+"description": "If set, this 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.",
 "type": "boolean"
 }
 },
@@ -7609,7 +7681,7 @@ true
 "id": "GoogleCloudDocumentaiV1beta3EvaluationMetrics",
 "properties": {
 "f1Score": {
-"description": "The calculated f1 score.",
+"description": "The calculated F1 score.",
 "format": "float",
 "type": "number"
 },
@@ -8106,11 +8178,11 @@ true
 "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
 "properties": {
 "finetuningAllowed": {
-"description": "Whether finetuning is allowed for this base processor version.",
+"description": "Whether fine tuning is allowed for this base processor version.",
 "type": "boolean"
 },
 "minTrainLabeledDocuments": {
-"description": "The minimum number of labeled documents in the training dataset required for finetuning.",
+"description": "The minimum number of labeled documents in the training dataset required for fine tuning.",
 "format": "int32",
 "type": "integer"
 }