google-api-python-client 2.173.0__py3-none-any.whl → 2.175.0__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.173.0.dist-info → google_api_python_client-2.175.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.173.0.dist-info → google_api_python_client-2.175.0.dist-info}/RECORD +146 -144
- googleapiclient/discovery_cache/documents/accessapproval.v1.json +5 -3
- googleapiclient/discovery_cache/documents/addressvalidation.v1.json +27 -5
- googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.datatransferv1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.directory_v1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.reports_v1.json +6 -4
- googleapiclient/discovery_cache/documents/admin.reportsv1.json +6 -4
- googleapiclient/discovery_cache/documents/adsense.v2.json +14 -14
- googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +457 -16
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +1328 -18
- googleapiclient/discovery_cache/documents/alloydb.v1.json +18 -5
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +64 -30
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +64 -30
- googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +73 -13
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +5 -3
- googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +5 -3
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +246 -60
- googleapiclient/discovery_cache/documents/apigee.v1.json +61 -2
- googleapiclient/discovery_cache/documents/apihub.v1.json +5 -5
- googleapiclient/discovery_cache/documents/appengine.v1.json +57 -1
- googleapiclient/discovery_cache/documents/appengine.v1alpha.json +62 -1
- googleapiclient/discovery_cache/documents/appengine.v1beta.json +57 -1
- googleapiclient/discovery_cache/documents/apphub.v1alpha.json +68 -1
- googleapiclient/discovery_cache/documents/areainsights.v1.json +2 -2
- googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +43 -43
- googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +43 -43
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +8 -8
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json +397 -0
- googleapiclient/discovery_cache/documents/backupdr.v1.json +2 -2
- googleapiclient/discovery_cache/documents/beyondcorp.v1.json +106 -118
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +106 -118
- googleapiclient/discovery_cache/documents/bigquery.v2.json +123 -11
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +188 -3
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +402 -1
- googleapiclient/discovery_cache/documents/chat.v1.json +4 -2
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +21 -19
- googleapiclient/discovery_cache/documents/cloudchannel.v1.json +3 -3
- googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json +470 -0
- googleapiclient/discovery_cache/documents/compute.alpha.json +2 -2
- googleapiclient/discovery_cache/documents/compute.beta.json +77 -2
- googleapiclient/discovery_cache/documents/compute.v1.json +117 -2
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +505 -3
- googleapiclient/discovery_cache/documents/container.v1.json +19 -3
- googleapiclient/discovery_cache/documents/container.v1beta1.json +19 -3
- googleapiclient/discovery_cache/documents/containeranalysis.v1.json +52 -1
- googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +52 -1
- googleapiclient/discovery_cache/documents/content.v2.1.json +35 -1
- googleapiclient/discovery_cache/documents/datalineage.v1.json +10 -5
- googleapiclient/discovery_cache/documents/datamigration.v1.json +5 -3
- googleapiclient/discovery_cache/documents/dataplex.v1.json +5 -5
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +90 -2
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +96 -4
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +109 -2
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +109 -2
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +63 -18
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +58 -20
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +63 -18
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +14 -11
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +22 -17
- googleapiclient/discovery_cache/documents/displayvideo.v4.json +22 -17
- googleapiclient/discovery_cache/documents/dlp.v2.json +15 -1
- googleapiclient/discovery_cache/documents/documentai.v1.json +2 -2
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +2 -2
- googleapiclient/discovery_cache/documents/eventarc.v1.json +6 -1
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +2 -2
- googleapiclient/discovery_cache/documents/firestore.v1.json +131 -1
- googleapiclient/discovery_cache/documents/firestore.v1beta1.json +76 -1
- googleapiclient/discovery_cache/documents/firestore.v1beta2.json +76 -1
- googleapiclient/discovery_cache/documents/gkehub.v1.json +2 -2
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +4 -4
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/gkehub.v2.json +2 -2
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +2 -2
- googleapiclient/discovery_cache/documents/gkehub.v2beta.json +2 -2
- googleapiclient/discovery_cache/documents/gmail.v1.json +15 -15
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +1 -11
- googleapiclient/discovery_cache/documents/iam.v1.json +128 -3
- googleapiclient/discovery_cache/documents/integrations.v1.json +91 -7
- googleapiclient/discovery_cache/documents/looker.v1.json +9 -3
- googleapiclient/discovery_cache/documents/managedkafka.v1.json +49 -5
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +8 -8
- googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +4 -4
- googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +9 -5
- googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json +4 -4
- googleapiclient/discovery_cache/documents/metastore.v1.json +15 -1
- googleapiclient/discovery_cache/documents/metastore.v1alpha.json +15 -1
- googleapiclient/discovery_cache/documents/metastore.v1beta.json +15 -1
- googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +2 -2
- googleapiclient/discovery_cache/documents/netapp.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +2 -2
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +10 -5
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +10 -5
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +4 -4
- googleapiclient/discovery_cache/documents/networkservices.v1.json +47 -10
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +11 -11
- googleapiclient/discovery_cache/documents/parallelstore.v1.json +2 -2
- googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/policysimulator.v1.json +250 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +454 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +1652 -110
- googleapiclient/discovery_cache/documents/redis.v1.json +21 -4
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +21 -4
- googleapiclient/discovery_cache/documents/retail.v2.json +132 -3
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +132 -3
- googleapiclient/discovery_cache/documents/retail.v2beta.json +132 -3
- googleapiclient/discovery_cache/documents/run.v2.json +23 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1.json +8 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +8 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +8 -1
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +40 -7
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +40 -7
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +40 -7
- googleapiclient/discovery_cache/documents/securityposture.v1.json +7 -1
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +11 -1
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +11 -1
- googleapiclient/discovery_cache/documents/sheets.v4.json +2 -2
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +1 -29
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +61 -29
- googleapiclient/discovery_cache/documents/testing.v1.json +19 -1
- googleapiclient/discovery_cache/documents/texttospeech.v1.json +5 -3
- googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +5 -3
- googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +5 -1
- googleapiclient/discovery_cache/documents/trafficdirector.v3.json +2 -2
- googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +59 -1
- googleapiclient/discovery_cache/documents/vault.v1.json +2 -2
- googleapiclient/discovery_cache/documents/vmmigration.v1.json +17 -3
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +17 -3
- googleapiclient/discovery_cache/documents/workloadmanager.v1.json +3 -1
- googleapiclient/discovery_cache/documents/workspaceevents.v1.json +13 -1
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.173.0.dist-info → google_api_python_client-2.175.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.173.0.dist-info → google_api_python_client-2.175.0.dist-info}/licenses/LICENSE +0 -0
- {google_api_python_client-2.173.0.dist-info → google_api_python_client-2.175.0.dist-info}/top_level.txt +0 -0
|
@@ -5436,7 +5436,7 @@
|
|
|
5436
5436
|
}
|
|
5437
5437
|
}
|
|
5438
5438
|
},
|
|
5439
|
-
"revision": "
|
|
5439
|
+
"revision": "20250625",
|
|
5440
5440
|
"rootUrl": "https://dialogflow.googleapis.com/",
|
|
5441
5441
|
"schemas": {
|
|
5442
5442
|
"GoogleCloudDialogflowCxV3AdvancedSettings": {
|
|
@@ -6156,6 +6156,13 @@
|
|
|
6156
6156
|
"description": "If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.",
|
|
6157
6157
|
"type": "boolean"
|
|
6158
6158
|
},
|
|
6159
|
+
"generators": {
|
|
6160
|
+
"description": "A list of Generators to be called during this fulfillment.",
|
|
6161
|
+
"items": {
|
|
6162
|
+
"$ref": "GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings"
|
|
6163
|
+
},
|
|
6164
|
+
"type": "array"
|
|
6165
|
+
},
|
|
6159
6166
|
"messages": {
|
|
6160
6167
|
"description": "The list of rich message responses to present to the user.",
|
|
6161
6168
|
"items": {
|
|
@@ -6232,6 +6239,28 @@
|
|
|
6232
6239
|
},
|
|
6233
6240
|
"type": "object"
|
|
6234
6241
|
},
|
|
6242
|
+
"GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings": {
|
|
6243
|
+
"description": "Generator settings used by the LLM to generate a text response.",
|
|
6244
|
+
"id": "GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings",
|
|
6245
|
+
"properties": {
|
|
6246
|
+
"generator": {
|
|
6247
|
+
"description": "Required. The generator to call. Format: `projects//locations//agents//generators/`.",
|
|
6248
|
+
"type": "string"
|
|
6249
|
+
},
|
|
6250
|
+
"inputParameters": {
|
|
6251
|
+
"additionalProperties": {
|
|
6252
|
+
"type": "string"
|
|
6253
|
+
},
|
|
6254
|
+
"description": "Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name",
|
|
6255
|
+
"type": "object"
|
|
6256
|
+
},
|
|
6257
|
+
"outputParameter": {
|
|
6258
|
+
"description": "Required. Output parameter which should contain the generator response.",
|
|
6259
|
+
"type": "string"
|
|
6260
|
+
}
|
|
6261
|
+
},
|
|
6262
|
+
"type": "object"
|
|
6263
|
+
},
|
|
6235
6264
|
"GoogleCloudDialogflowCxV3FulfillmentSetParameterAction": {
|
|
6236
6265
|
"description": "Setting a parameter value.",
|
|
6237
6266
|
"id": "GoogleCloudDialogflowCxV3FulfillmentSetParameterAction",
|
|
@@ -6419,7 +6448,7 @@
|
|
|
6419
6448
|
],
|
|
6420
6449
|
"enumDescriptions": [
|
|
6421
6450
|
"Not specified.",
|
|
6422
|
-
"Uncompressed 16-bit signed little-endian samples (Linear PCM).",
|
|
6451
|
+
"Uncompressed 16-bit signed little-endian samples (Linear PCM). LINT: LEGACY_NAMES",
|
|
6423
6452
|
"[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.",
|
|
6424
6453
|
"8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
|
|
6425
6454
|
"Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.",
|
|
@@ -10942,6 +10971,13 @@
|
|
|
10942
10971
|
"description": "If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.",
|
|
10943
10972
|
"type": "boolean"
|
|
10944
10973
|
},
|
|
10974
|
+
"generators": {
|
|
10975
|
+
"description": "A list of Generators to be called during this fulfillment.",
|
|
10976
|
+
"items": {
|
|
10977
|
+
"$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentGeneratorSettings"
|
|
10978
|
+
},
|
|
10979
|
+
"type": "array"
|
|
10980
|
+
},
|
|
10945
10981
|
"messages": {
|
|
10946
10982
|
"description": "The list of rich message responses to present to the user.",
|
|
10947
10983
|
"items": {
|
|
@@ -11018,6 +11054,28 @@
|
|
|
11018
11054
|
},
|
|
11019
11055
|
"type": "object"
|
|
11020
11056
|
},
|
|
11057
|
+
"GoogleCloudDialogflowCxV3beta1FulfillmentGeneratorSettings": {
|
|
11058
|
+
"description": "Generator settings used by the LLM to generate a text response.",
|
|
11059
|
+
"id": "GoogleCloudDialogflowCxV3beta1FulfillmentGeneratorSettings",
|
|
11060
|
+
"properties": {
|
|
11061
|
+
"generator": {
|
|
11062
|
+
"description": "Required. The generator to call. Format: `projects//locations//agents//generators/`.",
|
|
11063
|
+
"type": "string"
|
|
11064
|
+
},
|
|
11065
|
+
"inputParameters": {
|
|
11066
|
+
"additionalProperties": {
|
|
11067
|
+
"type": "string"
|
|
11068
|
+
},
|
|
11069
|
+
"description": "Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name",
|
|
11070
|
+
"type": "object"
|
|
11071
|
+
},
|
|
11072
|
+
"outputParameter": {
|
|
11073
|
+
"description": "Required. Output parameter which should contain the generator response.",
|
|
11074
|
+
"type": "string"
|
|
11075
|
+
}
|
|
11076
|
+
},
|
|
11077
|
+
"type": "object"
|
|
11078
|
+
},
|
|
11021
11079
|
"GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction": {
|
|
11022
11080
|
"description": "Setting a parameter value.",
|
|
11023
11081
|
"id": "GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction",
|
|
@@ -13965,6 +14023,10 @@ false
|
|
|
13965
14023
|
"Text that contains the tokenized words of the phrase will be matched, e.g. \"foo\" will match \"a foo bar\" and \"foo bar\", but not \"foobar\"."
|
|
13966
14024
|
],
|
|
13967
14025
|
"type": "string"
|
|
14026
|
+
},
|
|
14027
|
+
"promptSecuritySettings": {
|
|
14028
|
+
"$ref": "GoogleCloudDialogflowCxV3beta1SafetySettingsPromptSecuritySettings",
|
|
14029
|
+
"description": "Optional. Settings for prompt security checks."
|
|
13968
14030
|
}
|
|
13969
14031
|
},
|
|
13970
14032
|
"type": "object"
|
|
@@ -13984,6 +14046,17 @@ false
|
|
|
13984
14046
|
},
|
|
13985
14047
|
"type": "object"
|
|
13986
14048
|
},
|
|
14049
|
+
"GoogleCloudDialogflowCxV3beta1SafetySettingsPromptSecuritySettings": {
|
|
14050
|
+
"description": "Settings for prompt security checks.",
|
|
14051
|
+
"id": "GoogleCloudDialogflowCxV3beta1SafetySettingsPromptSecuritySettings",
|
|
14052
|
+
"properties": {
|
|
14053
|
+
"enablePromptSecurity": {
|
|
14054
|
+
"description": "Optional. Enable prompt security checks.",
|
|
14055
|
+
"type": "boolean"
|
|
14056
|
+
}
|
|
14057
|
+
},
|
|
14058
|
+
"type": "object"
|
|
14059
|
+
},
|
|
13987
14060
|
"GoogleCloudDialogflowCxV3beta1SearchConfig": {
|
|
13988
14061
|
"description": "Search configuration for UCS search queries.",
|
|
13989
14062
|
"id": "GoogleCloudDialogflowCxV3beta1SearchConfig",
|
|
@@ -15644,6 +15717,10 @@ false
|
|
|
15644
15717
|
"description": "Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).",
|
|
15645
15718
|
"type": "string"
|
|
15646
15719
|
},
|
|
15720
|
+
"secondLanguageModel": {
|
|
15721
|
+
"description": "Optional. The name of the second voice (non-English) if language detection is supported.",
|
|
15722
|
+
"type": "string"
|
|
15723
|
+
},
|
|
15647
15724
|
"ssmlGender": {
|
|
15648
15725
|
"description": "Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.",
|
|
15649
15726
|
"enum": [
|
|
@@ -16444,6 +16521,11 @@ false
|
|
|
16444
16521
|
"format": "google-datetime",
|
|
16445
16522
|
"type": "string"
|
|
16446
16523
|
},
|
|
16524
|
+
"doneTime": {
|
|
16525
|
+
"description": "The time when the operation finished.",
|
|
16526
|
+
"format": "google-datetime",
|
|
16527
|
+
"type": "string"
|
|
16528
|
+
},
|
|
16447
16529
|
"state": {
|
|
16448
16530
|
"description": "State of CreateConversationModel operation.",
|
|
16449
16531
|
"enum": [
|
|
@@ -16487,6 +16569,11 @@ false
|
|
|
16487
16569
|
"description": "Timestamp when delete conversation model request was created. The time is measured on server side.",
|
|
16488
16570
|
"format": "google-datetime",
|
|
16489
16571
|
"type": "string"
|
|
16572
|
+
},
|
|
16573
|
+
"doneTime": {
|
|
16574
|
+
"description": "The time when the operation finished.",
|
|
16575
|
+
"format": "google-datetime",
|
|
16576
|
+
"type": "string"
|
|
16490
16577
|
}
|
|
16491
16578
|
},
|
|
16492
16579
|
"type": "object"
|
|
@@ -16503,6 +16590,11 @@ false
|
|
|
16503
16590
|
"description": "Timestamp when request to deploy conversation model was submitted. The time is measured on server side.",
|
|
16504
16591
|
"format": "google-datetime",
|
|
16505
16592
|
"type": "string"
|
|
16593
|
+
},
|
|
16594
|
+
"doneTime": {
|
|
16595
|
+
"description": "The time when the operation finished.",
|
|
16596
|
+
"format": "google-datetime",
|
|
16597
|
+
"type": "string"
|
|
16506
16598
|
}
|
|
16507
16599
|
},
|
|
16508
16600
|
"type": "object"
|
|
@@ -17905,6 +17997,11 @@ true
|
|
|
17905
17997
|
"description": "Metadata in google::longrunning::Operation for Knowledge operations.",
|
|
17906
17998
|
"id": "GoogleCloudDialogflowV2KnowledgeOperationMetadata",
|
|
17907
17999
|
"properties": {
|
|
18000
|
+
"doneTime": {
|
|
18001
|
+
"description": "The time when the operation finished.",
|
|
18002
|
+
"format": "google-datetime",
|
|
18003
|
+
"type": "string"
|
|
18004
|
+
},
|
|
17908
18005
|
"exportOperationMetadata": {
|
|
17909
18006
|
"$ref": "GoogleCloudDialogflowV2ExportOperationMetadata",
|
|
17910
18007
|
"description": "Metadata for the Export Data Operation such as the destination of export."
|
|
@@ -18595,6 +18692,11 @@ true
|
|
|
18595
18692
|
"description": "Timestamp when the request to undeploy conversation model was submitted. The time is measured on server side.",
|
|
18596
18693
|
"format": "google-datetime",
|
|
18597
18694
|
"type": "string"
|
|
18695
|
+
},
|
|
18696
|
+
"doneTime": {
|
|
18697
|
+
"description": "The time when the operation finished.",
|
|
18698
|
+
"format": "google-datetime",
|
|
18699
|
+
"type": "string"
|
|
18598
18700
|
}
|
|
18599
18701
|
},
|
|
18600
18702
|
"type": "object"
|
|
@@ -20612,6 +20714,11 @@ true
|
|
|
20612
20714
|
"description": "Metadata in google::longrunning::Operation for Knowledge operations.",
|
|
20613
20715
|
"id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata",
|
|
20614
20716
|
"properties": {
|
|
20717
|
+
"doneTime": {
|
|
20718
|
+
"description": "The time when the operation finished.",
|
|
20719
|
+
"format": "google-datetime",
|
|
20720
|
+
"type": "string"
|
|
20721
|
+
},
|
|
20615
20722
|
"exportOperationMetadata": {
|
|
20616
20723
|
"$ref": "GoogleCloudDialogflowV2beta1ExportOperationMetadata",
|
|
20617
20724
|
"description": "Metadata for the Export Data Operation such as the destination of export."
|
|
@@ -7052,7 +7052,7 @@
|
|
|
7052
7052
|
}
|
|
7053
7053
|
}
|
|
7054
7054
|
},
|
|
7055
|
-
"revision": "
|
|
7055
|
+
"revision": "20250619",
|
|
7056
7056
|
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
7057
7057
|
"schemas": {
|
|
7058
7058
|
"GoogleApiDistribution": {
|
|
@@ -10971,7 +10971,7 @@
|
|
|
10971
10971
|
],
|
|
10972
10972
|
"type": "string"
|
|
10973
10973
|
},
|
|
10974
|
-
"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback`",
|
|
10974
|
+
"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`",
|
|
10975
10975
|
"type": "object"
|
|
10976
10976
|
},
|
|
10977
10977
|
"industryVertical": {
|
|
@@ -14184,6 +14184,13 @@
|
|
|
14184
14184
|
"query": {
|
|
14185
14185
|
"$ref": "GoogleCloudDiscoveryengineV1Query",
|
|
14186
14186
|
"description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn"
|
|
14187
|
+
},
|
|
14188
|
+
"queryConfig": {
|
|
14189
|
+
"additionalProperties": {
|
|
14190
|
+
"type": "string"
|
|
14191
|
+
},
|
|
14192
|
+
"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). The prefix \"google.\" is reserved for Google-developed functionality.",
|
|
14193
|
+
"type": "object"
|
|
14187
14194
|
}
|
|
14188
14195
|
},
|
|
14189
14196
|
"type": "object"
|
|
@@ -14763,7 +14770,7 @@
|
|
|
14763
14770
|
"type": "string"
|
|
14764
14771
|
},
|
|
14765
14772
|
"licenseAssignmentState": {
|
|
14766
|
-
"description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user
|
|
14773
|
+
"description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user login will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;",
|
|
14767
14774
|
"enum": [
|
|
14768
14775
|
"LICENSE_ASSIGNMENT_STATE_UNSPECIFIED",
|
|
14769
14776
|
"ASSIGNED",
|
|
@@ -16416,6 +16423,31 @@
|
|
|
16416
16423
|
"$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig",
|
|
16417
16424
|
"description": "Optional. Action configurations to make the connector support actions."
|
|
16418
16425
|
},
|
|
16426
|
+
"actionState": {
|
|
16427
|
+
"description": "Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.",
|
|
16428
|
+
"enum": [
|
|
16429
|
+
"STATE_UNSPECIFIED",
|
|
16430
|
+
"CREATING",
|
|
16431
|
+
"ACTIVE",
|
|
16432
|
+
"FAILED",
|
|
16433
|
+
"RUNNING",
|
|
16434
|
+
"WARNING",
|
|
16435
|
+
"INITIALIZATION_FAILED",
|
|
16436
|
+
"UPDATING"
|
|
16437
|
+
],
|
|
16438
|
+
"enumDescriptions": [
|
|
16439
|
+
"Default value.",
|
|
16440
|
+
"The connector is being set up.",
|
|
16441
|
+
"The connector is successfully set up and awaiting next sync run.",
|
|
16442
|
+
"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
|
|
16443
|
+
"The connector is actively syncing records from the data source.",
|
|
16444
|
+
"The connector has completed a sync run, but encountered non-fatal errors.",
|
|
16445
|
+
"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).",
|
|
16446
|
+
"Connector is in the process of an update."
|
|
16447
|
+
],
|
|
16448
|
+
"readOnly": true,
|
|
16449
|
+
"type": "string"
|
|
16450
|
+
},
|
|
16419
16451
|
"alertPolicyConfigs": {
|
|
16420
16452
|
"description": "Optional. The connector level alert config.",
|
|
16421
16453
|
"items": {
|
|
@@ -16457,14 +16489,16 @@
|
|
|
16457
16489
|
"DATA_INGESTION",
|
|
16458
16490
|
"ACTIONS",
|
|
16459
16491
|
"FEDERATED",
|
|
16460
|
-
"EUA"
|
|
16492
|
+
"EUA",
|
|
16493
|
+
"FEDERATED_AND_EUA"
|
|
16461
16494
|
],
|
|
16462
16495
|
"enumDescriptions": [
|
|
16463
16496
|
"Connector mode unspecified.",
|
|
16464
16497
|
"Connector utilized for data ingestion.",
|
|
16465
16498
|
"Connector utilized for actions.",
|
|
16466
16499
|
"Connector utilized for federated search.",
|
|
16467
|
-
"Connector utilized for End User Authentication."
|
|
16500
|
+
"Connector utilized for End User Authentication.",
|
|
16501
|
+
"Hybrid connector utilized for federated search and End User Authentication."
|
|
16468
16502
|
],
|
|
16469
16503
|
"type": "string"
|
|
16470
16504
|
},
|
|
@@ -16552,12 +16586,12 @@
|
|
|
16552
16586
|
"description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector."
|
|
16553
16587
|
},
|
|
16554
16588
|
"incrementalRefreshInterval": {
|
|
16555
|
-
"description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors.",
|
|
16589
|
+
"description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.",
|
|
16556
16590
|
"format": "google-duration",
|
|
16557
16591
|
"type": "string"
|
|
16558
16592
|
},
|
|
16559
16593
|
"incrementalSyncDisabled": {
|
|
16560
|
-
"description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors.",
|
|
16594
|
+
"description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.",
|
|
16561
16595
|
"type": "boolean"
|
|
16562
16596
|
},
|
|
16563
16597
|
"kmsKeyName": {
|
|
@@ -16607,7 +16641,8 @@
|
|
|
16607
16641
|
"FAILED",
|
|
16608
16642
|
"RUNNING",
|
|
16609
16643
|
"WARNING",
|
|
16610
|
-
"INITIALIZATION_FAILED"
|
|
16644
|
+
"INITIALIZATION_FAILED",
|
|
16645
|
+
"UPDATING"
|
|
16611
16646
|
],
|
|
16612
16647
|
"enumDescriptions": [
|
|
16613
16648
|
"Default value.",
|
|
@@ -16616,7 +16651,8 @@
|
|
|
16616
16651
|
"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
|
|
16617
16652
|
"The connector is actively syncing records from the data source.",
|
|
16618
16653
|
"The connector has completed a sync run, but encountered non-fatal errors.",
|
|
16619
|
-
"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types)."
|
|
16654
|
+
"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).",
|
|
16655
|
+
"Connector is in the process of an update."
|
|
16620
16656
|
],
|
|
16621
16657
|
"readOnly": true,
|
|
16622
16658
|
"type": "string"
|
|
@@ -16626,7 +16662,7 @@
|
|
|
16626
16662
|
"description": "Optional. The configuration for realtime sync."
|
|
16627
16663
|
},
|
|
16628
16664
|
"refreshInterval": {
|
|
16629
|
-
"description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days.",
|
|
16665
|
+
"description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.",
|
|
16630
16666
|
"format": "google-duration",
|
|
16631
16667
|
"type": "string"
|
|
16632
16668
|
},
|
|
@@ -16639,7 +16675,8 @@
|
|
|
16639
16675
|
"FAILED",
|
|
16640
16676
|
"RUNNING",
|
|
16641
16677
|
"WARNING",
|
|
16642
|
-
"INITIALIZATION_FAILED"
|
|
16678
|
+
"INITIALIZATION_FAILED",
|
|
16679
|
+
"UPDATING"
|
|
16643
16680
|
],
|
|
16644
16681
|
"enumDescriptions": [
|
|
16645
16682
|
"Default value.",
|
|
@@ -16648,7 +16685,8 @@
|
|
|
16648
16685
|
"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
|
|
16649
16686
|
"The connector is actively syncing records from the data source.",
|
|
16650
16687
|
"The connector has completed a sync run, but encountered non-fatal errors.",
|
|
16651
|
-
"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types)."
|
|
16688
|
+
"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).",
|
|
16689
|
+
"Connector is in the process of an update."
|
|
16652
16690
|
],
|
|
16653
16691
|
"readOnly": true,
|
|
16654
16692
|
"type": "string"
|
|
@@ -17409,7 +17447,7 @@
|
|
|
17409
17447
|
],
|
|
17410
17448
|
"type": "string"
|
|
17411
17449
|
},
|
|
17412
|
-
"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback`",
|
|
17450
|
+
"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`",
|
|
17413
17451
|
"type": "object"
|
|
17414
17452
|
},
|
|
17415
17453
|
"industryVertical": {
|
|
@@ -19302,7 +19340,7 @@
|
|
|
19302
19340
|
"description": "The query expansion specification that specifies the conditions under which query expansion occurs."
|
|
19303
19341
|
},
|
|
19304
19342
|
"rankingExpression": {
|
|
19305
|
-
"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `base_rank`: the default rank of the result",
|
|
19343
|
+
"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
|
|
19306
19344
|
"type": "string"
|
|
19307
19345
|
},
|
|
19308
19346
|
"rankingExpressionBackend": {
|
|
@@ -20077,6 +20115,13 @@ false
|
|
|
20077
20115
|
"query": {
|
|
20078
20116
|
"$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
|
|
20079
20117
|
"description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn"
|
|
20118
|
+
},
|
|
20119
|
+
"queryConfig": {
|
|
20120
|
+
"additionalProperties": {
|
|
20121
|
+
"type": "string"
|
|
20122
|
+
},
|
|
20123
|
+
"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). The prefix \"google.\" is reserved for Google-developed functionality.",
|
|
20124
|
+
"type": "object"
|
|
20080
20125
|
}
|
|
20081
20126
|
},
|
|
20082
20127
|
"type": "object"
|
|
@@ -20508,7 +20553,7 @@ false
|
|
|
20508
20553
|
"type": "string"
|
|
20509
20554
|
},
|
|
20510
20555
|
"licenseAssignmentState": {
|
|
20511
|
-
"description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user
|
|
20556
|
+
"description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user login will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;",
|
|
20512
20557
|
"enum": [
|
|
20513
20558
|
"LICENSE_ASSIGNMENT_STATE_UNSPECIFIED",
|
|
20514
20559
|
"ASSIGNED",
|
|
@@ -21706,7 +21751,7 @@ false
|
|
|
21706
21751
|
],
|
|
21707
21752
|
"type": "string"
|
|
21708
21753
|
},
|
|
21709
|
-
"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback`",
|
|
21754
|
+
"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`",
|
|
21710
21755
|
"type": "object"
|
|
21711
21756
|
},
|
|
21712
21757
|
"industryVertical": {
|
|
@@ -22889,7 +22934,7 @@ false
|
|
|
22889
22934
|
"description": "The query expansion specification that specifies the conditions under which query expansion occurs."
|
|
22890
22935
|
},
|
|
22891
22936
|
"rankingExpression": {
|
|
22892
|
-
"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `base_rank`: the default rank of the result",
|
|
22937
|
+
"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
|
|
22893
22938
|
"type": "string"
|
|
22894
22939
|
},
|
|
22895
22940
|
"rankingExpressionBackend": {
|
|
@@ -23938,7 +23983,7 @@ false
|
|
|
23938
23983
|
"type": "string"
|
|
23939
23984
|
},
|
|
23940
23985
|
"licenseAssignmentState": {
|
|
23941
|
-
"description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user
|
|
23986
|
+
"description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user login will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;",
|
|
23942
23987
|
"enum": [
|
|
23943
23988
|
"LICENSE_ASSIGNMENT_STATE_UNSPECIFIED",
|
|
23944
23989
|
"ASSIGNED",
|