google-api-python-client 2.164.0__py2.py3-none-any.whl → 2.165.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1.json

@@ -6740,7 +6740,7 @@
 }
 }
 },
-"revision": "20250306",
+"revision": "20250312",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -7597,6 +7597,10 @@
 "description": "Query understanding specification.",
 "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec",
 "properties": {
+"disableSpellCorrection": {
+"description": "Optional. Whether to disable spell correction. The default value is `false`.",
+"type": "boolean"
+},
 "queryClassificationSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec",
 "description": "Query classification specification."
@@ -12127,7 +12131,7 @@
 "type": "string"
 },
 "uri": {
-"description": "Required. The URL for the page the user wants to promote.",
+"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
 "type": "string"
 }
 },
@@ -12160,6 +12164,10 @@
 },
 "type": "array"
 },
+"displaySpec": {
+"$ref": "GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec",
+"description": "Optional. Config for display feature, like match highlighting on search results."
+},
 "facetSpecs": {
 "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "items": {
@@ -12567,6 +12575,27 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec": {
+"description": "Specifies features for display, like match highlighting.",
+"id": "GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec",
+"properties": {
+"matchHighlightingCondition": {
+"description": "The condition under which match highlighting should occur.",
+"enum": [
+"MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED",
+"MATCH_HIGHLIGHTING_DISABLED",
+"MATCH_HIGHLIGHTING_ENABLED"
+],
+"enumDescriptions": [
+"Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.",
+"Disables match highlighting on all documents.",
+"Enables match highlighting on all documents."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1SearchRequestFacetSpec": {
 "description": "A facet specification to perform faceted search.",
 "id": "GoogleCloudDiscoveryengineV1SearchRequestFacetSpec",
@@ -13985,6 +14014,49 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": {
+"description": "The connector level alert config.",
+"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig",
+"properties": {
+"alertEnrollments": {
+"description": "Optional. The enrollment states of each alert.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment"
+},
+"type": "array"
+},
+"alertPolicyName": {
+"description": "Immutable. The fully qualified resource name of the AlertPolicy.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment": {
+"description": "The alert enrollment status.",
+"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment",
+"properties": {
+"alertId": {
+"description": "Immutable. The id of an alert.",
+"type": "string"
+},
+"enrollState": {
+"description": "Required. The enrollment status of a customer.",
+"enum": [
+"ENROLL_STATES_UNSPECIFIED",
+"ENROLLED",
+"DECLINED"
+],
+"enumDescriptions": [
+"Default value. Used for customers who have not responded to the alert policy.",
+"Customer is enrolled in this policy.",
+"Customer declined this policy."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaAnswer": {
 "description": "Defines an answer.",
 "id": "GoogleCloudDiscoveryengineV1alphaAnswer",
@@ -14785,7 +14857,8 @@
 "OVERRUN",
 "CANCELLED",
 "PENDING",
-"WARNING"
+"WARNING",
+"SKIPPED"
 ],
 "enumDescriptions": [
 "Default value.",
@@ -14795,7 +14868,8 @@
 "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
 "Data sync was scheduled but has been cancelled.",
 "Data sync is about to start.",
-"The data sync completed with non-fatal errors."
+"The data sync completed with non-fatal errors.",
+"An ongoing connector run has been running longer than expected, causing this run to be skipped."
 ],
 "readOnly": true,
 "type": "string"
@@ -14881,7 +14955,8 @@
 "OVERRUN",
 "CANCELLED",
 "PENDING",
-"WARNING"
+"WARNING",
+"SKIPPED"
 ],
 "enumDescriptions": [
 "Default value.",
@@ -14891,7 +14966,8 @@
 "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
 "Data sync was scheduled but has been cancelled.",
 "Data sync is about to start.",
-"The data sync completed with non-fatal errors."
+"The data sync completed with non-fatal errors.",
+"An ongoing connector run has been running longer than expected, causing this run to be skipped."
 ],
 "type": "string"
 },
@@ -15297,6 +15373,13 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig",
 "description": "Optional. Action configurations to make the connector support actions."
 },
+"alertPolicyConfigs": {
+"description": "Optional. The connector level alert config.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig"
+},
+"type": "array"
+},
 "autoRunDisabled": {
 "description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.",
 "type": "boolean"
@@ -17874,7 +17957,7 @@
 "type": "string"
 },
 "uri": {
-"description": "Required. The URL for the page the user wants to promote.",
+"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
 "type": "string"
 }
 },
@@ -21131,7 +21214,7 @@
 "type": "string"
 },
 "uri": {
-"description": "Required. The URL for the page the user wants to promote.",
+"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
 "type": "string"
 }
 },
@@ -21164,6 +21247,10 @@
 },
 "type": "array"
 },
+"displaySpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec",
+"description": "Optional. Config for display feature, like match highlighting on search results."
+},
 "embeddingSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",
 "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
@@ -21609,6 +21696,27 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec": {
+"description": "Specifies features for display, like match highlighting.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec",
+"properties": {
+"matchHighlightingCondition": {
+"description": "The condition under which match highlighting should occur.",
+"enum": [
+"MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED",
+"MATCH_HIGHLIGHTING_DISABLED",
+"MATCH_HIGHLIGHTING_ENABLED"
+],
+"enumDescriptions": [
+"Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.",
+"Disables match highlighting on all documents.",
+"Enables match highlighting on all documents."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": {
 "description": "The specification that uses customized query embedding vector to do semantic document retrieval.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",

googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json

@@ -8983,7 +8983,7 @@
 }
 }
 },
-"revision": "20250306",
+"revision": "20250312",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "ApiservingMediaRequestInfo": {
@@ -11591,7 +11591,7 @@
 "type": "string"
 },
 "uri": {
-"description": "Required. The URL for the page the user wants to promote.",
+"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
 "type": "string"
 }
 },
@@ -12609,6 +12609,49 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": {
+"description": "The connector level alert config.",
+"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig",
+"properties": {
+"alertEnrollments": {
+"description": "Optional. The enrollment states of each alert.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment"
+},
+"type": "array"
+},
+"alertPolicyName": {
+"description": "Immutable. The fully qualified resource name of the AlertPolicy.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment": {
+"description": "The alert enrollment status.",
+"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment",
+"properties": {
+"alertId": {
+"description": "Immutable. The id of an alert.",
+"type": "string"
+},
+"enrollState": {
+"description": "Required. The enrollment status of a customer.",
+"enum": [
+"ENROLL_STATES_UNSPECIFIED",
+"ENROLLED",
+"DECLINED"
+],
+"enumDescriptions": [
+"Default value. Used for customers who have not responded to the alert policy.",
+"Customer is enrolled in this policy.",
+"Customer declined this policy."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaAlloyDbSource": {
 "description": "AlloyDB source import data from.",
 "id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource",
@@ -13035,6 +13078,10 @@
 "description": "Query understanding specification.",
 "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec",
 "properties": {
+"disableSpellCorrection": {
+"description": "Optional. Whether to disable spell correction. The default value is `false`.",
+"type": "boolean"
+},
 "queryClassificationSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec",
 "description": "Query classification specification."
@@ -14726,7 +14773,8 @@
 "OVERRUN",
 "CANCELLED",
 "PENDING",
-"WARNING"
+"WARNING",
+"SKIPPED"
 ],
 "enumDescriptions": [
 "Default value.",
@@ -14736,7 +14784,8 @@
 "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
 "Data sync was scheduled but has been cancelled.",
 "Data sync is about to start.",
-"The data sync completed with non-fatal errors."
+"The data sync completed with non-fatal errors.",
+"An ongoing connector run has been running longer than expected, causing this run to be skipped."
 ],
 "readOnly": true,
 "type": "string"
@@ -14822,7 +14871,8 @@
 "OVERRUN",
 "CANCELLED",
 "PENDING",
-"WARNING"
+"WARNING",
+"SKIPPED"
 ],
 "enumDescriptions": [
 "Default value.",
@@ -14832,7 +14882,8 @@
 "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
 "Data sync was scheduled but has been cancelled.",
 "Data sync is about to start.",
-"The data sync completed with non-fatal errors."
+"The data sync completed with non-fatal errors.",
+"An ongoing connector run has been running longer than expected, causing this run to be skipped."
 ],
 "type": "string"
 },
@@ -15500,6 +15551,13 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig",
 "description": "Optional. Action configurations to make the connector support actions."
 },
+"alertPolicyConfigs": {
+"description": "Optional. The connector level alert config.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig"
+},
+"type": "array"
+},
 "autoRunDisabled": {
 "description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.",
 "type": "boolean"
@@ -19994,7 +20052,7 @@
 "type": "string"
 },
 "uri": {
-"description": "Required. The URL for the page the user wants to promote.",
+"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
 "type": "string"
 }
 },
@@ -22753,6 +22811,10 @@
 "description": "Whether web app access is enabled.",
 "type": "boolean"
 },
+"languageCode": {
+"description": "Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is \"en-US\".",
+"type": "string"
+},
 "workforceIdentityPoolProvider": {
 "description": "Optional. The workforce identity pool provider used to access the widget.",
 "type": "string"
@@ -25176,7 +25238,7 @@
 "type": "string"
 },
 "uri": {
-"description": "Required. The URL for the page the user wants to promote.",
+"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
 "type": "string"
 }
 },
@@ -25209,6 +25271,10 @@
 },
 "type": "array"
 },
+"displaySpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec",
+"description": "Optional. Config for display feature, like match highlighting on search results."
+},
 "embeddingSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",
 "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
@@ -25654,6 +25720,27 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec": {
+"description": "Specifies features for display, like match highlighting.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec",
+"properties": {
+"matchHighlightingCondition": {
+"description": "The condition under which match highlighting should occur.",
+"enum": [
+"MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED",
+"MATCH_HIGHLIGHTING_DISABLED",
+"MATCH_HIGHLIGHTING_ENABLED"
+],
+"enumDescriptions": [
+"Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.",
+"Disables match highlighting on all documents.",
+"Enables match highlighting on all documents."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": {
 "description": "The specification that uses customized query embedding vector to do semantic document retrieval.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",

googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json

@@ -7722,7 +7722,7 @@
 }
 }
 },
-"revision": "20250306",
+"revision": "20250312",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -9748,7 +9748,7 @@
 "type": "string"
 },
 "uri": {
-"description": "Required. The URL for the page the user wants to promote.",
+"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
 "type": "string"
 }
 },
@@ -10461,6 +10461,49 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": {
+"description": "The connector level alert config.",
+"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig",
+"properties": {
+"alertEnrollments": {
+"description": "Optional. The enrollment states of each alert.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment"
+},
+"type": "array"
+},
+"alertPolicyName": {
+"description": "Immutable. The fully qualified resource name of the AlertPolicy.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment": {
+"description": "The alert enrollment status.",
+"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment",
+"properties": {
+"alertId": {
+"description": "Immutable. The id of an alert.",
+"type": "string"
+},
+"enrollState": {
+"description": "Required. The enrollment status of a customer.",
+"enum": [
+"ENROLL_STATES_UNSPECIFIED",
+"ENROLLED",
+"DECLINED"
+],
+"enumDescriptions": [
+"Default value. Used for customers who have not responded to the alert policy.",
+"Customer is enrolled in this policy.",
+"Customer declined this policy."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaAnswer": {
 "description": "Defines an answer.",
 "id": "GoogleCloudDiscoveryengineV1alphaAnswer",
@@ -11261,7 +11304,8 @@
 "OVERRUN",
 "CANCELLED",
 "PENDING",
-"WARNING"
+"WARNING",
+"SKIPPED"
 ],
 "enumDescriptions": [
 "Default value.",
@@ -11271,7 +11315,8 @@
 "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
 "Data sync was scheduled but has been cancelled.",
 "Data sync is about to start.",
-"The data sync completed with non-fatal errors."
+"The data sync completed with non-fatal errors.",
+"An ongoing connector run has been running longer than expected, causing this run to be skipped."
 ],
 "readOnly": true,
 "type": "string"
@@ -11357,7 +11402,8 @@
 "OVERRUN",
 "CANCELLED",
 "PENDING",
-"WARNING"
+"WARNING",
+"SKIPPED"
 ],
 "enumDescriptions": [
 "Default value.",
@@ -11367,7 +11413,8 @@
 "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
 "Data sync was scheduled but has been cancelled.",
 "Data sync is about to start.",
-"The data sync completed with non-fatal errors."
+"The data sync completed with non-fatal errors.",
+"An ongoing connector run has been running longer than expected, causing this run to be skipped."
 ],
 "type": "string"
 },
@@ -11773,6 +11820,13 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig",
 "description": "Optional. Action configurations to make the connector support actions."
 },
+"alertPolicyConfigs": {
+"description": "Optional. The connector level alert config.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig"
+},
+"type": "array"
+},
 "autoRunDisabled": {
 "description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.",
 "type": "boolean"
@@ -14350,7 +14404,7 @@
 "type": "string"
 },
 "uri": {
-"description": "Required. The URL for the page the user wants to promote.",
+"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
 "type": "string"
 }
 },
@@ -16387,6 +16441,10 @@
 "description": "Query understanding specification.",
 "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec",
 "properties": {
+"disableSpellCorrection": {
+"description": "Optional. Whether to disable spell correction. The default value is `false`.",
+"type": "boolean"
+},
 "queryClassificationSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec",
 "description": "Query classification specification."
@@ -21607,7 +21665,7 @@
 "type": "string"
 },
 "uri": {
-"description": "Required. The URL for the page the user wants to promote.",
+"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
 "type": "string"
 }
 },
@@ -21640,6 +21698,10 @@
 },
 "type": "array"
 },
+"displaySpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec",
+"description": "Optional. Config for display feature, like match highlighting on search results."
+},
 "embeddingSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",
 "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
@@ -22085,6 +22147,27 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec": {
+"description": "Specifies features for display, like match highlighting.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec",
+"properties": {
+"matchHighlightingCondition": {
+"description": "The condition under which match highlighting should occur.",
+"enum": [
+"MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED",
+"MATCH_HIGHLIGHTING_DISABLED",
+"MATCH_HIGHLIGHTING_ENABLED"
+],
+"enumDescriptions": [
+"Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.",
+"Disables match highlighting on all documents.",
+"Enables match highlighting on all documents."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": {
 "description": "The specification that uses customized query embedding vector to do semantic document retrieval.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",