google-api-python-client 2.170.0__py3-none-any.whl → 2.171.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1.json

@@ -7052,7 +7052,7 @@
 }
 }
 },
-"revision": "20250514",
+"revision": "20250521",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -9187,6 +9187,14 @@
 "readOnly": true,
 "type": "array"
 },
+"annotationMetadata": {
+"description": "Output only. The annotation metadata includes structured content in the current chunk.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata"
+},
+"readOnly": true,
+"type": "array"
+},
 "chunkMetadata": {
 "$ref": "GoogleCloudDiscoveryengineV1ChunkChunkMetadata",
 "description": "Output only. Metadata of the current chunk.",
@@ -9238,6 +9246,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata": {
+"description": "The annotation metadata includes structured content in the current chunk.",
+"id": "GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata",
+"properties": {
+"imageId": {
+"description": "Output only. Image id is provided if the structured content is based on an image.",
+"readOnly": true,
+"type": "string"
+},
+"structuredContent": {
+"$ref": "GoogleCloudDiscoveryengineV1ChunkStructuredContent",
+"description": "Output only. The structured content information.",
+"readOnly": true
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1ChunkChunkMetadata": {
 "description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.",
 "id": "GoogleCloudDiscoveryengineV1ChunkChunkMetadata",
@@ -9299,6 +9324,35 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1ChunkStructuredContent": {
+"description": "The structured content information.",
+"id": "GoogleCloudDiscoveryengineV1ChunkStructuredContent",
+"properties": {
+"content": {
+"description": "Output only. The content of the structured content.",
+"readOnly": true,
+"type": "string"
+},
+"structureType": {
+"description": "Output only. The structure type of the structured content.",
+"enum": [
+"STRUCTURE_TYPE_UNSPECIFIED",
+"SHAREHOLDER_STRUCTURE",
+"SIGNATURE_STRUCTURE",
+"CHECKBOX_STRUCTURE"
+],
+"enumDescriptions": [
+"Default value.",
+"Shareholder structure.",
+"Signature structure.",
+"Checkbox structure."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1CloudSqlSource": {
 "description": "Cloud SQL source import data from.",
 "id": "GoogleCloudDiscoveryengineV1CloudSqlSource",
@@ -10745,6 +10799,13 @@
 "type": "string"
 },
 "type": "array"
+},
+"structuredContentTypes": {
+"description": "Optional. Contains the required structure types to extract from the document. Supported values: * `shareholder-structure`",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -10850,6 +10911,23 @@
 "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.",
 "type": "string"
 },
+"features": {
+"additionalProperties": {
+"enum": [
+"FEATURE_STATE_UNSPECIFIED",
+"FEATURE_STATE_ON",
+"FEATURE_STATE_OFF"
+],
+"enumDescriptions": [
+"The feature state is unspecified.",
+"The feature is turned on to be accessible.",
+"The feature is turned off to be inaccessible."
+],
+"type": "string"
+},
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback`",
+"type": "object"
+},
 "industryVertical": {
 "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
 "enum": [
@@ -14662,10 +14740,6 @@
 "readOnly": true,
 "type": "string"
 },
-"user": {
-"description": "Optional. The full resource name of the User, in the format of `projects/{project}/locations/{location}/userStores/{user_store}/users/{user_id}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created.",
-"type": "string"
-},
 "userPrincipal": {
 "description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.",
 "type": "string"
@@ -15832,7 +15906,7 @@
 "type": "array"
 },
 "extractedRecordCount": {
-"description": "The number of documents extracted from connector source, ready to be ingested to UCS.",
+"description": "The number of documents extracted from connector source, ready to be ingested to VAIS.",
 "format": "int64",
 "type": "string"
 },
@@ -15845,6 +15919,11 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress",
 "description": "Metadata to generate the progress bar."
 },
+"scheduledRecordCount": {
+"description": "The number of documents scheduled to be crawled/extracted from connector source. This only applies to third party connectors.",
+"format": "int64",
+"type": "string"
+},
 "sourceApiRequestCount": {
 "description": "The number of requests sent to 3p API.",
 "format": "int64",
@@ -17172,6 +17251,13 @@
 "type": "string"
 },
 "type": "array"
+},
+"structuredContentTypes": {
+"description": "Optional. Contains the required structure types to extract from the document. Supported values: * `shareholder-structure`",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -17256,6 +17342,23 @@
 "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.",
 "type": "string"
 },
+"features": {
+"additionalProperties": {
+"enum": [
+"FEATURE_STATE_UNSPECIFIED",
+"FEATURE_STATE_ON",
+"FEATURE_STATE_OFF"
+],
+"enumDescriptions": [
+"The feature state is unspecified.",
+"The feature is turned on to be accessible.",
+"The feature is turned off to be inaccessible."
+],
+"type": "string"
+},
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback`",
+"type": "object"
+},
 "industryVertical": {
 "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
 "enum": [
@@ -17494,6 +17597,12 @@
 "readOnly": true,
 "type": "string"
 },
+"lastTrainTime": {
+"description": "Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
 "lastTuneTime": {
 "description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.",
 "format": "google-datetime",
@@ -20358,10 +20467,6 @@
 "readOnly": true,
 "type": "string"
 },
-"user": {
-"description": "Optional. The full resource name of the User, in the format of `projects/{project}/locations/{location}/userStores/{user_store}/users/{user_id}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created.",
-"type": "string"
-},
 "userPrincipal": {
 "description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.",
 "type": "string"
@@ -21377,6 +21482,13 @@
 "type": "string"
 },
 "type": "array"
+},
+"structuredContentTypes": {
+"description": "Optional. Contains the required structure types to extract from the document. Supported values: * `shareholder-structure`",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -21461,6 +21573,23 @@
 "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.",
 "type": "string"
 },
+"features": {
+"additionalProperties": {
+"enum": [
+"FEATURE_STATE_UNSPECIFIED",
+"FEATURE_STATE_ON",
+"FEATURE_STATE_OFF"
+],
+"enumDescriptions": [
+"The feature state is unspecified.",
+"The feature is turned on to be accessible.",
+"The feature is turned off to be inaccessible."
+],
+"type": "string"
+},
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback`",
+"type": "object"
+},
 "industryVertical": {
 "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
 "enum": [

googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json

@@ -9173,7 +9173,7 @@
 }
 }
 },
-"revision": "20250514",
+"revision": "20250521",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "ApiservingMediaRequestInfo": {
@@ -11163,6 +11163,13 @@
 "type": "string"
 },
 "type": "array"
+},
+"structuredContentTypes": {
+"description": "Optional. Contains the required structure types to extract from the document. Supported values: * `shareholder-structure`",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -11247,6 +11254,23 @@
 "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.",
 "type": "string"
 },
+"features": {
+"additionalProperties": {
+"enum": [
+"FEATURE_STATE_UNSPECIFIED",
+"FEATURE_STATE_ON",
+"FEATURE_STATE_OFF"
+],
+"enumDescriptions": [
+"The feature state is unspecified.",
+"The feature is turned on to be accessible.",
+"The feature is turned off to be inaccessible."
+],
+"type": "string"
+},
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback`",
+"type": "object"
+},
 "industryVertical": {
 "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
 "enum": [
@@ -15035,6 +15059,14 @@
 "readOnly": true,
 "type": "array"
 },
+"annotationMetadata": {
+"description": "Output only. The annotation metadata includes structured content in the current chunk.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata"
+},
+"readOnly": true,
+"type": "array"
+},
 "chunkMetadata": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata",
 "description": "Output only. Metadata of the current chunk.",
@@ -15086,6 +15118,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata": {
+"description": "The annotation metadata includes structured content in the current chunk.",
+"id": "GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata",
+"properties": {
+"imageId": {
+"description": "Output only. Image id is provided if the structured content is based on an image.",
+"readOnly": true,
+"type": "string"
+},
+"structuredContent": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaChunkStructuredContent",
+"description": "Output only. The structured content information.",
+"readOnly": true
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata": {
 "description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.",
 "id": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata",
@@ -15147,6 +15196,35 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaChunkStructuredContent": {
+"description": "The structured content information.",
+"id": "GoogleCloudDiscoveryengineV1alphaChunkStructuredContent",
+"properties": {
+"content": {
+"description": "Output only. The content of the structured content.",
+"readOnly": true,
+"type": "string"
+},
+"structureType": {
+"description": "Output only. The structure type of the structured content.",
+"enum": [
+"STRUCTURE_TYPE_UNSPECIFIED",
+"SHAREHOLDER_STRUCTURE",
+"SIGNATURE_STRUCTURE",
+"CHECKBOX_STRUCTURE"
+],
+"enumDescriptions": [
+"Default value.",
+"Shareholder structure.",
+"Signature structure.",
+"Checkbox structure."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaCloudSqlSource": {
 "description": "Cloud SQL source import data from.",
 "id": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource",
@@ -15555,7 +15633,7 @@
 "type": "array"
 },
 "extractedRecordCount": {
-"description": "The number of documents extracted from connector source, ready to be ingested to UCS.",
+"description": "The number of documents extracted from connector source, ready to be ingested to VAIS.",
 "format": "int64",
 "type": "string"
 },
@@ -15568,6 +15646,11 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress",
 "description": "Metadata to generate the progress bar."
 },
+"scheduledRecordCount": {
+"description": "The number of documents scheduled to be crawled/extracted from connector source. This only applies to third party connectors.",
+"format": "int64",
+"type": "string"
+},
 "sourceApiRequestCount": {
 "description": "The number of requests sent to 3p API.",
 "format": "int64",
@@ -17342,6 +17425,13 @@
 "type": "string"
 },
 "type": "array"
+},
+"structuredContentTypes": {
+"description": "Optional. Contains the required structure types to extract from the document. Supported values: * `shareholder-structure`",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -17458,6 +17548,23 @@
 "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.",
 "type": "string"
 },
+"features": {
+"additionalProperties": {
+"enum": [
+"FEATURE_STATE_UNSPECIFIED",
+"FEATURE_STATE_ON",
+"FEATURE_STATE_OFF"
+],
+"enumDescriptions": [
+"The feature state is unspecified.",
+"The feature is turned on to be accessible.",
+"The feature is turned off to be inaccessible."
+],
+"type": "string"
+},
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback`",
+"type": "object"
+},
 "industryVertical": {
 "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
 "enum": [
@@ -17696,6 +17803,12 @@
 "readOnly": true,
 "type": "string"
 },
+"lastTrainTime": {
+"description": "Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
 "lastTuneTime": {
 "description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.",
 "format": "google-datetime",
@@ -23623,10 +23736,6 @@
 "readOnly": true,
 "type": "string"
 },
-"user": {
-"description": "Optional. The full resource name of the User, in the format of `projects/{project}/locations/{location}/userStores/{user_store}/users/{user_id}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created.",
-"type": "string"
-},
 "userPrincipal": {
 "description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.",
 "type": "string"
@@ -24244,6 +24353,24 @@
 "description": "If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.",
 "type": "boolean"
 },
+"features": {
+"additionalProperties": {
+"enum": [
+"FEATURE_STATE_UNSPECIFIED",
+"FEATURE_STATE_ON",
+"FEATURE_STATE_OFF"
+],
+"enumDescriptions": [
+"The feature state is unspecified.",
+"The feature is turned on to be accessible.",
+"The feature is turned off to be inaccessible."
+],
+"type": "string"
+},
+"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback`",
+"readOnly": true,
+"type": "object"
+},
 "generativeAnswerConfig": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig",
 "description": "Describes generative answer configuration."
@@ -25346,6 +25473,13 @@
 "type": "string"
 },
 "type": "array"
+},
+"structuredContentTypes": {
+"description": "Optional. Contains the required structure types to extract from the document. Supported values: * `shareholder-structure`",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -25430,6 +25564,23 @@
 "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.",
 "type": "string"
 },
+"features": {
+"additionalProperties": {
+"enum": [
+"FEATURE_STATE_UNSPECIFIED",
+"FEATURE_STATE_ON",
+"FEATURE_STATE_OFF"
+],
+"enumDescriptions": [
+"The feature state is unspecified.",
+"The feature is turned on to be accessible.",
+"The feature is turned off to be inaccessible."
+],
+"type": "string"
+},
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback`",
+"type": "object"
+},
 "industryVertical": {
 "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
 "enum": [