google-api-python-client 2.152.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.
- {google_api_python_client-2.152.0.dist-info → google_api_python_client-2.154.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.152.0.dist-info → google_api_python_client-2.154.0.dist-info}/RECORD +131 -131
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +7 -52
- googleapiclient/discovery_cache/documents/addressvalidation.v1.json +3 -3
- googleapiclient/discovery_cache/documents/admin.directory_v1.json +2 -2
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +2 -2
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +664 -15
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +326 -13
- googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +5 -1
- googleapiclient/discovery_cache/documents/androidenterprise.v1.json +66 -4
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +5 -5
- googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +57 -5
- googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +57 -5
- googleapiclient/discovery_cache/documents/backupdr.v1.json +3 -3
- googleapiclient/discovery_cache/documents/batch.v1.json +10 -10
- googleapiclient/discovery_cache/documents/beyondcorp.v1.json +1 -69
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +1 -69
- googleapiclient/discovery_cache/documents/bigquery.v2.json +8 -8
- googleapiclient/discovery_cache/documents/calendar.v3.json +24 -1
- googleapiclient/discovery_cache/documents/chat.v1.json +61 -56
- googleapiclient/discovery_cache/documents/checks.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +5 -3
- googleapiclient/discovery_cache/documents/cloudasset.v1.json +11 -7
- googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +5 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +5 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +5 -1
- googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/cloudchannel.v1.json +53 -8
- googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +3 -3
- googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudsearch.v1.json +1 -63
- googleapiclient/discovery_cache/documents/cloudtasks.v2.json +2 -2
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +3 -3
- googleapiclient/discovery_cache/documents/compute.alpha.json +13 -35
- googleapiclient/discovery_cache/documents/compute.beta.json +8 -53
- googleapiclient/discovery_cache/documents/compute.v1.json +8 -58
- googleapiclient/discovery_cache/documents/config.v1.json +3 -3
- googleapiclient/discovery_cache/documents/connectors.v1.json +155 -1
- googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +21 -5
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +51 -996
- googleapiclient/discovery_cache/documents/container.v1.json +99 -6
- googleapiclient/discovery_cache/documents/container.v1beta1.json +99 -6
- googleapiclient/discovery_cache/documents/css.v1.json +2 -2
- googleapiclient/discovery_cache/documents/dataform.v1beta1.json +6 -6
- googleapiclient/discovery_cache/documents/datalineage.v1.json +11 -1
- googleapiclient/discovery_cache/documents/datamigration.v1.json +5 -1
- googleapiclient/discovery_cache/documents/dataplex.v1.json +31 -6
- googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +402 -8
- googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +354 -8
- googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +398 -8
- googleapiclient/discovery_cache/documents/developerconnect.v1.json +2 -2
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +3 -3
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +3 -3
- googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +3 -115
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +152 -25
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +161 -45
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +137 -24
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +6 -6
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +6 -6
- googleapiclient/discovery_cache/documents/dlp.v2.json +9 -5
- googleapiclient/discovery_cache/documents/drive.v3.json +147 -106
- googleapiclient/discovery_cache/documents/fcm.v1.json +5 -1
- googleapiclient/discovery_cache/documents/file.v1.json +2 -2
- googleapiclient/discovery_cache/documents/file.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/firebase.v1beta1.json +33 -33
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +2 -2
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +195 -1
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +2 -1
- googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +112 -1
- googleapiclient/discovery_cache/documents/gkebackup.v1.json +2 -2
- googleapiclient/discovery_cache/documents/gkehub.v1.json +11 -1
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +11 -1
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +11 -1
- googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +11 -1
- googleapiclient/discovery_cache/documents/gkeonprem.v1.json +7 -2
- googleapiclient/discovery_cache/documents/healthcare.v1.json +21 -21
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/integrations.v1.json +24 -2
- googleapiclient/discovery_cache/documents/language.v1.json +18 -21
- googleapiclient/discovery_cache/documents/language.v1beta2.json +21 -24
- googleapiclient/discovery_cache/documents/language.v2.json +27 -30
- googleapiclient/discovery_cache/documents/looker.v1.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +19 -13
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +8 -5
- googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +6 -3
- googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +6 -3
- googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +6 -3
- googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +16 -7
- googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +16 -7
- googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +7 -4
- googleapiclient/discovery_cache/documents/netapp.v1.json +477 -7
- googleapiclient/discovery_cache/documents/netapp.v1beta1.json +477 -7
- googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +171 -11
- googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +5 -1
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +12 -6
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +12 -6
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +535 -2
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +5 -5
- googleapiclient/discovery_cache/documents/networkservices.v1.json +570 -35
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +271 -35
- googleapiclient/discovery_cache/documents/notebooks.v1.json +6 -6
- googleapiclient/discovery_cache/documents/notebooks.v2.json +2 -2
- googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +119 -2
- googleapiclient/discovery_cache/documents/places.v1.json +65 -1
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/privateca.v1.json +8 -8
- googleapiclient/discovery_cache/documents/run.v2.json +20 -1
- googleapiclient/discovery_cache/documents/searchads360.v0.json +102 -1
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +97 -3
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +65 -3
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +65 -3
- googleapiclient/discovery_cache/documents/servicemanagement.v1.json +6 -2
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +13 -2
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +13 -2
- googleapiclient/discovery_cache/documents/speech.v1.json +21 -1
- googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +21 -1
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +157 -84
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +157 -96
- googleapiclient/discovery_cache/documents/storage.v1.json +23 -2
- googleapiclient/discovery_cache/documents/sts.v1.json +9 -2
- googleapiclient/discovery_cache/documents/sts.v1beta.json +8 -1
- googleapiclient/discovery_cache/documents/testing.v1.json +24 -2
- googleapiclient/discovery_cache/documents/texttospeech.v1.json +2 -2
- googleapiclient/discovery_cache/documents/walletobjects.v1.json +5 -1
- googleapiclient/discovery_cache/documents/youtube.v3.json +2 -2
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.152.0.dist-info → google_api_python_client-2.154.0.dist-info}/LICENSE +0 -0
- {google_api_python_client-2.152.0.dist-info → google_api_python_client-2.154.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.152.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": "
|
|
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
|
|
10772
|
+
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
|
|
10723
10773
|
],
|
|
10724
10774
|
"type": "string"
|
|
10725
10775
|
}
|
|
@@ -11571,7 +11621,14 @@
|
|
|
11571
11621
|
"citedChunks": {
|
|
11572
11622
|
"description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.",
|
|
11573
11623
|
"items": {
|
|
11574
|
-
"$ref": "
|
|
11624
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaFactChunk"
|
|
11625
|
+
},
|
|
11626
|
+
"type": "array"
|
|
11627
|
+
},
|
|
11628
|
+
"citedFacts": {
|
|
11629
|
+
"description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.",
|
|
11630
|
+
"items": {
|
|
11631
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk"
|
|
11575
11632
|
},
|
|
11576
11633
|
"type": "array"
|
|
11577
11634
|
},
|
|
@@ -11590,6 +11647,17 @@
|
|
|
11590
11647
|
},
|
|
11591
11648
|
"type": "object"
|
|
11592
11649
|
},
|
|
11650
|
+
"GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk": {
|
|
11651
|
+
"description": "Fact chunk for grounding check.",
|
|
11652
|
+
"id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk",
|
|
11653
|
+
"properties": {
|
|
11654
|
+
"chunkText": {
|
|
11655
|
+
"description": "Text content of the fact chunk. Can be at most 10K characters long.",
|
|
11656
|
+
"type": "string"
|
|
11657
|
+
}
|
|
11658
|
+
},
|
|
11659
|
+
"type": "object"
|
|
11660
|
+
},
|
|
11593
11661
|
"GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim": {
|
|
11594
11662
|
"description": "Text and citation info for a claim in the answer candidate.",
|
|
11595
11663
|
"id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim",
|
|
@@ -11612,7 +11680,7 @@
|
|
|
11612
11680
|
"type": "integer"
|
|
11613
11681
|
},
|
|
11614
11682
|
"groundingCheckRequired": {
|
|
11615
|
-
"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
|
|
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.",
|
|
11616
11684
|
"type": "boolean"
|
|
11617
11685
|
},
|
|
11618
11686
|
"startPos": {
|
|
@@ -11623,21 +11691,6 @@
|
|
|
11623
11691
|
},
|
|
11624
11692
|
"type": "object"
|
|
11625
11693
|
},
|
|
11626
|
-
"GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk": {
|
|
11627
|
-
"description": "Fact chunk for grounding check.",
|
|
11628
|
-
"id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk",
|
|
11629
|
-
"properties": {
|
|
11630
|
-
"chunkText": {
|
|
11631
|
-
"description": "Text content of the fact chunk. Can be at most 10K characters long.",
|
|
11632
|
-
"type": "string"
|
|
11633
|
-
},
|
|
11634
|
-
"source": {
|
|
11635
|
-
"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.",
|
|
11636
|
-
"type": "string"
|
|
11637
|
-
}
|
|
11638
|
-
},
|
|
11639
|
-
"type": "object"
|
|
11640
|
-
},
|
|
11641
11694
|
"GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec": {
|
|
11642
11695
|
"description": "Specification for the grounding check.",
|
|
11643
11696
|
"id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec",
|
|
@@ -11692,20 +11745,8 @@
|
|
|
11692
11745
|
"$ref": "GoogleTypeExpr",
|
|
11693
11746
|
"description": "The condition for evaluating the requirement result."
|
|
11694
11747
|
},
|
|
11695
|
-
"
|
|
11696
|
-
"description": "
|
|
11697
|
-
"enum": [
|
|
11698
|
-
"UNKNOWN",
|
|
11699
|
-
"SUCCESS",
|
|
11700
|
-
"FAILURE",
|
|
11701
|
-
"WARNING"
|
|
11702
|
-
],
|
|
11703
|
-
"enumDescriptions": [
|
|
11704
|
-
"The requirement is unknown.",
|
|
11705
|
-
"The requirement check is passed.",
|
|
11706
|
-
"The requirement check fails to meet at least one blocking threshold.",
|
|
11707
|
-
"The requirement check fails at least one warning threshold, but passes all blocking thresholds."
|
|
11708
|
-
],
|
|
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`.",
|
|
11709
11750
|
"type": "string"
|
|
11710
11751
|
}
|
|
11711
11752
|
},
|
|
@@ -11778,7 +11819,7 @@
|
|
|
11778
11819
|
"description": "Page span of the chunk."
|
|
11779
11820
|
},
|
|
11780
11821
|
"relevanceScore": {
|
|
11781
|
-
"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
|
|
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.",
|
|
11782
11823
|
"format": "double",
|
|
11783
11824
|
"readOnly": true,
|
|
11784
11825
|
"type": "number"
|
|
@@ -13044,6 +13085,11 @@
|
|
|
13044
13085
|
"description": "Detailed document information associated with a user event.",
|
|
13045
13086
|
"id": "GoogleCloudDiscoveryengineV1alphaDocumentInfo",
|
|
13046
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
|
+
},
|
|
13047
13093
|
"id": {
|
|
13048
13094
|
"description": "The Document resource ID.",
|
|
13049
13095
|
"type": "string"
|
|
@@ -13719,6 +13765,33 @@
|
|
|
13719
13765
|
},
|
|
13720
13766
|
"type": "object"
|
|
13721
13767
|
},
|
|
13768
|
+
"GoogleCloudDiscoveryengineV1alphaFactChunk": {
|
|
13769
|
+
"description": "Fact Chunk.",
|
|
13770
|
+
"id": "GoogleCloudDiscoveryengineV1alphaFactChunk",
|
|
13771
|
+
"properties": {
|
|
13772
|
+
"chunkText": {
|
|
13773
|
+
"description": "Text content of the fact chunk. Can be at most 10K characters long.",
|
|
13774
|
+
"type": "string"
|
|
13775
|
+
},
|
|
13776
|
+
"index": {
|
|
13777
|
+
"description": "The index of this chunk. Currently, only used for the streaming mode.",
|
|
13778
|
+
"format": "int32",
|
|
13779
|
+
"type": "integer"
|
|
13780
|
+
},
|
|
13781
|
+
"source": {
|
|
13782
|
+
"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.",
|
|
13783
|
+
"type": "string"
|
|
13784
|
+
},
|
|
13785
|
+
"sourceMetadata": {
|
|
13786
|
+
"additionalProperties": {
|
|
13787
|
+
"type": "string"
|
|
13788
|
+
},
|
|
13789
|
+
"description": "More fine-grained information for the source reference.",
|
|
13790
|
+
"type": "object"
|
|
13791
|
+
}
|
|
13792
|
+
},
|
|
13793
|
+
"type": "object"
|
|
13794
|
+
},
|
|
13722
13795
|
"GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": {
|
|
13723
13796
|
"description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.",
|
|
13724
13797
|
"id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse",
|
|
@@ -15032,6 +15105,13 @@
|
|
|
15032
15105
|
"description": "The display name of the panel.",
|
|
15033
15106
|
"type": "string"
|
|
15034
15107
|
},
|
|
15108
|
+
"documents": {
|
|
15109
|
+
"description": "Optional. The document IDs associated with this panel.",
|
|
15110
|
+
"items": {
|
|
15111
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentInfo"
|
|
15112
|
+
},
|
|
15113
|
+
"type": "array"
|
|
15114
|
+
},
|
|
15035
15115
|
"panelId": {
|
|
15036
15116
|
"description": "Required. The panel ID.",
|
|
15037
15117
|
"type": "string"
|
|
@@ -15553,7 +15633,7 @@
|
|
|
15553
15633
|
"type": "string"
|
|
15554
15634
|
},
|
|
15555
15635
|
"score": {
|
|
15556
|
-
"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.",
|
|
15557
15637
|
"format": "float",
|
|
15558
15638
|
"type": "number"
|
|
15559
15639
|
},
|
|
@@ -15896,6 +15976,13 @@
|
|
|
15896
15976
|
},
|
|
15897
15977
|
"type": "array"
|
|
15898
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
|
+
},
|
|
15899
15986
|
"thresholdBindings": {
|
|
15900
15987
|
"description": "A list of threshold bindings to be used in `condition`.",
|
|
15901
15988
|
"items": {
|
|
@@ -15948,21 +16035,34 @@
|
|
|
15948
16035
|
"description": "Specifies a multi-level threshold to apply to apply to a `metric_bindings` in the `condition` CEL expression.",
|
|
15949
16036
|
"id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding",
|
|
15950
16037
|
"properties": {
|
|
15951
|
-
"blockingThreshold": {
|
|
15952
|
-
"description": "Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a `FAILURE`.",
|
|
15953
|
-
"format": "double",
|
|
15954
|
-
"type": "number"
|
|
15955
|
-
},
|
|
15956
16038
|
"description": {
|
|
15957
16039
|
"description": "Human readable description of the corresponding threshold and sub-requirement.",
|
|
15958
16040
|
"type": "string"
|
|
15959
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
|
+
},
|
|
15960
16049
|
"variableId": {
|
|
15961
16050
|
"description": "The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`.",
|
|
15962
16051
|
"type": "string"
|
|
16052
|
+
}
|
|
16053
|
+
},
|
|
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"
|
|
15963
16063
|
},
|
|
15964
|
-
"
|
|
15965
|
-
"description": "
|
|
16064
|
+
"value": {
|
|
16065
|
+
"description": "The value of the threshold.",
|
|
15966
16066
|
"format": "double",
|
|
15967
16067
|
"type": "number"
|
|
15968
16068
|
}
|
|
@@ -16417,7 +16517,7 @@
|
|
|
16417
16517
|
"enumDescriptions": [
|
|
16418
16518
|
"Default value.",
|
|
16419
16519
|
"Returns documents in the search result.",
|
|
16420
|
-
"Returns chunks in the search result. Only available if the
|
|
16520
|
+
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
|
|
16421
16521
|
],
|
|
16422
16522
|
"type": "string"
|
|
16423
16523
|
},
|
|
@@ -17696,6 +17796,11 @@
|
|
|
17696
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.",
|
|
17697
17797
|
"type": "string"
|
|
17698
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
|
+
},
|
|
17699
17804
|
"query": {
|
|
17700
17805
|
"$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
|
|
17701
17806
|
"description": "The user query."
|
|
@@ -18211,6 +18316,10 @@
|
|
|
18211
18316
|
"$ref": "GoogleCloudDiscoveryengineV1alphaCompletionInfo",
|
|
18212
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."
|
|
18213
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
|
+
},
|
|
18214
18323
|
"dataStore": {
|
|
18215
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.",
|
|
18216
18325
|
"type": "string"
|
|
@@ -18236,7 +18345,7 @@
|
|
|
18236
18345
|
"type": "string"
|
|
18237
18346
|
},
|
|
18238
18347
|
"eventType": {
|
|
18239
|
-
"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.",
|
|
18240
18349
|
"type": "string"
|
|
18241
18350
|
},
|
|
18242
18351
|
"filter": {
|
|
@@ -18255,6 +18364,13 @@
|
|
|
18255
18364
|
"$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo",
|
|
18256
18365
|
"description": "Panel metadata associated with this user event."
|
|
18257
18366
|
},
|
|
18367
|
+
"panels": {
|
|
18368
|
+
"description": "Optional. List of panels associated with this event. Used for page-level impression data.",
|
|
18369
|
+
"items": {
|
|
18370
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo"
|
|
18371
|
+
},
|
|
18372
|
+
"type": "array"
|
|
18373
|
+
},
|
|
18258
18374
|
"promotionIds": {
|
|
18259
18375
|
"description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.",
|
|
18260
18376
|
"items": {
|
|
@@ -20364,7 +20480,7 @@
|
|
|
20364
20480
|
"enumDescriptions": [
|
|
20365
20481
|
"Default value.",
|
|
20366
20482
|
"Returns documents in the search result.",
|
|
20367
|
-
"Returns chunks in the search result. Only available if the
|
|
20483
|
+
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
|
|
20368
20484
|
],
|
|
20369
20485
|
"type": "string"
|
|
20370
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": "
|
|
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
|
|
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
|
|
13981
|
+
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
|
|
13927
13982
|
],
|
|
13928
13983
|
"type": "string"
|
|
13929
13984
|
}
|
|
@@ -14775,7 +14830,14 @@
|
|
|
14775
14830
|
"citedChunks": {
|
|
14776
14831
|
"description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.",
|
|
14777
14832
|
"items": {
|
|
14778
|
-
"$ref": "
|
|
14833
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaFactChunk"
|
|
14834
|
+
},
|
|
14835
|
+
"type": "array"
|
|
14836
|
+
},
|
|
14837
|
+
"citedFacts": {
|
|
14838
|
+
"description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.",
|
|
14839
|
+
"items": {
|
|
14840
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk"
|
|
14779
14841
|
},
|
|
14780
14842
|
"type": "array"
|
|
14781
14843
|
},
|
|
@@ -14794,6 +14856,17 @@
|
|
|
14794
14856
|
},
|
|
14795
14857
|
"type": "object"
|
|
14796
14858
|
},
|
|
14859
|
+
"GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk": {
|
|
14860
|
+
"description": "Fact chunk for grounding check.",
|
|
14861
|
+
"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk",
|
|
14862
|
+
"properties": {
|
|
14863
|
+
"chunkText": {
|
|
14864
|
+
"description": "Text content of the fact chunk. Can be at most 10K characters long.",
|
|
14865
|
+
"type": "string"
|
|
14866
|
+
}
|
|
14867
|
+
},
|
|
14868
|
+
"type": "object"
|
|
14869
|
+
},
|
|
14797
14870
|
"GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim": {
|
|
14798
14871
|
"description": "Text and citation info for a claim in the answer candidate.",
|
|
14799
14872
|
"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim",
|
|
@@ -14816,7 +14889,7 @@
|
|
|
14816
14889
|
"type": "integer"
|
|
14817
14890
|
},
|
|
14818
14891
|
"groundingCheckRequired": {
|
|
14819
|
-
"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
|
|
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.",
|
|
14820
14893
|
"type": "boolean"
|
|
14821
14894
|
},
|
|
14822
14895
|
"startPos": {
|
|
@@ -14827,21 +14900,6 @@
|
|
|
14827
14900
|
},
|
|
14828
14901
|
"type": "object"
|
|
14829
14902
|
},
|
|
14830
|
-
"GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk": {
|
|
14831
|
-
"description": "Fact chunk for grounding check.",
|
|
14832
|
-
"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk",
|
|
14833
|
-
"properties": {
|
|
14834
|
-
"chunkText": {
|
|
14835
|
-
"description": "Text content of the fact chunk. Can be at most 10K characters long.",
|
|
14836
|
-
"type": "string"
|
|
14837
|
-
},
|
|
14838
|
-
"source": {
|
|
14839
|
-
"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.",
|
|
14840
|
-
"type": "string"
|
|
14841
|
-
}
|
|
14842
|
-
},
|
|
14843
|
-
"type": "object"
|
|
14844
|
-
},
|
|
14845
14903
|
"GoogleCloudDiscoveryengineV1betaCheckGroundingSpec": {
|
|
14846
14904
|
"description": "Specification for the grounding check.",
|
|
14847
14905
|
"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingSpec",
|
|
@@ -14893,7 +14951,7 @@
|
|
|
14893
14951
|
"description": "Page span of the chunk."
|
|
14894
14952
|
},
|
|
14895
14953
|
"relevanceScore": {
|
|
14896
|
-
"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
|
|
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.",
|
|
14897
14955
|
"format": "double",
|
|
14898
14956
|
"readOnly": true,
|
|
14899
14957
|
"type": "number"
|
|
@@ -16077,6 +16135,11 @@
|
|
|
16077
16135
|
"description": "Detailed document information associated with a user event.",
|
|
16078
16136
|
"id": "GoogleCloudDiscoveryengineV1betaDocumentInfo",
|
|
16079
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
|
+
},
|
|
16080
16143
|
"id": {
|
|
16081
16144
|
"description": "The Document resource ID.",
|
|
16082
16145
|
"type": "string"
|
|
@@ -16542,6 +16605,33 @@
|
|
|
16542
16605
|
},
|
|
16543
16606
|
"type": "object"
|
|
16544
16607
|
},
|
|
16608
|
+
"GoogleCloudDiscoveryengineV1betaFactChunk": {
|
|
16609
|
+
"description": "Fact Chunk.",
|
|
16610
|
+
"id": "GoogleCloudDiscoveryengineV1betaFactChunk",
|
|
16611
|
+
"properties": {
|
|
16612
|
+
"chunkText": {
|
|
16613
|
+
"description": "Text content of the fact chunk. Can be at most 10K characters long.",
|
|
16614
|
+
"type": "string"
|
|
16615
|
+
},
|
|
16616
|
+
"index": {
|
|
16617
|
+
"description": "The index of this chunk. Currently, only used for the streaming mode.",
|
|
16618
|
+
"format": "int32",
|
|
16619
|
+
"type": "integer"
|
|
16620
|
+
},
|
|
16621
|
+
"source": {
|
|
16622
|
+
"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.",
|
|
16623
|
+
"type": "string"
|
|
16624
|
+
},
|
|
16625
|
+
"sourceMetadata": {
|
|
16626
|
+
"additionalProperties": {
|
|
16627
|
+
"type": "string"
|
|
16628
|
+
},
|
|
16629
|
+
"description": "More fine-grained information for the source reference.",
|
|
16630
|
+
"type": "object"
|
|
16631
|
+
}
|
|
16632
|
+
},
|
|
16633
|
+
"type": "object"
|
|
16634
|
+
},
|
|
16545
16635
|
"GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse": {
|
|
16546
16636
|
"description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.",
|
|
16547
16637
|
"id": "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse",
|
|
@@ -17543,6 +17633,13 @@
|
|
|
17543
17633
|
"description": "The display name of the panel.",
|
|
17544
17634
|
"type": "string"
|
|
17545
17635
|
},
|
|
17636
|
+
"documents": {
|
|
17637
|
+
"description": "Optional. The document IDs associated with this panel.",
|
|
17638
|
+
"items": {
|
|
17639
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentInfo"
|
|
17640
|
+
},
|
|
17641
|
+
"type": "array"
|
|
17642
|
+
},
|
|
17546
17643
|
"panelId": {
|
|
17547
17644
|
"description": "Required. The panel ID.",
|
|
17548
17645
|
"type": "string"
|
|
@@ -17960,7 +18057,7 @@
|
|
|
17960
18057
|
"type": "string"
|
|
17961
18058
|
},
|
|
17962
18059
|
"score": {
|
|
17963
|
-
"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.",
|
|
17964
18061
|
"format": "float",
|
|
17965
18062
|
"type": "number"
|
|
17966
18063
|
},
|
|
@@ -18545,7 +18642,7 @@
|
|
|
18545
18642
|
"enumDescriptions": [
|
|
18546
18643
|
"Default value.",
|
|
18547
18644
|
"Returns documents in the search result.",
|
|
18548
|
-
"Returns chunks in the search result. Only available if the
|
|
18645
|
+
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
|
|
18549
18646
|
],
|
|
18550
18647
|
"type": "string"
|
|
18551
18648
|
},
|
|
@@ -19816,6 +19913,11 @@
|
|
|
19816
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.",
|
|
19817
19914
|
"type": "string"
|
|
19818
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
|
+
},
|
|
19819
19921
|
"query": {
|
|
19820
19922
|
"$ref": "GoogleCloudDiscoveryengineV1betaQuery",
|
|
19821
19923
|
"description": "The user query."
|
|
@@ -20261,6 +20363,10 @@
|
|
|
20261
20363
|
"$ref": "GoogleCloudDiscoveryengineV1betaCompletionInfo",
|
|
20262
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."
|
|
20263
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
|
+
},
|
|
20264
20370
|
"dataStore": {
|
|
20265
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.",
|
|
20266
20372
|
"type": "string"
|
|
@@ -20286,7 +20392,7 @@
|
|
|
20286
20392
|
"type": "string"
|
|
20287
20393
|
},
|
|
20288
20394
|
"eventType": {
|
|
20289
|
-
"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.",
|
|
20290
20396
|
"type": "string"
|
|
20291
20397
|
},
|
|
20292
20398
|
"filter": {
|
|
@@ -20305,6 +20411,13 @@
|
|
|
20305
20411
|
"$ref": "GoogleCloudDiscoveryengineV1betaPanelInfo",
|
|
20306
20412
|
"description": "Panel metadata associated with this user event."
|
|
20307
20413
|
},
|
|
20414
|
+
"panels": {
|
|
20415
|
+
"description": "Optional. List of panels associated with this event. Used for page-level impression data.",
|
|
20416
|
+
"items": {
|
|
20417
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaPanelInfo"
|
|
20418
|
+
},
|
|
20419
|
+
"type": "array"
|
|
20420
|
+
},
|
|
20308
20421
|
"promotionIds": {
|
|
20309
20422
|
"description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.",
|
|
20310
20423
|
"items": {
|