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

googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json

@@ -96,21 +96,6 @@
 "resources": {
 "assetlinks": {
 "methods": {
-"bulkCheck": {
-"description": "Send a bundle of statement checks in a single RPC to minimize latency and service load. Statements need not be all for the same source and/or target. We recommend using this method when you need to check more than one statement in a short period of time.",
-"flatPath": "v1/assetlinks:bulkCheck",
-"httpMethod": "POST",
-"id": "digitalassetlinks.assetlinks.bulkCheck",
-"parameterOrder": [],
-"parameters": {},
-"path": "v1/assetlinks:bulkCheck",
-"request": {
-"$ref": "BulkCheckRequest"
-},
-"response": {
-"$ref": "BulkCheckResponse"
-}
-},
 "check": {
 "description": "Determines whether the specified (directional) relationship exists between the specified source and target assets. The relation describes the intent of the link between the two assets as claimed by the source asset. An example for such relationships is the delegation of privileges or permissions. This command is most often used by infrastructure systems to check preconditions for an action. For example, a client may want to know if it is OK to send a web URL to a particular mobile app instead. The client can check for the relevant asset link from the website to the mobile app to decide if the operation should be allowed. A note about security: if you specify a secure asset as the source, such as an HTTPS website or an Android app, the API will ensure that any statements used to generate the response have been made in a secure way by the owner of that asset. Conversely, if the source asset is an insecure HTTP website (that is, the URL starts with `http://` instead of `https://`), the API cannot verify its statements securely, and it is not possible to ensure that the website's statements have not been altered by a third party. For more information, see the [Digital Asset Links technical design specification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md).",
 "flatPath": "v1/assetlinks:check",
@@ -199,7 +184,7 @@
 }
 }
 },
-"revision": "20240702",
+"revision": "20241112",
 "rootUrl": "https://digitalassetlinks.googleapis.com/",
 "schemas": {
 "AndroidAppAsset": {
@@ -232,84 +217,6 @@
 },
 "type": "object"
 },
-"BulkCheckRequest": {
-"description": "Message used to check for the existence of multiple digital asset links within a single RPC.",
-"id": "BulkCheckRequest",
-"properties": {
-"allowGoogleInternalDataSources": {
-"description": "Same configuration as in Check request, all statements checks will use same configurations.",
-"type": "boolean"
-},
-"defaultRelation": {
-"description": "If specified, will be used in any given template statement that doesn\u2019t specify a relation.",
-"type": "string"
-},
-"defaultSource": {
-"$ref": "Asset",
-"description": "If specified, will be used in any given template statement that doesn\u2019t specify a source."
-},
-"defaultTarget": {
-"$ref": "Asset",
-"description": "If specified, will be used in any given template statement that doesn\u2019t specify a target."
-},
-"skipCacheLookup": {
-"description": "Same configuration as in Check request, all statements checks will use same configurations.",
-"type": "boolean"
-},
-"statements": {
-"description": "List of statements to check. For each statement, you can omit a field if the corresponding default_* field below was supplied. Minimum 1 statement; maximum 1,000 statements. Any additional statements will be ignored.",
-"items": {
-"$ref": "StatementTemplate"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
-"BulkCheckResponse": {
-"description": "Response for BulkCheck call. Results are sent in a list in the same order in which they were sent. Individual check errors are described in the appropriate check_results entry. If the entire call fails, the response will include a bulk_error_code field describing the error.",
-"id": "BulkCheckResponse",
-"properties": {
-"bulkErrorCode": {
-"description": "Error code for the entire request. Present only if the entire request failed. Individual check errors will not trigger the presence of this field.",
-"enum": [
-"ERROR_CODE_UNSPECIFIED",
-"ERROR_CODE_INVALID_QUERY",
-"ERROR_CODE_FETCH_ERROR",
-"ERROR_CODE_FAILED_SSL_VALIDATION",
-"ERROR_CODE_REDIRECT",
-"ERROR_CODE_TOO_LARGE",
-"ERROR_CODE_MALFORMED_HTTP_RESPONSE",
-"ERROR_CODE_WRONG_CONTENT_TYPE",
-"ERROR_CODE_MALFORMED_CONTENT",
-"ERROR_CODE_SECURE_ASSET_INCLUDES_INSECURE",
-"ERROR_CODE_FETCH_BUDGET_EXHAUSTED"
-],
-"enumDescriptions": [
-"",
-"Unable to parse query.",
-"Unable to fetch the asset links data.",
-"Invalid HTTPS certificate .",
-"HTTP redirects (e.g, 301) are not allowed.",
-"Asset links data exceeds maximum size.",
-"Can't parse HTTP response.",
-"HTTP Content-type should be application/json.",
-"JSON content is malformed.",
-"A secure asset includes an insecure asset (security downgrade).",
-"Too many includes (maybe a loop)."
-],
-"type": "string"
-},
-"checkResults": {
-"description": "List of results for each check request. Results are returned in the same order in which they were sent in the request.",
-"items": {
-"$ref": "CheckResponse"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
 "CertificateInfo": {
 "description": "Describes an X509 certificate.",
 "id": "CertificateInfo",
@@ -346,7 +253,7 @@
 "ERROR_CODE_FETCH_BUDGET_EXHAUSTED"
 ],
 "enumDescriptions": [
-"",
+"Default value, otherwise unused.",
 "Unable to parse query.",
 "Unable to fetch the asset links data.",
 "Invalid HTTPS certificate .",
@@ -399,7 +306,7 @@
 "ERROR_CODE_FETCH_BUDGET_EXHAUSTED"
 ],
 "enumDescriptions": [
-"",
+"Default value, otherwise unused.",
 "Unable to parse query.",
 "Unable to fetch the asset links data.",
 "Invalid HTTPS certificate .",
@@ -449,25 +356,6 @@
 },
 "type": "object"
 },
-"StatementTemplate": {
-"description": "A single statement to check in a bulk call using BulkCheck. See CheckRequest for details about each field.",
-"id": "StatementTemplate",
-"properties": {
-"relation": {
-"description": "The relationship being asserted between the source and target. If omitted, you must specify a BulkCheckRequest.default_relation value to use here.",
-"type": "string"
-},
-"source": {
-"$ref": "Asset",
-"description": "The source asset that is asserting the statement. If omitted, you must specify a BulkCheckRequest.default_source value to use here."
-},
-"target": {
-"$ref": "Asset",
-"description": "The target that the source is declaring the relationship with. If omitted, you must specify a BulkCheckRequest.default_target to use here."
-}
-},
-"type": "object"
-},
 "WebAsset": {
 "description": "Describes a web asset.",
 "id": "WebAsset",

googleapiclient/discovery_cache/documents/discoveryengine.v1.json

@@ -15,6 +15,28 @@
 "description": "Discovery Engine API.",
 "discoveryVersion": "v1",
 "documentationLink": "https://cloud.google.com/generative-ai-app-builder/docs/",
+"endpoints": [
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://discoveryengine.asia-northeast1.rep.googleapis.com/",
+"location": "asia-northeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://discoveryengine.europe-west2.rep.googleapis.com/",
+"location": "europe-west2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://discoveryengine.us.rep.googleapis.com/",
+"location": "us"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://discoveryengine.eu.rep.googleapis.com/",
+"location": "eu"
+}
+],
 "fullyEncodeReservedExpansion": true,
 "icons": {
 "x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -5952,6 +5974,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"import": {
+"description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userEvents:import",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.userEvents.import",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/userEvents:import",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1ImportUserEventsRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "write": {
 "description": "Writes a single user event.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userEvents:write",
@@ -6090,7 +6140,7 @@
 }
 }
 },
-"revision": "20241031",
+"revision": "20241110",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -6763,6 +6813,20 @@
 "description": "Grounding specification.",
 "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec",
 "properties": {
+"filteringLevel": {
+"description": "Optional. Specifies whether to enable the filtering based on grounding score and at what level.",
+"enum": [
+"FILTERING_LEVEL_UNSPECIFIED",
+"FILTERING_LEVEL_LOW",
+"FILTERING_LEVEL_HIGH"
+],
+"enumDescriptions": [
+"Default is no filter",
+"Filter answers based on a low threshold.",
+"Filter answers based on a high threshold."
+],
+"type": "string"
+},
 "includeGroundingSupports": {
 "description": "Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.",
 "type": "boolean"
@@ -6904,7 +6968,7 @@
 "enumDescriptions": [
 "Default value.",
 "Returns documents in the search result.",
-"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
+"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
 ],
 "type": "string"
 }
@@ -7815,7 +7879,7 @@
 "type": "integer"
 },
 "groundingCheckRequired": {
-"description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, anti_citation_indices, and score should not be returned.",
+"description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned.",
 "type": "boolean"
 },
 "startPos": {
@@ -7877,7 +7941,7 @@
 "description": "Page span of the chunk."
 },
 "relevanceScore": {
-"description": "Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse.",
+"description": "Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchResponse.",
 "format": "double",
 "readOnly": true,
 "type": "number"
@@ -9006,6 +9070,11 @@
 "description": "Detailed document information associated with a user event.",
 "id": "GoogleCloudDiscoveryengineV1DocumentInfo",
 "properties": {
+"conversionValue": {
+"description": "Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is \"conversion\". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the `watch` conversion type.",
+"format": "float",
+"type": "number"
+},
 "id": {
 "description": "The Document resource ID.",
 "type": "string"
@@ -9382,80 +9451,6 @@
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1Feedback": {
-"description": "Information about the user feedback. This information will be used for logging and metrics purpose.",
-"id": "GoogleCloudDiscoveryengineV1Feedback",
-"properties": {
-"comment": {
-"description": "Optional. The additional user comment of the feedback if user gives a thumb down.",
-"type": "string"
-},
-"conversationInfo": {
-"$ref": "GoogleCloudDiscoveryengineV1FeedbackConversationInfo",
-"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"
-},
-"GoogleCloudDiscoveryengineV1FeedbackConversationInfo": {
-"description": "The conversation information such as the question index and session name.",
-"id": "GoogleCloudDiscoveryengineV1FeedbackConversationInfo",
-"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"
-},
 "GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse": {
 "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.",
 "id": "GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse",
@@ -10590,7 +10585,7 @@
 "type": "string"
 },
 "score": {
-"description": "The score of this record based on the given query and selected model.",
+"description": "The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset.",
 "format": "float",
 "type": "number"
 },
@@ -11000,7 +10995,7 @@
 "enumDescriptions": [
 "Default value.",
 "Returns documents in the search result.",
-"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
+"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
 ],
 "type": "string"
 },
@@ -11723,6 +11718,11 @@
 "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
 "type": "string"
 },
+"detailedAnswer": {
+"$ref": "GoogleCloudDiscoveryengineV1Answer",
+"description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.",
+"readOnly": true
+},
 "query": {
 "$ref": "GoogleCloudDiscoveryengineV1Query",
 "description": "The user query."
@@ -12140,6 +12140,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1CompletionInfo",
 "description": "CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search."
 },
+"conversionType": {
+"description": "Optional. Conversion type. Required if UserEvent.event_type is `conversion`. This is a customer-defined conversion name in lowercase letters or numbers separated by \"-\", such as \"watch\", \"good-visit\" etc. Do not set the field if UserEvent.event_type is not `conversion`. This mixes the custom conversion event with predefined events like `search`, `view-item` etc.",
+"type": "string"
+},
 "dataStore": {
 "description": "The DataStore resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.",
 "type": "string"
@@ -12165,13 +12169,9 @@
 "type": "string"
 },
 "eventType": {
-"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.",
+"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. Custom conversion value: * `conversion`: Customer defined conversion event.",
 "type": "string"
 },
-"feedback": {
-"$ref": "GoogleCloudDiscoveryengineV1Feedback",
-"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"
@@ -15491,7 +15491,7 @@
 "enumDescriptions": [
 "Default value.",
 "Returns documents in the search result.",
-"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
+"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
 ],
 "type": "string"
 },
@@ -15965,6 +15965,11 @@
 "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
 "type": "string"
 },
+"detailedAnswer": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAnswer",
+"description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.",
+"readOnly": true
+},
 "query": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
 "description": "The user query."
@@ -18338,7 +18343,7 @@
 "enumDescriptions": [
 "Default value.",
 "Returns documents in the search result.",
-"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
+"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
 ],
 "type": "string"
 },