google-api-python-client 2.151.0__py2.py3-none-any.whl → 2.153.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json

@@ -2325,6 +2325,63 @@
 }
 }
 },
+"sitemaps": {
+"methods": {
+"create": {
+"description": "Creates a Sitemap.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+parent}/sitemaps",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSitemap"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a Sitemap.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}",
+"httpMethod": "DELETE",
+"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
 "targetSites": {
 "methods": {
 "batchCreate": {
@@ -5794,6 +5851,94 @@
 }
 },
 "resources": {
+"sitemaps": {
+"methods": {
+"create": {
+"description": "Creates a Sitemap.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+parent}/sitemaps",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSitemap"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a Sitemap.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}",
+"httpMethod": "DELETE",
+"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"fetch": {
+"description": "Fetch Sitemaps in a DataStore.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.fetch",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"matcher.urisMatcher.uris": {
+"description": "The Sitemap uris.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"parent": {
+"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+parent}/sitemaps:fetch",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
 "targetSites": {
 "methods": {
 "batchCreate": {
@@ -7060,7 +7205,7 @@
 }
 }
 },
-"revision": "20241025",
+"revision": "20241031",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -9921,6 +10066,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata": {
+"description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata",
@@ -10262,6 +10424,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata": {
+"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata",
@@ -10850,6 +11029,31 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse": {
+"description": "Response message for SiteSearchEngineService.FetchSitemaps method.",
+"id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse",
+"properties": {
+"sitemapsMetadata": {
+"description": "List of Sitemaps fetched.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata": {
+"description": "Contains a Sitemap and its metadata.",
+"id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata",
+"properties": {
+"sitemap": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSitemap",
+"description": "The Sitemap."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaFieldConfig": {
 "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.",
 "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig",
@@ -12731,6 +12935,28 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSitemap": {
+"description": "A sitemap for the SiteSearchEngine.",
+"id": "GoogleCloudDiscoveryengineV1alphaSitemap",
+"properties": {
+"createTime": {
+"description": "Output only. The sitemap's creation time.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.",
+"readOnly": true,
+"type": "string"
+},
+"uri": {
+"description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaTargetSite": {
 "description": "A target site for the SiteSearchEngine.",
 "id": "GoogleCloudDiscoveryengineV1alphaTargetSite",
@@ -14549,7 +14775,14 @@
 "citedChunks": {
 "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.",
 "items": {
-"$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk"
+"$ref": "GoogleCloudDiscoveryengineV1betaFactChunk"
+},
+"type": "array"
+},
+"citedFacts": {
+"description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk"
 },
 "type": "array"
 },
@@ -14568,6 +14801,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk": {
+"description": "Fact chunk for grounding check.",
+"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk",
+"properties": {
+"chunkText": {
+"description": "Text content of the fact chunk. Can be at most 10K characters long.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim": {
 "description": "Text and citation info for a claim in the answer candidate.",
 "id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim",
@@ -14601,21 +14845,6 @@
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk": {
-"description": "Fact chunk for grounding check.",
-"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk",
-"properties": {
-"chunkText": {
-"description": "Text content of the fact chunk. Can be at most 10K characters long.",
-"type": "string"
-},
-"source": {
-"description": "Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved.",
-"type": "string"
-}
-},
-"type": "object"
-},
 "GoogleCloudDiscoveryengineV1betaCheckGroundingSpec": {
 "description": "Specification for the grounding check.",
 "id": "GoogleCloudDiscoveryengineV1betaCheckGroundingSpec",
@@ -15326,6 +15555,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata": {
+"description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata",
@@ -15669,6 +15915,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata": {
+"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata",
@@ -16282,6 +16545,107 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaFactChunk": {
+"description": "Fact Chunk.",
+"id": "GoogleCloudDiscoveryengineV1betaFactChunk",
+"properties": {
+"chunkText": {
+"description": "Text content of the fact chunk. Can be at most 10K characters long.",
+"type": "string"
+},
+"index": {
+"description": "The index of this chunk. Currently, only used for the streaming mode.",
+"format": "int32",
+"type": "integer"
+},
+"source": {
+"description": "Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.",
+"type": "string"
+},
+"sourceMetadata": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "More fine-grained information for the source reference.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaFeedback": {
+"description": "Information about the user feedback. This information will be used for logging and metrics purpose.",
+"id": "GoogleCloudDiscoveryengineV1betaFeedback",
+"properties": {
+"comment": {
+"description": "Optional. The additional user comment of the feedback if user gives a thumb down.",
+"type": "string"
+},
+"conversationInfo": {
+"$ref": "GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo",
+"description": "The related conversation information when user gives feedback."
+},
+"feedbackType": {
+"description": "Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details.",
+"enum": [
+"FEEDBACK_TYPE_UNSPECIFIED",
+"LIKE",
+"DISLIKE"
+],
+"enumDescriptions": [
+"Unspecified feedback type.",
+"The user gives a positive feedback.",
+"The user gives a negative feedback."
+],
+"type": "string"
+},
+"llmModelVersion": {
+"description": "The version of the LLM model that was used to generate the response.",
+"type": "string"
+},
+"reasons": {
+"description": "Optional. The reason if user gives a thumb down.",
+"items": {
+"enum": [
+"REASON_UNSPECIFIED",
+"INACCURATE_RESPONSE",
+"NOT_RELEVANT",
+"INCOMPREHENSIVE",
+"OFFENSIVE_OR_UNSAFE",
+"BAD_CIATION",
+"FORMAT_AND_STYLES"
+],
+"enumDescriptions": [
+"Unspecified reason.",
+"The response is inaccurate.",
+"The response is not relevant.",
+"The response is incomprehensive.",
+"The response is offensive or unsafe.",
+"The response is not well-associated with the query.",
+"The response is not well-formatted."
+],
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo": {
+"description": "The conversation information such as the question index and session name.",
+"id": "GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo",
+"properties": {
+"questionIndex": {
+"description": "The index of the user input within the conversation messages.",
+"format": "int32",
+"type": "integer"
+},
+"session": {
+"description": "Name of the newly generated or continued session.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse": {
 "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.",
 "id": "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse",
@@ -16305,6 +16669,31 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse": {
+"description": "Response message for SiteSearchEngineService.FetchSitemaps method.",
+"id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse",
+"properties": {
+"sitemapsMetadata": {
+"description": "List of Sitemaps fetched.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata": {
+"description": "Contains a Sitemap and its metadata.",
+"id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata",
+"properties": {
+"sitemap": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSitemap",
+"description": "The Sitemap."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaFhirStoreSource": {
 "description": "Cloud FhirStore source import data from.",
 "id": "GoogleCloudDiscoveryengineV1betaFhirStoreSource",
@@ -17258,6 +17647,13 @@
 "description": "The display name of the panel.",
 "type": "string"
 },
+"documents": {
+"description": "Optional. The document IDs associated with this panel.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaDocumentInfo"
+},
+"type": "array"
+},
 "panelId": {
 "description": "Required. The panel ID.",
 "type": "string"
@@ -19577,6 +19973,28 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSitemap": {
+"description": "A sitemap for the SiteSearchEngine.",
+"id": "GoogleCloudDiscoveryengineV1betaSitemap",
+"properties": {
+"createTime": {
+"description": "Output only. The sitemap's creation time.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.",
+"readOnly": true,
+"type": "string"
+},
+"uri": {
+"description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSpannerSource": {
 "description": "The Spanner source for importing data",
 "id": "GoogleCloudDiscoveryengineV1betaSpannerSource",
@@ -19982,6 +20400,10 @@
 "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc.",
 "type": "string"
 },
+"feedback": {
+"$ref": "GoogleCloudDiscoveryengineV1betaFeedback",
+"description": "Optional. This field is optional except for the `add-feedback` event types."
+},
 "filter": {
 "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "type": "string"
@@ -19998,6 +20420,13 @@
 "$ref": "GoogleCloudDiscoveryengineV1betaPanelInfo",
 "description": "Panel metadata associated with this user event."
 },
+"panels": {
+"description": "Optional. List of panels associated with this event. Used for page-level impression data.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaPanelInfo"
+},
+"type": "array"
+},
 "promotionIds": {
 "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.",
 "items": {