google-api-python-client 2.187.0__py3-none-any.whl → 2.189.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/docs.v1.json

@@ -221,9 +221,31 @@
 }
 }
 },
-"revision": "20251022",
+"revision": "20260114",
 "rootUrl": "https://docs.googleapis.com/",
 "schemas": {
+"AddDocumentTabRequest": {
+"description": "Adds a document tab. When a tab is added at a given index, all subsequent tabs' indexes are incremented.",
+"id": "AddDocumentTabRequest",
+"properties": {
+"tabProperties": {
+"$ref": "TabProperties",
+"description": "The properties of the tab to add. All properties are optional."
+}
+},
+"type": "object"
+},
+"AddDocumentTabResponse": {
+"description": "The result of adding a document tab.",
+"id": "AddDocumentTabResponse",
+"properties": {
+"tabProperties": {
+"$ref": "TabProperties",
+"description": "The properties of the newly added tab."
+}
+},
+"type": "object"
+},
 "AutoText": {
 "description": "A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number.",
 "id": "AutoText",
@@ -673,6 +695,141 @@
 },
 "type": "object"
 },
+"DateElement": {
+"description": "A date instance mentioned in a document.",
+"id": "DateElement",
+"properties": {
+"dateElementProperties": {
+"$ref": "DateElementProperties",
+"description": "The properties of this DateElement."
+},
+"dateId": {
+"description": "Output only. The unique ID of this date.",
+"readOnly": true,
+"type": "string"
+},
+"suggestedDateElementPropertiesChanges": {
+"additionalProperties": {
+"$ref": "SuggestedDateElementProperties"
+},
+"description": "The suggested changes to the date element properties, keyed by suggestion ID.",
+"type": "object"
+},
+"suggestedDeletionIds": {
+"description": "IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"suggestedInsertionIds": {
+"description": "IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"suggestedTextStyleChanges": {
+"additionalProperties": {
+"$ref": "SuggestedTextStyle"
+},
+"description": "The suggested text style changes to this DateElement, keyed by suggestion ID.",
+"type": "object"
+},
+"textStyle": {
+"$ref": "TextStyle",
+"description": "The text style of this DateElement."
+}
+},
+"type": "object"
+},
+"DateElementProperties": {
+"description": "Properties of a DateElement.",
+"id": "DateElementProperties",
+"properties": {
+"dateFormat": {
+"description": "Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en_US`, or locale specific equivalent.",
+"enum": [
+"DATE_FORMAT_UNSPECIFIED",
+"DATE_FORMAT_CUSTOM",
+"DATE_FORMAT_MONTH_DAY_ABBREVIATED",
+"DATE_FORMAT_MONTH_DAY_FULL",
+"DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED",
+"DATE_FORMAT_ISO8601"
+],
+"enumDescriptions": [
+"The date format is unspecified.",
+"Output only. The date format is imported from an external source.",
+"The date format is an abbreviated month followed by the day. For example, \"Jan 1\".",
+"The date format is a month followed by the day. For example, \"January 01\".",
+"The date format is an abbreviated month followed by the day and the year. For example, \"Jan 1, 1970\".",
+"The date format is in ISO 8601 format. For example, \"1970-01-01\"."
+],
+"type": "string"
+},
+"displayText": {
+"description": "Output only. Indicates how the DateElement is displayed in the document.",
+"type": "string"
+},
+"locale": {
+"description": "The locale of the document, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `en_US`. If unset, the default locale is `en_US`.",
+"type": "string"
+},
+"timeFormat": {
+"description": "Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown.",
+"enum": [
+"TIME_FORMAT_UNSPECIFIED",
+"TIME_FORMAT_DISABLED",
+"TIME_FORMAT_HOUR_MINUTE",
+"TIME_FORMAT_HOUR_MINUTE_TIMEZONE"
+],
+"enumDescriptions": [
+"The time format is unspecified.",
+"Indicates that the date does not have a time.",
+"The time format shows the hour and minute. For example, \"Jan 1, 1970 12:00 PM\".",
+"The time format shows the hour, minute, and timezone. For example, \"Jan 1, 1970 12:00 PM UTC\"."
+],
+"type": "string"
+},
+"timeZoneId": {
+"description": "The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`.",
+"type": "string"
+},
+"timestamp": {
+"description": "The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"DateElementPropertiesSuggestionState": {
+"description": "A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.",
+"id": "DateElementPropertiesSuggestionState",
+"properties": {
+"dateFormatSuggested": {
+"description": "Indicates if there was a suggested change to date_format.",
+"type": "boolean"
+},
+"localeSuggested": {
+"description": "Indicates if there was a suggested change to locale.",
+"type": "boolean"
+},
+"timeFormatSuggested": {
+"description": "Indicates if there was a suggested change to time_format.",
+"type": "boolean"
+},
+"timeZoneIdSuggested": {
+"description": "Indicates if there was a suggested change to time_zone_id.",
+"type": "boolean"
+},
+"timestampSuggested": {
+"description": "Indicates if there was a suggested change to timestamp.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "DeleteContentRangeRequest": {
 "description": "Deletes content from the document.",
 "id": "DeleteContentRangeRequest",
@@ -759,6 +916,17 @@
 },
 "type": "object"
 },
+"DeleteTabRequest": {
+"description": "Deletes a tab. If the tab has child tabs, they are deleted as well.",
+"id": "DeleteTabRequest",
+"properties": {
+"tabId": {
+"description": "The ID of the tab to delete.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "DeleteTableColumnRequest": {
 "description": "Deletes a column from a table.",
 "id": "DeleteTableColumnRequest",
@@ -1718,6 +1886,25 @@
 },
 "type": "object"
 },
+"InsertDateRequest": {
+"description": "Inserts a date at the specified location.",
+"id": "InsertDateRequest",
+"properties": {
+"dateElementProperties": {
+"$ref": "DateElementProperties",
+"description": "The properties of the date to insert."
+},
+"endOfSegmentLocation": {
+"$ref": "EndOfSegmentLocation",
+"description": "Inserts the date at the end of the given header, footer or document body."
+},
+"location": {
+"$ref": "Location",
+"description": "Inserts the date at a specific index in the document. The date must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between an existing table and its preceding paragraph)."
+}
+},
+"type": "object"
+},
 "InsertInlineImageRequest": {
 "description": "Inserts an InlineObject containing an image at the given location.",
 "id": "InsertInlineImageRequest",
@@ -1788,7 +1975,7 @@
 },
 "location": {
 "$ref": "Location",
-"description": "Inserts the person mention at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). People cannot be inserted inside an equation."
+"description": "Inserts the person mention at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Person mentions cannot be inserted inside an equation."
 },
 "personProperties": {
 "$ref": "PersonProperties",
@@ -2460,6 +2647,10 @@
 "$ref": "ColumnBreak",
 "description": "A column break paragraph element."
 },
+"dateElement": {
+"$ref": "DateElement",
+"description": "A paragraph element that represents a date."
+},
 "endIndex": {
 "description": "The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.",
 "format": "int32",
@@ -3059,6 +3250,10 @@
 "description": "A single update to apply to a document.",
 "id": "Request",
 "properties": {
+"addDocumentTab": {
+"$ref": "AddDocumentTabRequest",
+"description": "Adds a document tab."
+},
 "createFooter": {
 "$ref": "CreateFooterRequest",
 "description": "Creates a footer."
@@ -3103,6 +3298,10 @@
 "$ref": "DeletePositionedObjectRequest",
 "description": "Deletes a positioned object from the document."
 },
+"deleteTab": {
+"$ref": "DeleteTabRequest",
+"description": "Deletes a document tab."
+},
 "deleteTableColumn": {
 "$ref": "DeleteTableColumnRequest",
 "description": "Deletes a column from a table."
@@ -3111,6 +3310,10 @@
 "$ref": "DeleteTableRowRequest",
 "description": "Deletes a row from a table."
 },
+"insertDate": {
+"$ref": "InsertDateRequest",
+"description": "Inserts a date."
+},
 "insertInlineImage": {
 "$ref": "InsertInlineImageRequest",
 "description": "Inserts an inline image at the specified location."
@@ -3171,6 +3374,10 @@
 "$ref": "UpdateDocumentStyleRequest",
 "description": "Updates the style of the document."
 },
+"updateDocumentTabProperties": {
+"$ref": "UpdateDocumentTabPropertiesRequest",
+"description": "Updates the properties of a document tab."
+},
 "updateParagraphStyle": {
 "$ref": "UpdateParagraphStyleRequest",
 "description": "Updates the paragraph style at the specified range."
@@ -3202,6 +3409,10 @@
 "description": "A single response from an update.",
 "id": "Response",
 "properties": {
+"addDocumentTab": {
+"$ref": "AddDocumentTabResponse",
+"description": "The result of adding a document tab."
+},
 "createFooter": {
 "$ref": "CreateFooterResponse",
 "description": "The result of creating a footer."
@@ -3302,18 +3513,15 @@
 "id": "RichLinkProperties",
 "properties": {
 "mimeType": {
-"description": "Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).",
-"readOnly": true,
+"description": "The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).",
 "type": "string"
 },
 "title": {
-"description": "Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.",
-"readOnly": true,
+"description": "The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.",
 "type": "string"
 },
 "uri": {
-"description": "Output only. The URI to the RichLink. This is always present.",
-"readOnly": true,
+"description": "The URI to the RichLink. This is always present.",
 "type": "string"
 }
 },
@@ -3626,6 +3834,21 @@
 },
 "type": "object"
 },
+"SuggestedDateElementProperties": {
+"description": "A suggested change to a DateElementProperties.",
+"id": "SuggestedDateElementProperties",
+"properties": {
+"dateElementProperties": {
+"$ref": "DateElementProperties",
+"description": "DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values."
+},
+"dateElementPropertiesSuggestionState": {
+"$ref": "DateElementPropertiesSuggestionState",
+"description": "A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion."
+}
+},
+"type": "object"
+},
 "SuggestedDocumentStyle": {
 "description": "A suggested change to the DocumentStyle.",
 "id": "SuggestedDocumentStyle",
@@ -3806,7 +4029,7 @@
 "type": "string"
 },
 "tabId": {
-"description": "Output only. The ID of the tab. This field can't be changed.",
+"description": "The immutable ID of the tab.",
 "type": "string"
 },
 "title": {
@@ -4474,6 +4697,22 @@
 },
 "type": "object"
 },
+"UpdateDocumentTabPropertiesRequest": {
+"description": "Update the properties of a document tab.",
+"id": "UpdateDocumentTabPropertiesRequest",
+"properties": {
+"fields": {
+"description": "The fields that should be updated. At least one field must be specified. The root `tab_properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.",
+"format": "google-fieldmask",
+"type": "string"
+},
+"tabProperties": {
+"$ref": "TabProperties",
+"description": "The tab properties to update."
+}
+},
+"type": "object"
+},
 "UpdateParagraphStyleRequest": {
 "description": "Update the styling of all paragraphs that overlap with the given range.",
 "id": "UpdateParagraphStyleRequest",

googleapiclient/discovery_cache/documents/documentai.v1.json

@@ -198,7 +198,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -322,7 +322,7 @@
 "type": "string"
 },
 "returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
 "type": "boolean"
 }
@@ -661,8 +661,10 @@
 },
 "resources": {
 "humanReviewConfig": {
+"deprecated": true,
 "methods": {
 "reviewDocument": {
+"deprecated": true,
 "description": "Send a document for Human Review. The input document should be processed by the specified processor.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/humanReviewConfig:reviewDocument",
 "httpMethod": "POST",
@@ -1392,11 +1394,11 @@
 }
 }
 },
-"revision": "20251020",
+"revision": "20260118",
 "rootUrl": "https://documentai.googleapis.com/",
 "schemas": {
 "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": {
-"description": "Definition of the validation rules. Those are the input to the validator logic and they are used to validate a document.",
+"description": "Definition of the validation rules. Those are the input to the validator logic and they are used to validate a document. Next ID: 3",
 "id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput",
 "properties": {
 "validationRules": {
@@ -1409,6 +1411,7 @@
 "type": "object"
 },
 "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule": {
+"description": "Next ID: 9",
 "id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule",
 "properties": {
 "childAlignmentRule": {
@@ -1433,6 +1436,10 @@
 "name": {
 "description": "Name of the validation rule.",
 "type": "string"
+},
+"ruleId": {
+"description": "Unique identifier of the rule. Optional.",
+"type": "string"
 }
 },
 "type": "object"
@@ -2029,6 +2036,10 @@
 "description": "Display name to show to 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": {
 "description": "Entity types of the schema.",
 "items": {
@@ -3519,6 +3530,7 @@
 "description": "Inference-time options for the process API"
 },
 "skipHumanReview": {
+"deprecated": true,
 "description": "Whether human review should be skipped for this request. Default to `false`.",
 "type": "boolean"
 }
@@ -4062,6 +4074,10 @@
 "$ref": "GoogleCloudDocumentaiV1DocumentEntityValidationOutput",
 "description": "The entity validation output for this revision."
 },
+"provenance": {
+"$ref": "GoogleCloudDocumentaiV1DocumentProvenance",
+"description": "Optional. The history of this revision."
+},
 "revisionId": {
 "description": "The revision id.",
 "type": "string"
@@ -5173,6 +5189,10 @@ true
 "description": "Display name to show to 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": {
 "description": "Entity types of the schema.",
 "items": {
@@ -5809,7 +5829,7 @@ true
 },
 "inlineDocuments": {
 "$ref": "GoogleCloudDocumentaiV1Documents",
-"description": "The set of documents specified inline."
+"description": "The set of documents specified inline. For each document, its `uri` or `content` field must be set."
 },
 "rawDocuments": {
 "$ref": "GoogleCloudDocumentaiV1RawDocuments",
@@ -5996,7 +6016,7 @@ true
 "type": "string"
 },
 "displayName": {
-"description": "Optional. The user-defined name of the Schema.",
+"description": "Required. The user-defined name of the Schema.",
 "type": "string"
 },
 "labels": {
@@ -6240,6 +6260,7 @@ true
 "description": "A raw document content (bytes)."
 },
 "skipHumanReview": {
+"deprecated": true,
 "description": "Whether human review should be skipped for this request. Default to `false`.",
 "type": "boolean"
 }
@@ -6767,7 +6788,7 @@ true
 "type": "string"
 },
 "displayName": {
-"description": "Optional. The user-defined name of the SchemaVersion.",
+"description": "Required. The user-defined name of the SchemaVersion.",
 "type": "string"
 },
 "labels": {
@@ -7386,6 +7407,10 @@ true
 "description": "Display name to show to 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": {
 "description": "Entity types of the schema.",
 "items": {
@@ -8445,7 +8470,7 @@ true
 "type": "array"
 },
 "unreachable": {
-"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
+"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.",
 "items": {
 "type": "string"
 },