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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (105) hide show
  1. {google_api_python_client-2.153.0.dist-info → google_api_python_client-2.154.0.dist-info}/METADATA +1 -1
  2. {google_api_python_client-2.153.0.dist-info → google_api_python_client-2.154.0.dist-info}/RECORD +105 -105
  3. googleapiclient/discovery_cache/documents/addressvalidation.v1.json +3 -3
  4. googleapiclient/discovery_cache/documents/admin.directory_v1.json +2 -2
  5. googleapiclient/discovery_cache/documents/admin.directoryv1.json +2 -2
  6. googleapiclient/discovery_cache/documents/aiplatform.v1.json +664 -15
  7. googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +326 -13
  8. googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +5 -1
  9. googleapiclient/discovery_cache/documents/androidenterprise.v1.json +66 -4
  10. googleapiclient/discovery_cache/documents/androidmanagement.v1.json +4 -4
  11. googleapiclient/discovery_cache/documents/backupdr.v1.json +2 -2
  12. googleapiclient/discovery_cache/documents/batch.v1.json +10 -10
  13. googleapiclient/discovery_cache/documents/beyondcorp.v1.json +1 -69
  14. googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +1 -69
  15. googleapiclient/discovery_cache/documents/chat.v1.json +5 -5
  16. googleapiclient/discovery_cache/documents/checks.v1alpha.json +2 -2
  17. googleapiclient/discovery_cache/documents/cloudasset.v1.json +11 -7
  18. googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +5 -1
  19. googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +5 -1
  20. googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +5 -1
  21. googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +2 -2
  22. googleapiclient/discovery_cache/documents/cloudchannel.v1.json +2 -2
  23. googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +3 -3
  24. googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +2 -2
  25. googleapiclient/discovery_cache/documents/cloudsearch.v1.json +1 -63
  26. googleapiclient/discovery_cache/documents/cloudtasks.v2.json +2 -2
  27. googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +3 -3
  28. googleapiclient/discovery_cache/documents/compute.alpha.json +9 -1
  29. googleapiclient/discovery_cache/documents/compute.beta.json +9 -1
  30. googleapiclient/discovery_cache/documents/config.v1.json +3 -3
  31. googleapiclient/discovery_cache/documents/connectors.v1.json +155 -1
  32. googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +21 -5
  33. googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +51 -996
  34. googleapiclient/discovery_cache/documents/container.v1.json +2 -2
  35. googleapiclient/discovery_cache/documents/container.v1beta1.json +2 -2
  36. googleapiclient/discovery_cache/documents/dataform.v1beta1.json +6 -6
  37. googleapiclient/discovery_cache/documents/datalineage.v1.json +11 -1
  38. googleapiclient/discovery_cache/documents/datamigration.v1.json +5 -1
  39. googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +17 -8
  40. googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +17 -8
  41. googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +17 -8
  42. googleapiclient/discovery_cache/documents/developerconnect.v1.json +2 -2
  43. googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +3 -3
  44. googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +3 -3
  45. googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +3 -115
  46. googleapiclient/discovery_cache/documents/discoveryengine.v1.json +92 -87
  47. googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +101 -107
  48. googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +77 -86
  49. googleapiclient/discovery_cache/documents/displayvideo.v2.json +6 -6
  50. googleapiclient/discovery_cache/documents/displayvideo.v3.json +6 -6
  51. googleapiclient/discovery_cache/documents/dlp.v2.json +9 -5
  52. googleapiclient/discovery_cache/documents/drive.v3.json +147 -106
  53. googleapiclient/discovery_cache/documents/fcm.v1.json +2 -2
  54. googleapiclient/discovery_cache/documents/file.v1.json +2 -2
  55. googleapiclient/discovery_cache/documents/file.v1beta1.json +3 -3
  56. googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +2 -2
  57. googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +195 -1
  58. googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +112 -1
  59. googleapiclient/discovery_cache/documents/gkebackup.v1.json +2 -2
  60. googleapiclient/discovery_cache/documents/gkehub.v1.json +11 -1
  61. googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +11 -1
  62. googleapiclient/discovery_cache/documents/gkehub.v1beta.json +11 -1
  63. googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +11 -1
  64. googleapiclient/discovery_cache/documents/gkeonprem.v1.json +7 -2
  65. googleapiclient/discovery_cache/documents/healthcare.v1.json +21 -21
  66. googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +2 -2
  67. googleapiclient/discovery_cache/documents/integrations.v1.json +3 -1
  68. googleapiclient/discovery_cache/documents/language.v1beta2.json +4 -4
  69. googleapiclient/discovery_cache/documents/language.v2.json +10 -10
  70. googleapiclient/discovery_cache/documents/looker.v1.json +2 -2
  71. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +10 -10
  72. googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +3 -3
  73. googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +2 -2
  74. googleapiclient/discovery_cache/documents/netapp.v1.json +477 -7
  75. googleapiclient/discovery_cache/documents/netapp.v1beta1.json +477 -7
  76. googleapiclient/discovery_cache/documents/networkmanagement.v1.json +12 -6
  77. googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +12 -6
  78. googleapiclient/discovery_cache/documents/networksecurity.v1.json +535 -2
  79. googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +5 -5
  80. googleapiclient/discovery_cache/documents/networkservices.v1.json +570 -35
  81. googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +271 -35
  82. googleapiclient/discovery_cache/documents/notebooks.v1.json +6 -6
  83. googleapiclient/discovery_cache/documents/notebooks.v2.json +2 -2
  84. googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +4 -4
  85. googleapiclient/discovery_cache/documents/privateca.v1.json +8 -8
  86. googleapiclient/discovery_cache/documents/run.v2.json +20 -1
  87. googleapiclient/discovery_cache/documents/securitycenter.v1.json +97 -3
  88. googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +65 -3
  89. googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +65 -3
  90. googleapiclient/discovery_cache/documents/servicemanagement.v1.json +6 -2
  91. googleapiclient/discovery_cache/documents/servicenetworking.v1.json +8 -1
  92. googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +8 -1
  93. googleapiclient/discovery_cache/documents/speech.v1.json +21 -1
  94. googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +21 -1
  95. googleapiclient/discovery_cache/documents/sqladmin.v1.json +157 -84
  96. googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +157 -96
  97. googleapiclient/discovery_cache/documents/storage.v1.json +23 -2
  98. googleapiclient/discovery_cache/documents/sts.v1.json +9 -2
  99. googleapiclient/discovery_cache/documents/sts.v1beta.json +8 -1
  100. googleapiclient/discovery_cache/documents/texttospeech.v1.json +2 -2
  101. googleapiclient/discovery_cache/documents/walletobjects.v1.json +5 -1
  102. googleapiclient/version.py +1 -1
  103. {google_api_python_client-2.153.0.dist-info → google_api_python_client-2.154.0.dist-info}/LICENSE +0 -0
  104. {google_api_python_client-2.153.0.dist-info → google_api_python_client-2.154.0.dist-info}/WHEEL +0 -0
  105. {google_api_python_client-2.153.0.dist-info → google_api_python_client-2.154.0.dist-info}/top_level.txt +0 -0
@@ -15,6 +15,28 @@
15
15
  "description": "Discovery Engine API.",
16
16
  "discoveryVersion": "v1",
17
17
  "documentationLink": "https://cloud.google.com/generative-ai-app-builder/docs/",
18
+ "endpoints": [
19
+ {
20
+ "description": "Regional Endpoint",
21
+ "endpointUrl": "https://discoveryengine.asia-northeast1.rep.googleapis.com/",
22
+ "location": "asia-northeast1"
23
+ },
24
+ {
25
+ "description": "Regional Endpoint",
26
+ "endpointUrl": "https://discoveryengine.europe-west2.rep.googleapis.com/",
27
+ "location": "europe-west2"
28
+ },
29
+ {
30
+ "description": "Regional Endpoint",
31
+ "endpointUrl": "https://discoveryengine.us.rep.googleapis.com/",
32
+ "location": "us"
33
+ },
34
+ {
35
+ "description": "Regional Endpoint",
36
+ "endpointUrl": "https://discoveryengine.eu.rep.googleapis.com/",
37
+ "location": "eu"
38
+ }
39
+ ],
18
40
  "fullyEncodeReservedExpansion": true,
19
41
  "icons": {
20
42
  "x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -7823,6 +7845,34 @@
7823
7845
  "https://www.googleapis.com/auth/cloud-platform"
7824
7846
  ]
7825
7847
  },
7848
+ "import": {
7849
+ "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.",
7850
+ "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:import",
7851
+ "httpMethod": "POST",
7852
+ "id": "discoveryengine.projects.locations.userEvents.import",
7853
+ "parameterOrder": [
7854
+ "parent"
7855
+ ],
7856
+ "parameters": {
7857
+ "parent": {
7858
+ "description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`",
7859
+ "location": "path",
7860
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
7861
+ "required": true,
7862
+ "type": "string"
7863
+ }
7864
+ },
7865
+ "path": "v1alpha/{+parent}/userEvents:import",
7866
+ "request": {
7867
+ "$ref": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest"
7868
+ },
7869
+ "response": {
7870
+ "$ref": "GoogleLongrunningOperation"
7871
+ },
7872
+ "scopes": [
7873
+ "https://www.googleapis.com/auth/cloud-platform"
7874
+ ]
7875
+ },
7826
7876
  "write": {
7827
7877
  "description": "Writes a single user event.",
7828
7878
  "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write",
@@ -8007,7 +8057,7 @@
8007
8057
  }
8008
8058
  }
8009
8059
  },
8010
- "revision": "20241031",
8060
+ "revision": "20241110",
8011
8061
  "rootUrl": "https://discoveryengine.googleapis.com/",
8012
8062
  "schemas": {
8013
8063
  "GoogleApiDistribution": {
@@ -10719,7 +10769,7 @@
10719
10769
  "enumDescriptions": [
10720
10770
  "Default value.",
10721
10771
  "Returns documents in the search result.",
10722
- "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
10772
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
10723
10773
  ],
10724
10774
  "type": "string"
10725
10775
  }
@@ -11630,7 +11680,7 @@
11630
11680
  "type": "integer"
11631
11681
  },
11632
11682
  "groundingCheckRequired": {
11633
- "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.",
11683
+ "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.",
11634
11684
  "type": "boolean"
11635
11685
  },
11636
11686
  "startPos": {
@@ -11695,20 +11745,8 @@
11695
11745
  "$ref": "GoogleTypeExpr",
11696
11746
  "description": "The condition for evaluating the requirement result."
11697
11747
  },
11698
- "requirementResult": {
11699
- "description": "Requirement result, e.g. pass or fail.",
11700
- "enum": [
11701
- "UNKNOWN",
11702
- "SUCCESS",
11703
- "FAILURE",
11704
- "WARNING"
11705
- ],
11706
- "enumDescriptions": [
11707
- "The requirement is unknown.",
11708
- "The requirement check is passed.",
11709
- "The requirement check fails to meet at least one blocking threshold.",
11710
- "The requirement check fails at least one warning threshold, but passes all blocking thresholds."
11711
- ],
11748
+ "result": {
11749
+ "description": "The result of the requirement. It should be one of the `severity` fields in the requirement definition. If any error happens during the evaluation, it will be `UNKNOWN`.",
11712
11750
  "type": "string"
11713
11751
  }
11714
11752
  },
@@ -11781,7 +11819,7 @@
11781
11819
  "description": "Page span of the chunk."
11782
11820
  },
11783
11821
  "relevanceScore": {
11784
- "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.",
11822
+ "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.",
11785
11823
  "format": "double",
11786
11824
  "readOnly": true,
11787
11825
  "type": "number"
@@ -13047,6 +13085,11 @@
13047
13085
  "description": "Detailed document information associated with a user event.",
13048
13086
  "id": "GoogleCloudDiscoveryengineV1alphaDocumentInfo",
13049
13087
  "properties": {
13088
+ "conversionValue": {
13089
+ "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.",
13090
+ "format": "float",
13091
+ "type": "number"
13092
+ },
13050
13093
  "id": {
13051
13094
  "description": "The Document resource ID.",
13052
13095
  "type": "string"
@@ -13749,80 +13792,6 @@
13749
13792
  },
13750
13793
  "type": "object"
13751
13794
  },
13752
- "GoogleCloudDiscoveryengineV1alphaFeedback": {
13753
- "description": "Information about the user feedback. This information will be used for logging and metrics purpose.",
13754
- "id": "GoogleCloudDiscoveryengineV1alphaFeedback",
13755
- "properties": {
13756
- "comment": {
13757
- "description": "Optional. The additional user comment of the feedback if user gives a thumb down.",
13758
- "type": "string"
13759
- },
13760
- "conversationInfo": {
13761
- "$ref": "GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo",
13762
- "description": "The related conversation information when user gives feedback."
13763
- },
13764
- "feedbackType": {
13765
- "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.",
13766
- "enum": [
13767
- "FEEDBACK_TYPE_UNSPECIFIED",
13768
- "LIKE",
13769
- "DISLIKE"
13770
- ],
13771
- "enumDescriptions": [
13772
- "Unspecified feedback type.",
13773
- "The user gives a positive feedback.",
13774
- "The user gives a negative feedback."
13775
- ],
13776
- "type": "string"
13777
- },
13778
- "llmModelVersion": {
13779
- "description": "The version of the LLM model that was used to generate the response.",
13780
- "type": "string"
13781
- },
13782
- "reasons": {
13783
- "description": "Optional. The reason if user gives a thumb down.",
13784
- "items": {
13785
- "enum": [
13786
- "REASON_UNSPECIFIED",
13787
- "INACCURATE_RESPONSE",
13788
- "NOT_RELEVANT",
13789
- "INCOMPREHENSIVE",
13790
- "OFFENSIVE_OR_UNSAFE",
13791
- "BAD_CIATION",
13792
- "FORMAT_AND_STYLES"
13793
- ],
13794
- "enumDescriptions": [
13795
- "Unspecified reason.",
13796
- "The response is inaccurate.",
13797
- "The response is not relevant.",
13798
- "The response is incomprehensive.",
13799
- "The response is offensive or unsafe.",
13800
- "The response is not well-associated with the query.",
13801
- "The response is not well-formatted."
13802
- ],
13803
- "type": "string"
13804
- },
13805
- "type": "array"
13806
- }
13807
- },
13808
- "type": "object"
13809
- },
13810
- "GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo": {
13811
- "description": "The conversation information such as the question index and session name.",
13812
- "id": "GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo",
13813
- "properties": {
13814
- "questionIndex": {
13815
- "description": "The index of the user input within the conversation messages.",
13816
- "format": "int32",
13817
- "type": "integer"
13818
- },
13819
- "session": {
13820
- "description": "Name of the newly generated or continued session.",
13821
- "type": "string"
13822
- }
13823
- },
13824
- "type": "object"
13825
- },
13826
13795
  "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": {
13827
13796
  "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.",
13828
13797
  "id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse",
@@ -15664,7 +15633,7 @@
15664
15633
  "type": "string"
15665
15634
  },
15666
15635
  "score": {
15667
- "description": "The score of this record based on the given query and selected model.",
15636
+ "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.",
15668
15637
  "format": "float",
15669
15638
  "type": "number"
15670
15639
  },
@@ -16007,6 +15976,13 @@
16007
15976
  },
16008
15977
  "type": "array"
16009
15978
  },
15979
+ "severity": {
15980
+ "description": "The severity of errors if the requirement is not met. It must be ordered from the most strict to the least strict. Examples: * `BLOCKING` * `CRITICAL` * `WARNING` All thresholds in the requirement must have all the severity here.",
15981
+ "items": {
15982
+ "type": "string"
15983
+ },
15984
+ "type": "array"
15985
+ },
16010
15986
  "thresholdBindings": {
16011
15987
  "description": "A list of threshold bindings to be used in `condition`.",
16012
15988
  "items": {
@@ -16059,21 +16035,34 @@
16059
16035
  "description": "Specifies a multi-level threshold to apply to apply to a `metric_bindings` in the `condition` CEL expression.",
16060
16036
  "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding",
16061
16037
  "properties": {
16062
- "blockingThreshold": {
16063
- "description": "Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a `FAILURE`.",
16064
- "format": "double",
16065
- "type": "number"
16066
- },
16067
16038
  "description": {
16068
16039
  "description": "Human readable description of the corresponding threshold and sub-requirement.",
16069
16040
  "type": "string"
16070
16041
  },
16042
+ "thresholdValues": {
16043
+ "description": "The values of the threshold. The values should be ordered from the most strict to the least strict.",
16044
+ "items": {
16045
+ "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue"
16046
+ },
16047
+ "type": "array"
16048
+ },
16071
16049
  "variableId": {
16072
16050
  "description": "The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`.",
16073
16051
  "type": "string"
16052
+ }
16074
16053
  },
16075
- "warningThreshold": {
16076
- "description": "Threshold to trigger a warning. If not met, the requirement will evaluate as a `WARNING`.",
16054
+ "type": "object"
16055
+ },
16056
+ "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue": {
16057
+ "description": "Specifies a threshold value for a given severity.",
16058
+ "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue",
16059
+ "properties": {
16060
+ "severity": {
16061
+ "description": "The severity of errors if the threshold is not met. It should be one of the `severity` fields in the requirement.",
16062
+ "type": "string"
16063
+ },
16064
+ "value": {
16065
+ "description": "The value of the threshold.",
16077
16066
  "format": "double",
16078
16067
  "type": "number"
16079
16068
  }
@@ -16528,7 +16517,7 @@
16528
16517
  "enumDescriptions": [
16529
16518
  "Default value.",
16530
16519
  "Returns documents in the search result.",
16531
- "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
16520
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
16532
16521
  ],
16533
16522
  "type": "string"
16534
16523
  },
@@ -17807,6 +17796,11 @@
17807
17796
  "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
17808
17797
  "type": "string"
17809
17798
  },
17799
+ "detailedAnswer": {
17800
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer",
17801
+ "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.",
17802
+ "readOnly": true
17803
+ },
17810
17804
  "query": {
17811
17805
  "$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
17812
17806
  "description": "The user query."
@@ -18322,6 +18316,10 @@
18322
18316
  "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionInfo",
18323
18317
  "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."
18324
18318
  },
18319
+ "conversionType": {
18320
+ "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.",
18321
+ "type": "string"
18322
+ },
18325
18323
  "dataStore": {
18326
18324
  "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.",
18327
18325
  "type": "string"
@@ -18347,13 +18345,9 @@
18347
18345
  "type": "string"
18348
18346
  },
18349
18347
  "eventType": {
18350
- "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.",
18348
+ "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.",
18351
18349
  "type": "string"
18352
18350
  },
18353
- "feedback": {
18354
- "$ref": "GoogleCloudDiscoveryengineV1alphaFeedback",
18355
- "description": "Optional. This field is optional except for the `add-feedback` event types."
18356
- },
18357
18351
  "filter": {
18358
18352
  "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.",
18359
18353
  "type": "string"
@@ -20486,7 +20480,7 @@
20486
20480
  "enumDescriptions": [
20487
20481
  "Default value.",
20488
20482
  "Returns documents in the search result.",
20489
- "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
20483
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
20490
20484
  ],
20491
20485
  "type": "string"
20492
20486
  },
@@ -15,6 +15,28 @@
15
15
  "description": "Discovery Engine API.",
16
16
  "discoveryVersion": "v1",
17
17
  "documentationLink": "https://cloud.google.com/generative-ai-app-builder/docs/",
18
+ "endpoints": [
19
+ {
20
+ "description": "Regional Endpoint",
21
+ "endpointUrl": "https://discoveryengine.asia-northeast1.rep.googleapis.com/",
22
+ "location": "asia-northeast1"
23
+ },
24
+ {
25
+ "description": "Regional Endpoint",
26
+ "endpointUrl": "https://discoveryengine.europe-west2.rep.googleapis.com/",
27
+ "location": "europe-west2"
28
+ },
29
+ {
30
+ "description": "Regional Endpoint",
31
+ "endpointUrl": "https://discoveryengine.us.rep.googleapis.com/",
32
+ "location": "us"
33
+ },
34
+ {
35
+ "description": "Regional Endpoint",
36
+ "endpointUrl": "https://discoveryengine.eu.rep.googleapis.com/",
37
+ "location": "eu"
38
+ }
39
+ ],
18
40
  "fullyEncodeReservedExpansion": true,
19
41
  "icons": {
20
42
  "x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -7095,6 +7117,34 @@
7095
7117
  "https://www.googleapis.com/auth/cloud-platform"
7096
7118
  ]
7097
7119
  },
7120
+ "import": {
7121
+ "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.",
7122
+ "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:import",
7123
+ "httpMethod": "POST",
7124
+ "id": "discoveryengine.projects.locations.userEvents.import",
7125
+ "parameterOrder": [
7126
+ "parent"
7127
+ ],
7128
+ "parameters": {
7129
+ "parent": {
7130
+ "description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`",
7131
+ "location": "path",
7132
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
7133
+ "required": true,
7134
+ "type": "string"
7135
+ }
7136
+ },
7137
+ "path": "v1beta/{+parent}/userEvents:import",
7138
+ "request": {
7139
+ "$ref": "GoogleCloudDiscoveryengineV1betaImportUserEventsRequest"
7140
+ },
7141
+ "response": {
7142
+ "$ref": "GoogleLongrunningOperation"
7143
+ },
7144
+ "scopes": [
7145
+ "https://www.googleapis.com/auth/cloud-platform"
7146
+ ]
7147
+ },
7098
7148
  "write": {
7099
7149
  "description": "Writes a single user event.",
7100
7150
  "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write",
@@ -7205,7 +7255,7 @@
7205
7255
  }
7206
7256
  }
7207
7257
  },
7208
- "revision": "20241031",
7258
+ "revision": "20241110",
7209
7259
  "rootUrl": "https://discoveryengine.googleapis.com/",
7210
7260
  "schemas": {
7211
7261
  "GoogleApiDistribution": {
@@ -12403,7 +12453,7 @@
12403
12453
  "enumDescriptions": [
12404
12454
  "Default value.",
12405
12455
  "Returns documents in the search result.",
12406
- "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
12456
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
12407
12457
  ],
12408
12458
  "type": "string"
12409
12459
  },
@@ -12877,6 +12927,11 @@
12877
12927
  "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
12878
12928
  "type": "string"
12879
12929
  },
12930
+ "detailedAnswer": {
12931
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer",
12932
+ "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.",
12933
+ "readOnly": true
12934
+ },
12880
12935
  "query": {
12881
12936
  "$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
12882
12937
  "description": "The user query."
@@ -13923,7 +13978,7 @@
13923
13978
  "enumDescriptions": [
13924
13979
  "Default value.",
13925
13980
  "Returns documents in the search result.",
13926
- "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
13981
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
13927
13982
  ],
13928
13983
  "type": "string"
13929
13984
  }
@@ -14834,7 +14889,7 @@
14834
14889
  "type": "integer"
14835
14890
  },
14836
14891
  "groundingCheckRequired": {
14837
- "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.",
14892
+ "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.",
14838
14893
  "type": "boolean"
14839
14894
  },
14840
14895
  "startPos": {
@@ -14896,7 +14951,7 @@
14896
14951
  "description": "Page span of the chunk."
14897
14952
  },
14898
14953
  "relevanceScore": {
14899
- "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.",
14954
+ "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.",
14900
14955
  "format": "double",
14901
14956
  "readOnly": true,
14902
14957
  "type": "number"
@@ -16080,6 +16135,11 @@
16080
16135
  "description": "Detailed document information associated with a user event.",
16081
16136
  "id": "GoogleCloudDiscoveryengineV1betaDocumentInfo",
16082
16137
  "properties": {
16138
+ "conversionValue": {
16139
+ "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.",
16140
+ "format": "float",
16141
+ "type": "number"
16142
+ },
16083
16143
  "id": {
16084
16144
  "description": "The Document resource ID.",
16085
16145
  "type": "string"
@@ -16572,80 +16632,6 @@
16572
16632
  },
16573
16633
  "type": "object"
16574
16634
  },
16575
- "GoogleCloudDiscoveryengineV1betaFeedback": {
16576
- "description": "Information about the user feedback. This information will be used for logging and metrics purpose.",
16577
- "id": "GoogleCloudDiscoveryengineV1betaFeedback",
16578
- "properties": {
16579
- "comment": {
16580
- "description": "Optional. The additional user comment of the feedback if user gives a thumb down.",
16581
- "type": "string"
16582
- },
16583
- "conversationInfo": {
16584
- "$ref": "GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo",
16585
- "description": "The related conversation information when user gives feedback."
16586
- },
16587
- "feedbackType": {
16588
- "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.",
16589
- "enum": [
16590
- "FEEDBACK_TYPE_UNSPECIFIED",
16591
- "LIKE",
16592
- "DISLIKE"
16593
- ],
16594
- "enumDescriptions": [
16595
- "Unspecified feedback type.",
16596
- "The user gives a positive feedback.",
16597
- "The user gives a negative feedback."
16598
- ],
16599
- "type": "string"
16600
- },
16601
- "llmModelVersion": {
16602
- "description": "The version of the LLM model that was used to generate the response.",
16603
- "type": "string"
16604
- },
16605
- "reasons": {
16606
- "description": "Optional. The reason if user gives a thumb down.",
16607
- "items": {
16608
- "enum": [
16609
- "REASON_UNSPECIFIED",
16610
- "INACCURATE_RESPONSE",
16611
- "NOT_RELEVANT",
16612
- "INCOMPREHENSIVE",
16613
- "OFFENSIVE_OR_UNSAFE",
16614
- "BAD_CIATION",
16615
- "FORMAT_AND_STYLES"
16616
- ],
16617
- "enumDescriptions": [
16618
- "Unspecified reason.",
16619
- "The response is inaccurate.",
16620
- "The response is not relevant.",
16621
- "The response is incomprehensive.",
16622
- "The response is offensive or unsafe.",
16623
- "The response is not well-associated with the query.",
16624
- "The response is not well-formatted."
16625
- ],
16626
- "type": "string"
16627
- },
16628
- "type": "array"
16629
- }
16630
- },
16631
- "type": "object"
16632
- },
16633
- "GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo": {
16634
- "description": "The conversation information such as the question index and session name.",
16635
- "id": "GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo",
16636
- "properties": {
16637
- "questionIndex": {
16638
- "description": "The index of the user input within the conversation messages.",
16639
- "format": "int32",
16640
- "type": "integer"
16641
- },
16642
- "session": {
16643
- "description": "Name of the newly generated or continued session.",
16644
- "type": "string"
16645
- }
16646
- },
16647
- "type": "object"
16648
- },
16649
16635
  "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse": {
16650
16636
  "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.",
16651
16637
  "id": "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse",
@@ -18071,7 +18057,7 @@
18071
18057
  "type": "string"
18072
18058
  },
18073
18059
  "score": {
18074
- "description": "The score of this record based on the given query and selected model.",
18060
+ "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.",
18075
18061
  "format": "float",
18076
18062
  "type": "number"
18077
18063
  },
@@ -18656,7 +18642,7 @@
18656
18642
  "enumDescriptions": [
18657
18643
  "Default value.",
18658
18644
  "Returns documents in the search result.",
18659
- "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
18645
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
18660
18646
  ],
18661
18647
  "type": "string"
18662
18648
  },
@@ -19927,6 +19913,11 @@
19927
19913
  "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
19928
19914
  "type": "string"
19929
19915
  },
19916
+ "detailedAnswer": {
19917
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswer",
19918
+ "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.",
19919
+ "readOnly": true
19920
+ },
19930
19921
  "query": {
19931
19922
  "$ref": "GoogleCloudDiscoveryengineV1betaQuery",
19932
19923
  "description": "The user query."
@@ -20372,6 +20363,10 @@
20372
20363
  "$ref": "GoogleCloudDiscoveryengineV1betaCompletionInfo",
20373
20364
  "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."
20374
20365
  },
20366
+ "conversionType": {
20367
+ "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.",
20368
+ "type": "string"
20369
+ },
20375
20370
  "dataStore": {
20376
20371
  "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.",
20377
20372
  "type": "string"
@@ -20397,13 +20392,9 @@
20397
20392
  "type": "string"
20398
20393
  },
20399
20394
  "eventType": {
20400
- "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.",
20395
+ "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.",
20401
20396
  "type": "string"
20402
20397
  },
20403
- "feedback": {
20404
- "$ref": "GoogleCloudDiscoveryengineV1betaFeedback",
20405
- "description": "Optional. This field is optional except for the `add-feedback` event types."
20406
- },
20407
20398
  "filter": {
20408
20399
  "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.",
20409
20400
  "type": "string"
@@ -9267,7 +9267,7 @@
9267
9267
  }
9268
9268
  }
9269
9269
  },
9270
- "revision": "20241031",
9270
+ "revision": "20241114",
9271
9271
  "rootUrl": "https://displayvideo.googleapis.com/",
9272
9272
  "schemas": {
9273
9273
  "ActivateManualTriggerRequest": {
@@ -12367,7 +12367,7 @@ false
12367
12367
  "SDF version 6",
12368
12368
  "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
12369
12369
  "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
12370
- "SDF version 8. **This SDF version is in beta. It is only available to a subset of users.**"
12370
+ "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version."
12371
12371
  ],
12372
12372
  "type": "string"
12373
12373
  }
@@ -16208,7 +16208,7 @@ true
16208
16208
  },
16209
16209
  "pacing": {
16210
16210
  "$ref": "Pacing",
16211
- "description": "Required. The budget spending speed setting of the insertion order. *Warning*: Starting on **November 5, 2024**, pacing_type `PACING_TYPE_ASAP` will no longer be compatible with pacing_period `PACING_PERIOD_FLIGHT`. [Read more about this announced change](/display-video/api/deprecations#features.io_asap)."
16211
+ "description": "Required. The budget spending speed setting of the insertion order. pacing_type `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT`."
16212
16212
  },
16213
16213
  "partnerCosts": {
16214
16214
  "description": "The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.",
@@ -18862,7 +18862,7 @@ true
18862
18862
  "type": "string"
18863
18863
  },
18864
18864
  "pacingType": {
18865
- "description": "Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. *Warning*: Starting on **November 5, 2024**, `PACING_TYPE_ASAP` will no longer be compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. [Read more about this announced change](/display-video/api/deprecations#features.io_asap).",
18865
+ "description": "Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.",
18866
18866
  "enum": [
18867
18867
  "PACING_TYPE_UNSPECIFIED",
18868
18868
  "PACING_TYPE_AHEAD",
@@ -19899,7 +19899,7 @@ false
19899
19899
  "SDF version 6",
19900
19900
  "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
19901
19901
  "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
19902
- "SDF version 8. **This SDF version is in beta. It is only available to a subset of users.**"
19902
+ "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version."
19903
19903
  ],
19904
19904
  "type": "string"
19905
19905
  }
@@ -19982,7 +19982,7 @@ false
19982
19982
  "SDF version 6",
19983
19983
  "SDF version 7. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
19984
19984
  "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
19985
- "SDF version 8. **This SDF version is in beta. It is only available to a subset of users.**"
19985
+ "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version."
19986
19986
  ],
19987
19987
  "type": "string"
19988
19988
  }