google-api-python-client 2.130.0__py2.py3-none-any.whl → 2.132.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.130.0.dist-info → google_api_python_client-2.132.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.130.0.dist-info → google_api_python_client-2.132.0.dist-info}/RECORD +392 -391
- googleapiclient/discovery_cache/documents/abusiveexperiencereport.v1.json +1 -1
- googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json +1 -1
- googleapiclient/discovery_cache/documents/accessapproval.v1.json +1 -1
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +1 -1
- googleapiclient/discovery_cache/documents/acmedns.v1.json +1 -1
- googleapiclient/discovery_cache/documents/addressvalidation.v1.json +1 -1
- googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +1 -1
- googleapiclient/discovery_cache/documents/adexperiencereport.v1.json +1 -1
- 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 +1 -1
- googleapiclient/discovery_cache/documents/admin.reportsv1.json +1 -1
- googleapiclient/discovery_cache/documents/admob.v1.json +1 -1
- googleapiclient/discovery_cache/documents/admob.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/adsense.v2.json +1 -1
- googleapiclient/discovery_cache/documents/advisorynotifications.v1.json +1 -1
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +583 -201
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +1066 -233
- googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/alloydb.v1.json +87 -7
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +99 -7
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +99 -7
- googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +44 -1
- googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +44 -1
- googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +1 -1
- googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +1 -1
- googleapiclient/discovery_cache/documents/androidenterprise.v1.json +1 -1
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +49 -5
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +1 -1
- googleapiclient/discovery_cache/documents/apigateway.v1.json +1 -1
- googleapiclient/discovery_cache/documents/apigateway.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/apigee.v1.json +1 -1
- googleapiclient/discovery_cache/documents/apikeys.v2.json +1 -1
- googleapiclient/discovery_cache/documents/appengine.v1.json +1 -1
- googleapiclient/discovery_cache/documents/appengine.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/appengine.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/apphub.v1.json +1 -1
- googleapiclient/discovery_cache/documents/apphub.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/artifactregistry.v1.json +27 -2
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +15 -15
- googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +15 -15
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +1 -1
- googleapiclient/discovery_cache/documents/backupdr.v1.json +11 -1
- googleapiclient/discovery_cache/documents/baremetalsolution.v2.json +1 -1
- googleapiclient/discovery_cache/documents/batch.v1.json +9 -5
- googleapiclient/discovery_cache/documents/beyondcorp.v1.json +1 -1
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +121 -1
- googleapiclient/discovery_cache/documents/biglake.v1.json +1 -1
- googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json +1 -1
- googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +1 -1
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +1 -1
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +1 -1
- googleapiclient/discovery_cache/documents/billingbudgets.v1.json +1 -1
- googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +3 -3
- googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/blockchainnodeengine.v1.json +1 -1
- googleapiclient/discovery_cache/documents/blogger.v2.json +1 -1
- googleapiclient/discovery_cache/documents/blogger.v3.json +1 -1
- googleapiclient/discovery_cache/documents/books.v1.json +1 -1
- googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +1 -1
- googleapiclient/discovery_cache/documents/calendar.v3.json +7 -3
- googleapiclient/discovery_cache/documents/certificatemanager.v1.json +1 -1
- googleapiclient/discovery_cache/documents/chat.v1.json +3 -3
- googleapiclient/discovery_cache/documents/checks.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +96 -1
- googleapiclient/discovery_cache/documents/chromepolicy.v1.json +1 -1
- googleapiclient/discovery_cache/documents/chromeuxreport.v1.json +1 -1
- googleapiclient/discovery_cache/documents/civicinfo.v2.json +1 -1
- googleapiclient/discovery_cache/documents/classroom.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudbilling.v1.json +7 -7
- googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +4 -1
- googleapiclient/discovery_cache/documents/cloudbuild.v1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudbuild.v2.json +17 -17
- googleapiclient/discovery_cache/documents/cloudchannel.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/clouddeploy.v1.json +1 -1
- googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +9 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +9 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +9 -1
- googleapiclient/discovery_cache/documents/cloudidentity.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudkms.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudprofiler.v2.json +1 -1
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json +1 -1
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +1 -1
- googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudsearch.v1.json +41 -1
- googleapiclient/discovery_cache/documents/cloudshell.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudsupport.v2.json +1 -1
- googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +1 -1
- googleapiclient/discovery_cache/documents/composer.v1.json +40 -1
- googleapiclient/discovery_cache/documents/composer.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/compute.alpha.json +63 -10
- googleapiclient/discovery_cache/documents/compute.beta.json +66 -10
- googleapiclient/discovery_cache/documents/compute.v1.json +51 -11
- googleapiclient/discovery_cache/documents/config.v1.json +1 -1
- googleapiclient/discovery_cache/documents/connectors.v1.json +14 -1
- googleapiclient/discovery_cache/documents/connectors.v2.json +137 -1
- googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +225 -5
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +22 -790
- googleapiclient/discovery_cache/documents/container.v1.json +7 -3
- googleapiclient/discovery_cache/documents/container.v1beta1.json +9 -3
- googleapiclient/discovery_cache/documents/containeranalysis.v1.json +17 -17
- googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +17 -17
- googleapiclient/discovery_cache/documents/content.v2.1.json +1 -1
- googleapiclient/discovery_cache/documents/customsearch.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datacatalog.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/dataflow.v1b3.json +1 -1
- googleapiclient/discovery_cache/documents/datalineage.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datamigration.v1.json +9 -3
- googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/datapipelines.v1.json +1 -1
- googleapiclient/discovery_cache/documents/dataplex.v1.json +19 -16
- googleapiclient/discovery_cache/documents/dataportability.v1.json +1 -1
- googleapiclient/discovery_cache/documents/dataportability.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/dataproc.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datastore.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datastore.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/datastore.v1beta3.json +1 -1
- googleapiclient/discovery_cache/documents/datastream.v1.json +21 -1
- googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/developerconnect.v1.json +1440 -0
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +620 -3
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +625 -3
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +1 -1
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +1 -1
- googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +1 -1
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +1507 -134
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +1404 -91
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +1550 -177
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +17 -8
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +17 -8
- googleapiclient/discovery_cache/documents/dlp.v2.json +5 -3
- googleapiclient/discovery_cache/documents/dns.v1.json +1 -1
- googleapiclient/discovery_cache/documents/dns.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/docs.v1.json +1 -1
- googleapiclient/discovery_cache/documents/documentai.v1.json +959 -46
- googleapiclient/discovery_cache/documents/documentai.v1beta2.json +579 -1
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +600 -2
- googleapiclient/discovery_cache/documents/domains.v1.json +2 -2
- googleapiclient/discovery_cache/documents/domains.v1alpha2.json +2 -2
- googleapiclient/discovery_cache/documents/domains.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/domainsrdap.v1.json +1 -1
- googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json +1 -1
- googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json +1 -1
- googleapiclient/discovery_cache/documents/drive.v2.json +28 -1
- googleapiclient/discovery_cache/documents/drive.v3.json +21 -1
- googleapiclient/discovery_cache/documents/driveactivity.v2.json +1 -1
- googleapiclient/discovery_cache/documents/drivelabels.v2.json +1 -1
- googleapiclient/discovery_cache/documents/drivelabels.v2beta.json +1 -1
- googleapiclient/discovery_cache/documents/essentialcontacts.v1.json +1 -1
- googleapiclient/discovery_cache/documents/eventarc.v1.json +1 -1
- googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/fcm.v1.json +2 -2
- googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json +11 -1
- googleapiclient/discovery_cache/documents/file.v1.json +85 -1
- googleapiclient/discovery_cache/documents/file.v1beta1.json +82 -1
- googleapiclient/discovery_cache/documents/firebase.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json +123 -3
- googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +7 -7
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebasehosting.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseml.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +9 -1
- googleapiclient/discovery_cache/documents/firebaserules.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/firestore.v1.json +4 -4
- googleapiclient/discovery_cache/documents/firestore.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/firestore.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/fitness.v1.json +1 -1
- googleapiclient/discovery_cache/documents/forms.v1.json +1 -1
- googleapiclient/discovery_cache/documents/games.v1.json +1 -1
- googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json +1 -1
- googleapiclient/discovery_cache/documents/gamesManagement.v1management.json +1 -1
- googleapiclient/discovery_cache/documents/gkebackup.v1.json +178 -3
- googleapiclient/discovery_cache/documents/gkehub.v1.json +1 -1
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +1 -1
- googleapiclient/discovery_cache/documents/gmail.v1.json +1 -31
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +1 -1
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/groupsmigration.v1.json +1 -1
- googleapiclient/discovery_cache/documents/healthcare.v1.json +1 -1
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +1 -5
- googleapiclient/discovery_cache/documents/homegraph.v1.json +1 -1
- googleapiclient/discovery_cache/documents/iam.v1.json +65 -65
- googleapiclient/discovery_cache/documents/iam.v2.json +177 -1
- googleapiclient/discovery_cache/documents/iam.v2beta.json +177 -1
- googleapiclient/discovery_cache/documents/iamcredentials.v1.json +1 -1
- googleapiclient/discovery_cache/documents/iap.v1.json +2 -2
- googleapiclient/discovery_cache/documents/iap.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +1 -1
- googleapiclient/discovery_cache/documents/identitytoolkit.v2.json +3 -2
- googleapiclient/discovery_cache/documents/ids.v1.json +13 -3
- googleapiclient/discovery_cache/documents/indexing.v3.json +1 -1
- googleapiclient/discovery_cache/documents/integrations.v1.json +115 -2
- googleapiclient/discovery_cache/documents/keep.v1.json +1 -1
- googleapiclient/discovery_cache/documents/kgsearch.v1.json +1 -1
- googleapiclient/discovery_cache/documents/kmsinventory.v1.json +1 -1
- googleapiclient/discovery_cache/documents/language.v1.json +1 -1
- googleapiclient/discovery_cache/documents/language.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/language.v2.json +1 -1
- googleapiclient/discovery_cache/documents/libraryagent.v1.json +1 -1
- googleapiclient/discovery_cache/documents/licensing.v1.json +1 -1
- googleapiclient/discovery_cache/documents/lifesciences.v2beta.json +1 -1
- googleapiclient/discovery_cache/documents/localservices.v1.json +1 -1
- googleapiclient/discovery_cache/documents/logging.v2.json +1 -1
- googleapiclient/discovery_cache/documents/looker.v1.json +1 -1
- googleapiclient/discovery_cache/documents/manufacturers.v1.json +1 -1
- googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/metastore.v1.json +1 -1
- googleapiclient/discovery_cache/documents/metastore.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/metastore.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/migrationcenter.v1.json +2 -2
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +366 -3
- googleapiclient/discovery_cache/documents/monitoring.v1.json +1 -1
- googleapiclient/discovery_cache/documents/monitoring.v3.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json +1 -1
- googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +1 -1
- googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +97 -12
- googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +57 -11
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +57 -11
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +1 -1
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/networkservices.v1.json +18 -2
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +18 -2
- googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +1 -1
- googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/orgpolicy.v2.json +1 -1
- googleapiclient/discovery_cache/documents/osconfig.v1.json +1 -1
- googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/osconfig.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/oslogin.v1.json +1 -1
- googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/oslogin.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/pagespeedonline.v5.json +1 -1
- googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +1 -1
- googleapiclient/discovery_cache/documents/people.v1.json +1 -1
- googleapiclient/discovery_cache/documents/places.v1.json +1 -1
- googleapiclient/discovery_cache/documents/playcustomapp.v1.json +1 -1
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/playintegrity.v1.json +1 -1
- googleapiclient/discovery_cache/documents/policyanalyzer.v1.json +116 -1
- googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json +116 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1.json +1 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json +1 -1
- googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/privateca.v1.json +1 -1
- googleapiclient/discovery_cache/documents/privateca.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json +4 -4
- googleapiclient/discovery_cache/documents/publicca.v1.json +1 -1
- googleapiclient/discovery_cache/documents/publicca.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/publicca.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/pubsub.v1.json +1 -1
- googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +1 -1
- googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/pubsublite.v1.json +1 -1
- googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json +1 -1
- googleapiclient/discovery_cache/documents/realtimebidding.v1.json +1 -1
- googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +47 -1
- googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/recommender.v1.json +1 -1
- googleapiclient/discovery_cache/documents/recommender.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/redis.v1.json +171 -15
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +171 -15
- googleapiclient/discovery_cache/documents/reseller.v1.json +1 -1
- googleapiclient/discovery_cache/documents/resourcesettings.v1.json +13 -1
- googleapiclient/discovery_cache/documents/retail.v2.json +1 -1
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +1 -1
- googleapiclient/discovery_cache/documents/retail.v2beta.json +1 -1
- googleapiclient/discovery_cache/documents/run.v1.json +27 -27
- googleapiclient/discovery_cache/documents/run.v2.json +25 -21
- googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json +4 -4
- googleapiclient/discovery_cache/documents/script.v1.json +1 -1
- googleapiclient/discovery_cache/documents/searchconsole.v1.json +1 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1.json +61 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +61 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +61 -1
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +1 -1
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +1 -1
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/servicecontrol.v1.json +3 -1
- googleapiclient/discovery_cache/documents/servicecontrol.v2.json +3 -1
- googleapiclient/discovery_cache/documents/servicedirectory.v1.json +1 -1
- googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/servicemanagement.v1.json +1 -1
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +2 -2
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +1 -1
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/sheets.v4.json +2 -2
- googleapiclient/discovery_cache/documents/slides.v1.json +1 -1
- googleapiclient/discovery_cache/documents/solar.v1.json +1 -1
- googleapiclient/discovery_cache/documents/sourcerepo.v1.json +3 -3
- googleapiclient/discovery_cache/documents/spanner.v1.json +167 -6
- googleapiclient/discovery_cache/documents/speech.v1.json +1 -1
- googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +56 -5
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +60 -5
- googleapiclient/discovery_cache/documents/storage.v1.json +81 -2
- googleapiclient/discovery_cache/documents/storagetransfer.v1.json +1 -1
- googleapiclient/discovery_cache/documents/streetviewpublish.v1.json +1 -1
- googleapiclient/discovery_cache/documents/sts.v1.json +1 -1
- googleapiclient/discovery_cache/documents/sts.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/tagmanager.v1.json +1 -1
- googleapiclient/discovery_cache/documents/tagmanager.v2.json +1 -1
- googleapiclient/discovery_cache/documents/tasks.v1.json +21 -11
- googleapiclient/discovery_cache/documents/testing.v1.json +1 -1
- googleapiclient/discovery_cache/documents/texttospeech.v1.json +1 -1
- googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +1 -1
- googleapiclient/discovery_cache/documents/tpu.v1.json +1 -1
- googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/tpu.v2.json +1 -1
- googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/trafficdirector.v2.json +1 -1
- googleapiclient/discovery_cache/documents/trafficdirector.v3.json +1 -1
- googleapiclient/discovery_cache/documents/transcoder.v1.json +1 -1
- googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +1 -1
- googleapiclient/discovery_cache/documents/vault.v1.json +1 -1
- googleapiclient/discovery_cache/documents/verifiedaccess.v1.json +1 -1
- googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +1 -1
- googleapiclient/discovery_cache/documents/versionhistory.v1.json +5 -1
- googleapiclient/discovery_cache/documents/vision.v1.json +1 -1
- googleapiclient/discovery_cache/documents/vision.v1p1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/vision.v1p2beta1.json +1 -1
- googleapiclient/discovery_cache/documents/vmmigration.v1.json +1 -1
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/vmwareengine.v1.json +1 -1
- googleapiclient/discovery_cache/documents/walletobjects.v1.json +1 -1
- googleapiclient/discovery_cache/documents/webfonts.v1.json +1 -1
- googleapiclient/discovery_cache/documents/webrisk.v1.json +1 -1
- googleapiclient/discovery_cache/documents/websecurityscanner.v1.json +1 -1
- googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +6 -1
- googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/workflows.v1.json +1 -1
- googleapiclient/discovery_cache/documents/workflows.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/workspaceevents.v1.json +1 -1
- googleapiclient/discovery_cache/documents/workstations.v1.json +1 -1
- googleapiclient/discovery_cache/documents/workstations.v1beta.json +39 -1
- googleapiclient/discovery_cache/documents/youtube.v3.json +1 -1
- googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json +1 -1
- googleapiclient/discovery_cache/documents/youtubereporting.v1.json +1 -1
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.130.0.dist-info → google_api_python_client-2.132.0.dist-info}/LICENSE +0 -0
- {google_api_python_client-2.130.0.dist-info → google_api_python_client-2.132.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.130.0.dist-info → google_api_python_client-2.132.0.dist-info}/top_level.txt +0 -0
|
@@ -106,6 +106,36 @@
|
|
|
106
106
|
"protocol": "rest",
|
|
107
107
|
"resources": {
|
|
108
108
|
"projects": {
|
|
109
|
+
"methods": {
|
|
110
|
+
"provision": {
|
|
111
|
+
"description": "Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.",
|
|
112
|
+
"flatPath": "v1beta/projects/{projectsId}:provision",
|
|
113
|
+
"httpMethod": "POST",
|
|
114
|
+
"id": "discoveryengine.projects.provision",
|
|
115
|
+
"parameterOrder": [
|
|
116
|
+
"name"
|
|
117
|
+
],
|
|
118
|
+
"parameters": {
|
|
119
|
+
"name": {
|
|
120
|
+
"description": "Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.",
|
|
121
|
+
"location": "path",
|
|
122
|
+
"pattern": "^projects/[^/]+$",
|
|
123
|
+
"required": true,
|
|
124
|
+
"type": "string"
|
|
125
|
+
}
|
|
126
|
+
},
|
|
127
|
+
"path": "v1beta/{+name}:provision",
|
|
128
|
+
"request": {
|
|
129
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaProvisionProjectRequest"
|
|
130
|
+
},
|
|
131
|
+
"response": {
|
|
132
|
+
"$ref": "GoogleLongrunningOperation"
|
|
133
|
+
},
|
|
134
|
+
"scopes": [
|
|
135
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
136
|
+
]
|
|
137
|
+
}
|
|
138
|
+
},
|
|
109
139
|
"resources": {
|
|
110
140
|
"locations": {
|
|
111
141
|
"resources": {
|
|
@@ -355,7 +385,7 @@
|
|
|
355
385
|
],
|
|
356
386
|
"parameters": {
|
|
357
387
|
"filter": {
|
|
358
|
-
"description": "Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'",
|
|
388
|
+
"description": "Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`",
|
|
359
389
|
"location": "query",
|
|
360
390
|
"type": "string"
|
|
361
391
|
},
|
|
@@ -464,7 +494,7 @@
|
|
|
464
494
|
],
|
|
465
495
|
"parameters": {
|
|
466
496
|
"documentId": {
|
|
467
|
-
"description": "Required. The ID to use for the Document, which
|
|
497
|
+
"description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
468
498
|
"location": "query",
|
|
469
499
|
"type": "string"
|
|
470
500
|
},
|
|
@@ -538,7 +568,7 @@
|
|
|
538
568
|
]
|
|
539
569
|
},
|
|
540
570
|
"import": {
|
|
541
|
-
"description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items
|
|
571
|
+
"description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.",
|
|
542
572
|
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import",
|
|
543
573
|
"httpMethod": "POST",
|
|
544
574
|
"id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.import",
|
|
@@ -575,7 +605,7 @@
|
|
|
575
605
|
],
|
|
576
606
|
"parameters": {
|
|
577
607
|
"pageSize": {
|
|
578
|
-
"description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000
|
|
608
|
+
"description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
|
|
579
609
|
"format": "int32",
|
|
580
610
|
"location": "query",
|
|
581
611
|
"type": "integer"
|
|
@@ -611,7 +641,7 @@
|
|
|
611
641
|
],
|
|
612
642
|
"parameters": {
|
|
613
643
|
"allowMissing": {
|
|
614
|
-
"description": "If set to true
|
|
644
|
+
"description": "If set to `true` and the Document is not found, a new Document is be created.",
|
|
615
645
|
"location": "query",
|
|
616
646
|
"type": "boolean"
|
|
617
647
|
},
|
|
@@ -623,7 +653,7 @@
|
|
|
623
653
|
"type": "string"
|
|
624
654
|
},
|
|
625
655
|
"updateMask": {
|
|
626
|
-
"description": "Indicates which fields in the provided imported 'document' to update. If not set,
|
|
656
|
+
"description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.",
|
|
627
657
|
"format": "google-fieldmask",
|
|
628
658
|
"location": "query",
|
|
629
659
|
"type": "string"
|
|
@@ -770,6 +800,168 @@
|
|
|
770
800
|
}
|
|
771
801
|
}
|
|
772
802
|
},
|
|
803
|
+
"controls": {
|
|
804
|
+
"methods": {
|
|
805
|
+
"create": {
|
|
806
|
+
"description": "Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.",
|
|
807
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls",
|
|
808
|
+
"httpMethod": "POST",
|
|
809
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.controls.create",
|
|
810
|
+
"parameterOrder": [
|
|
811
|
+
"parent"
|
|
812
|
+
],
|
|
813
|
+
"parameters": {
|
|
814
|
+
"controlId": {
|
|
815
|
+
"description": "Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.",
|
|
816
|
+
"location": "query",
|
|
817
|
+
"type": "string"
|
|
818
|
+
},
|
|
819
|
+
"parent": {
|
|
820
|
+
"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`",
|
|
821
|
+
"location": "path",
|
|
822
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
823
|
+
"required": true,
|
|
824
|
+
"type": "string"
|
|
825
|
+
}
|
|
826
|
+
},
|
|
827
|
+
"path": "v1beta/{+parent}/controls",
|
|
828
|
+
"request": {
|
|
829
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
830
|
+
},
|
|
831
|
+
"response": {
|
|
832
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
833
|
+
},
|
|
834
|
+
"scopes": [
|
|
835
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
836
|
+
]
|
|
837
|
+
},
|
|
838
|
+
"delete": {
|
|
839
|
+
"description": "Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.",
|
|
840
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}",
|
|
841
|
+
"httpMethod": "DELETE",
|
|
842
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.controls.delete",
|
|
843
|
+
"parameterOrder": [
|
|
844
|
+
"name"
|
|
845
|
+
],
|
|
846
|
+
"parameters": {
|
|
847
|
+
"name": {
|
|
848
|
+
"description": "Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`",
|
|
849
|
+
"location": "path",
|
|
850
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$",
|
|
851
|
+
"required": true,
|
|
852
|
+
"type": "string"
|
|
853
|
+
}
|
|
854
|
+
},
|
|
855
|
+
"path": "v1beta/{+name}",
|
|
856
|
+
"response": {
|
|
857
|
+
"$ref": "GoogleProtobufEmpty"
|
|
858
|
+
},
|
|
859
|
+
"scopes": [
|
|
860
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
861
|
+
]
|
|
862
|
+
},
|
|
863
|
+
"get": {
|
|
864
|
+
"description": "Gets a Control.",
|
|
865
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}",
|
|
866
|
+
"httpMethod": "GET",
|
|
867
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.controls.get",
|
|
868
|
+
"parameterOrder": [
|
|
869
|
+
"name"
|
|
870
|
+
],
|
|
871
|
+
"parameters": {
|
|
872
|
+
"name": {
|
|
873
|
+
"description": "Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`",
|
|
874
|
+
"location": "path",
|
|
875
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$",
|
|
876
|
+
"required": true,
|
|
877
|
+
"type": "string"
|
|
878
|
+
}
|
|
879
|
+
},
|
|
880
|
+
"path": "v1beta/{+name}",
|
|
881
|
+
"response": {
|
|
882
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
883
|
+
},
|
|
884
|
+
"scopes": [
|
|
885
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
886
|
+
]
|
|
887
|
+
},
|
|
888
|
+
"list": {
|
|
889
|
+
"description": "Lists all Controls by their parent DataStore.",
|
|
890
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls",
|
|
891
|
+
"httpMethod": "GET",
|
|
892
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.controls.list",
|
|
893
|
+
"parameterOrder": [
|
|
894
|
+
"parent"
|
|
895
|
+
],
|
|
896
|
+
"parameters": {
|
|
897
|
+
"filter": {
|
|
898
|
+
"description": "Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.",
|
|
899
|
+
"location": "query",
|
|
900
|
+
"type": "string"
|
|
901
|
+
},
|
|
902
|
+
"pageSize": {
|
|
903
|
+
"description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
904
|
+
"format": "int32",
|
|
905
|
+
"location": "query",
|
|
906
|
+
"type": "integer"
|
|
907
|
+
},
|
|
908
|
+
"pageToken": {
|
|
909
|
+
"description": "Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.",
|
|
910
|
+
"location": "query",
|
|
911
|
+
"type": "string"
|
|
912
|
+
},
|
|
913
|
+
"parent": {
|
|
914
|
+
"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`",
|
|
915
|
+
"location": "path",
|
|
916
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
917
|
+
"required": true,
|
|
918
|
+
"type": "string"
|
|
919
|
+
}
|
|
920
|
+
},
|
|
921
|
+
"path": "v1beta/{+parent}/controls",
|
|
922
|
+
"response": {
|
|
923
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaListControlsResponse"
|
|
924
|
+
},
|
|
925
|
+
"scopes": [
|
|
926
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
927
|
+
]
|
|
928
|
+
},
|
|
929
|
+
"patch": {
|
|
930
|
+
"description": "Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.",
|
|
931
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}",
|
|
932
|
+
"httpMethod": "PATCH",
|
|
933
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.controls.patch",
|
|
934
|
+
"parameterOrder": [
|
|
935
|
+
"name"
|
|
936
|
+
],
|
|
937
|
+
"parameters": {
|
|
938
|
+
"name": {
|
|
939
|
+
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
940
|
+
"location": "path",
|
|
941
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$",
|
|
942
|
+
"required": true,
|
|
943
|
+
"type": "string"
|
|
944
|
+
},
|
|
945
|
+
"updateMask": {
|
|
946
|
+
"description": "Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.",
|
|
947
|
+
"format": "google-fieldmask",
|
|
948
|
+
"location": "query",
|
|
949
|
+
"type": "string"
|
|
950
|
+
}
|
|
951
|
+
},
|
|
952
|
+
"path": "v1beta/{+name}",
|
|
953
|
+
"request": {
|
|
954
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
955
|
+
},
|
|
956
|
+
"response": {
|
|
957
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
958
|
+
},
|
|
959
|
+
"scopes": [
|
|
960
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
961
|
+
]
|
|
962
|
+
}
|
|
963
|
+
}
|
|
964
|
+
},
|
|
773
965
|
"conversations": {
|
|
774
966
|
"methods": {
|
|
775
967
|
"converse": {
|
|
@@ -1152,7 +1344,7 @@
|
|
|
1152
1344
|
"type": "string"
|
|
1153
1345
|
},
|
|
1154
1346
|
"schemaId": {
|
|
1155
|
-
"description": "Required. The ID to use for the Schema, which
|
|
1347
|
+
"description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.",
|
|
1156
1348
|
"location": "query",
|
|
1157
1349
|
"type": "string"
|
|
1158
1350
|
}
|
|
@@ -1228,7 +1420,7 @@
|
|
|
1228
1420
|
],
|
|
1229
1421
|
"parameters": {
|
|
1230
1422
|
"pageSize": {
|
|
1231
|
-
"description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas
|
|
1423
|
+
"description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.",
|
|
1232
1424
|
"format": "int32",
|
|
1233
1425
|
"location": "query",
|
|
1234
1426
|
"type": "integer"
|
|
@@ -1264,7 +1456,7 @@
|
|
|
1264
1456
|
],
|
|
1265
1457
|
"parameters": {
|
|
1266
1458
|
"allowMissing": {
|
|
1267
|
-
"description": "If set to true, and the Schema is not found, a new Schema
|
|
1459
|
+
"description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.",
|
|
1268
1460
|
"location": "query",
|
|
1269
1461
|
"type": "boolean"
|
|
1270
1462
|
},
|
|
@@ -1496,7 +1688,7 @@
|
|
|
1496
1688
|
],
|
|
1497
1689
|
"parameters": {
|
|
1498
1690
|
"servingConfig": {
|
|
1499
|
-
"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
|
|
1691
|
+
"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.",
|
|
1500
1692
|
"location": "path",
|
|
1501
1693
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
1502
1694
|
"required": true,
|
|
@@ -2311,7 +2503,7 @@
|
|
|
2311
2503
|
]
|
|
2312
2504
|
},
|
|
2313
2505
|
"import": {
|
|
2314
|
-
"description": "Bulk import of
|
|
2506
|
+
"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.",
|
|
2315
2507
|
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:import",
|
|
2316
2508
|
"httpMethod": "POST",
|
|
2317
2509
|
"id": "discoveryengine.projects.locations.collections.dataStores.userEvents.import",
|
|
@@ -2353,6 +2545,11 @@
|
|
|
2353
2545
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
2354
2546
|
"required": true,
|
|
2355
2547
|
"type": "string"
|
|
2548
|
+
},
|
|
2549
|
+
"writeAsync": {
|
|
2550
|
+
"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.",
|
|
2551
|
+
"location": "query",
|
|
2552
|
+
"type": "boolean"
|
|
2356
2553
|
}
|
|
2357
2554
|
},
|
|
2358
2555
|
"path": "v1beta/{+parent}/userEvents:write",
|
|
@@ -2616,77 +2813,54 @@
|
|
|
2616
2813
|
}
|
|
2617
2814
|
},
|
|
2618
2815
|
"resources": {
|
|
2619
|
-
"
|
|
2816
|
+
"controls": {
|
|
2620
2817
|
"methods": {
|
|
2621
|
-
"converse": {
|
|
2622
|
-
"description": "Converses a conversation.",
|
|
2623
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}:converse",
|
|
2624
|
-
"httpMethod": "POST",
|
|
2625
|
-
"id": "discoveryengine.projects.locations.collections.engines.conversations.converse",
|
|
2626
|
-
"parameterOrder": [
|
|
2627
|
-
"name"
|
|
2628
|
-
],
|
|
2629
|
-
"parameters": {
|
|
2630
|
-
"name": {
|
|
2631
|
-
"description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.",
|
|
2632
|
-
"location": "path",
|
|
2633
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$",
|
|
2634
|
-
"required": true,
|
|
2635
|
-
"type": "string"
|
|
2636
|
-
}
|
|
2637
|
-
},
|
|
2638
|
-
"path": "v1beta/{+name}:converse",
|
|
2639
|
-
"request": {
|
|
2640
|
-
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationRequest"
|
|
2641
|
-
},
|
|
2642
|
-
"response": {
|
|
2643
|
-
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationResponse"
|
|
2644
|
-
},
|
|
2645
|
-
"scopes": [
|
|
2646
|
-
"https://www.googleapis.com/auth/cloud-platform"
|
|
2647
|
-
]
|
|
2648
|
-
},
|
|
2649
2818
|
"create": {
|
|
2650
|
-
"description": "Creates a
|
|
2651
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/
|
|
2819
|
+
"description": "Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.",
|
|
2820
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls",
|
|
2652
2821
|
"httpMethod": "POST",
|
|
2653
|
-
"id": "discoveryengine.projects.locations.collections.engines.
|
|
2822
|
+
"id": "discoveryengine.projects.locations.collections.engines.controls.create",
|
|
2654
2823
|
"parameterOrder": [
|
|
2655
2824
|
"parent"
|
|
2656
2825
|
],
|
|
2657
2826
|
"parameters": {
|
|
2827
|
+
"controlId": {
|
|
2828
|
+
"description": "Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.",
|
|
2829
|
+
"location": "query",
|
|
2830
|
+
"type": "string"
|
|
2831
|
+
},
|
|
2658
2832
|
"parent": {
|
|
2659
|
-
"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{
|
|
2833
|
+
"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`",
|
|
2660
2834
|
"location": "path",
|
|
2661
2835
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
|
|
2662
2836
|
"required": true,
|
|
2663
2837
|
"type": "string"
|
|
2664
2838
|
}
|
|
2665
2839
|
},
|
|
2666
|
-
"path": "v1beta/{+parent}/
|
|
2840
|
+
"path": "v1beta/{+parent}/controls",
|
|
2667
2841
|
"request": {
|
|
2668
|
-
"$ref": "
|
|
2842
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
2669
2843
|
},
|
|
2670
2844
|
"response": {
|
|
2671
|
-
"$ref": "
|
|
2845
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
2672
2846
|
},
|
|
2673
2847
|
"scopes": [
|
|
2674
2848
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
2675
2849
|
]
|
|
2676
2850
|
},
|
|
2677
2851
|
"delete": {
|
|
2678
|
-
"description": "Deletes a
|
|
2679
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/
|
|
2852
|
+
"description": "Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.",
|
|
2853
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}",
|
|
2680
2854
|
"httpMethod": "DELETE",
|
|
2681
|
-
"id": "discoveryengine.projects.locations.collections.engines.
|
|
2855
|
+
"id": "discoveryengine.projects.locations.collections.engines.controls.delete",
|
|
2682
2856
|
"parameterOrder": [
|
|
2683
2857
|
"name"
|
|
2684
2858
|
],
|
|
2685
2859
|
"parameters": {
|
|
2686
2860
|
"name": {
|
|
2687
|
-
"description": "Required. The resource name of the
|
|
2861
|
+
"description": "Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`",
|
|
2688
2862
|
"location": "path",
|
|
2689
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/
|
|
2863
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$",
|
|
2690
2864
|
"required": true,
|
|
2691
2865
|
"type": "string"
|
|
2692
2866
|
}
|
|
@@ -2700,94 +2874,89 @@
|
|
|
2700
2874
|
]
|
|
2701
2875
|
},
|
|
2702
2876
|
"get": {
|
|
2703
|
-
"description": "Gets a
|
|
2704
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/
|
|
2877
|
+
"description": "Gets a Control.",
|
|
2878
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}",
|
|
2705
2879
|
"httpMethod": "GET",
|
|
2706
|
-
"id": "discoveryengine.projects.locations.collections.engines.
|
|
2880
|
+
"id": "discoveryengine.projects.locations.collections.engines.controls.get",
|
|
2707
2881
|
"parameterOrder": [
|
|
2708
2882
|
"name"
|
|
2709
2883
|
],
|
|
2710
2884
|
"parameters": {
|
|
2711
2885
|
"name": {
|
|
2712
|
-
"description": "Required. The resource name of the
|
|
2886
|
+
"description": "Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`",
|
|
2713
2887
|
"location": "path",
|
|
2714
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/
|
|
2888
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$",
|
|
2715
2889
|
"required": true,
|
|
2716
2890
|
"type": "string"
|
|
2717
2891
|
}
|
|
2718
2892
|
},
|
|
2719
2893
|
"path": "v1beta/{+name}",
|
|
2720
2894
|
"response": {
|
|
2721
|
-
"$ref": "
|
|
2895
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
2722
2896
|
},
|
|
2723
2897
|
"scopes": [
|
|
2724
2898
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
2725
2899
|
]
|
|
2726
2900
|
},
|
|
2727
2901
|
"list": {
|
|
2728
|
-
"description": "Lists all
|
|
2729
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/
|
|
2902
|
+
"description": "Lists all Controls by their parent DataStore.",
|
|
2903
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls",
|
|
2730
2904
|
"httpMethod": "GET",
|
|
2731
|
-
"id": "discoveryengine.projects.locations.collections.engines.
|
|
2905
|
+
"id": "discoveryengine.projects.locations.collections.engines.controls.list",
|
|
2732
2906
|
"parameterOrder": [
|
|
2733
2907
|
"parent"
|
|
2734
2908
|
],
|
|
2735
2909
|
"parameters": {
|
|
2736
2910
|
"filter": {
|
|
2737
|
-
"description": "A filter to apply on the list results.
|
|
2738
|
-
"location": "query",
|
|
2739
|
-
"type": "string"
|
|
2740
|
-
},
|
|
2741
|
-
"orderBy": {
|
|
2742
|
-
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: \"update_time desc\" \"create_time\"",
|
|
2911
|
+
"description": "Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.",
|
|
2743
2912
|
"location": "query",
|
|
2744
2913
|
"type": "string"
|
|
2745
2914
|
},
|
|
2746
2915
|
"pageSize": {
|
|
2747
|
-
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
2916
|
+
"description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
2748
2917
|
"format": "int32",
|
|
2749
2918
|
"location": "query",
|
|
2750
2919
|
"type": "integer"
|
|
2751
2920
|
},
|
|
2752
2921
|
"pageToken": {
|
|
2753
|
-
"description": "A page token, received from a previous `
|
|
2922
|
+
"description": "Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.",
|
|
2754
2923
|
"location": "query",
|
|
2755
2924
|
"type": "string"
|
|
2756
2925
|
},
|
|
2757
2926
|
"parent": {
|
|
2758
|
-
"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{
|
|
2927
|
+
"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`",
|
|
2759
2928
|
"location": "path",
|
|
2760
2929
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
|
|
2761
2930
|
"required": true,
|
|
2762
2931
|
"type": "string"
|
|
2763
2932
|
}
|
|
2764
2933
|
},
|
|
2765
|
-
"path": "v1beta/{+parent}/
|
|
2934
|
+
"path": "v1beta/{+parent}/controls",
|
|
2766
2935
|
"response": {
|
|
2767
|
-
"$ref": "
|
|
2936
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaListControlsResponse"
|
|
2768
2937
|
},
|
|
2769
2938
|
"scopes": [
|
|
2770
2939
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
2771
2940
|
]
|
|
2772
2941
|
},
|
|
2773
2942
|
"patch": {
|
|
2774
|
-
"description": "Updates a
|
|
2775
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/
|
|
2943
|
+
"description": "Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.",
|
|
2944
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}",
|
|
2776
2945
|
"httpMethod": "PATCH",
|
|
2777
|
-
"id": "discoveryengine.projects.locations.collections.engines.
|
|
2946
|
+
"id": "discoveryengine.projects.locations.collections.engines.controls.patch",
|
|
2778
2947
|
"parameterOrder": [
|
|
2779
2948
|
"name"
|
|
2780
2949
|
],
|
|
2781
2950
|
"parameters": {
|
|
2782
2951
|
"name": {
|
|
2783
|
-
"description": "Immutable. Fully qualified name `projects
|
|
2952
|
+
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
2784
2953
|
"location": "path",
|
|
2785
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/
|
|
2954
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$",
|
|
2786
2955
|
"required": true,
|
|
2787
2956
|
"type": "string"
|
|
2788
2957
|
},
|
|
2789
2958
|
"updateMask": {
|
|
2790
|
-
"description": "Indicates which fields in the provided
|
|
2959
|
+
"description": "Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.",
|
|
2791
2960
|
"format": "google-fieldmask",
|
|
2792
2961
|
"location": "query",
|
|
2793
2962
|
"type": "string"
|
|
@@ -2795,10 +2964,10 @@
|
|
|
2795
2964
|
},
|
|
2796
2965
|
"path": "v1beta/{+name}",
|
|
2797
2966
|
"request": {
|
|
2798
|
-
"$ref": "
|
|
2967
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
2799
2968
|
},
|
|
2800
2969
|
"response": {
|
|
2801
|
-
"$ref": "
|
|
2970
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
2802
2971
|
},
|
|
2803
2972
|
"scopes": [
|
|
2804
2973
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
@@ -2806,40 +2975,230 @@
|
|
|
2806
2975
|
}
|
|
2807
2976
|
}
|
|
2808
2977
|
},
|
|
2809
|
-
"
|
|
2978
|
+
"conversations": {
|
|
2810
2979
|
"methods": {
|
|
2811
|
-
"
|
|
2812
|
-
"description": "
|
|
2813
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/
|
|
2814
|
-
"httpMethod": "
|
|
2815
|
-
"id": "discoveryengine.projects.locations.collections.engines.
|
|
2980
|
+
"converse": {
|
|
2981
|
+
"description": "Converses a conversation.",
|
|
2982
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}:converse",
|
|
2983
|
+
"httpMethod": "POST",
|
|
2984
|
+
"id": "discoveryengine.projects.locations.collections.engines.conversations.converse",
|
|
2816
2985
|
"parameterOrder": [
|
|
2817
2986
|
"name"
|
|
2818
2987
|
],
|
|
2819
2988
|
"parameters": {
|
|
2820
2989
|
"name": {
|
|
2821
|
-
"description": "The name of the
|
|
2990
|
+
"description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.",
|
|
2822
2991
|
"location": "path",
|
|
2823
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/
|
|
2992
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$",
|
|
2824
2993
|
"required": true,
|
|
2825
2994
|
"type": "string"
|
|
2826
2995
|
}
|
|
2827
2996
|
},
|
|
2828
|
-
"path": "v1beta/{+name}",
|
|
2997
|
+
"path": "v1beta/{+name}:converse",
|
|
2998
|
+
"request": {
|
|
2999
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationRequest"
|
|
3000
|
+
},
|
|
2829
3001
|
"response": {
|
|
2830
|
-
"$ref": "
|
|
3002
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationResponse"
|
|
2831
3003
|
},
|
|
2832
3004
|
"scopes": [
|
|
2833
3005
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
2834
3006
|
]
|
|
2835
3007
|
},
|
|
2836
|
-
"
|
|
2837
|
-
"description": "
|
|
2838
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/
|
|
2839
|
-
"httpMethod": "
|
|
2840
|
-
"id": "discoveryengine.projects.locations.collections.engines.
|
|
3008
|
+
"create": {
|
|
3009
|
+
"description": "Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.",
|
|
3010
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations",
|
|
3011
|
+
"httpMethod": "POST",
|
|
3012
|
+
"id": "discoveryengine.projects.locations.collections.engines.conversations.create",
|
|
2841
3013
|
"parameterOrder": [
|
|
2842
|
-
"
|
|
3014
|
+
"parent"
|
|
3015
|
+
],
|
|
3016
|
+
"parameters": {
|
|
3017
|
+
"parent": {
|
|
3018
|
+
"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`",
|
|
3019
|
+
"location": "path",
|
|
3020
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
|
|
3021
|
+
"required": true,
|
|
3022
|
+
"type": "string"
|
|
3023
|
+
}
|
|
3024
|
+
},
|
|
3025
|
+
"path": "v1beta/{+parent}/conversations",
|
|
3026
|
+
"request": {
|
|
3027
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
3028
|
+
},
|
|
3029
|
+
"response": {
|
|
3030
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
3031
|
+
},
|
|
3032
|
+
"scopes": [
|
|
3033
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3034
|
+
]
|
|
3035
|
+
},
|
|
3036
|
+
"delete": {
|
|
3037
|
+
"description": "Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.",
|
|
3038
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}",
|
|
3039
|
+
"httpMethod": "DELETE",
|
|
3040
|
+
"id": "discoveryengine.projects.locations.collections.engines.conversations.delete",
|
|
3041
|
+
"parameterOrder": [
|
|
3042
|
+
"name"
|
|
3043
|
+
],
|
|
3044
|
+
"parameters": {
|
|
3045
|
+
"name": {
|
|
3046
|
+
"description": "Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`",
|
|
3047
|
+
"location": "path",
|
|
3048
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$",
|
|
3049
|
+
"required": true,
|
|
3050
|
+
"type": "string"
|
|
3051
|
+
}
|
|
3052
|
+
},
|
|
3053
|
+
"path": "v1beta/{+name}",
|
|
3054
|
+
"response": {
|
|
3055
|
+
"$ref": "GoogleProtobufEmpty"
|
|
3056
|
+
},
|
|
3057
|
+
"scopes": [
|
|
3058
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3059
|
+
]
|
|
3060
|
+
},
|
|
3061
|
+
"get": {
|
|
3062
|
+
"description": "Gets a Conversation.",
|
|
3063
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}",
|
|
3064
|
+
"httpMethod": "GET",
|
|
3065
|
+
"id": "discoveryengine.projects.locations.collections.engines.conversations.get",
|
|
3066
|
+
"parameterOrder": [
|
|
3067
|
+
"name"
|
|
3068
|
+
],
|
|
3069
|
+
"parameters": {
|
|
3070
|
+
"name": {
|
|
3071
|
+
"description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`",
|
|
3072
|
+
"location": "path",
|
|
3073
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$",
|
|
3074
|
+
"required": true,
|
|
3075
|
+
"type": "string"
|
|
3076
|
+
}
|
|
3077
|
+
},
|
|
3078
|
+
"path": "v1beta/{+name}",
|
|
3079
|
+
"response": {
|
|
3080
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
3081
|
+
},
|
|
3082
|
+
"scopes": [
|
|
3083
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3084
|
+
]
|
|
3085
|
+
},
|
|
3086
|
+
"list": {
|
|
3087
|
+
"description": "Lists all Conversations by their parent DataStore.",
|
|
3088
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations",
|
|
3089
|
+
"httpMethod": "GET",
|
|
3090
|
+
"id": "discoveryengine.projects.locations.collections.engines.conversations.list",
|
|
3091
|
+
"parameterOrder": [
|
|
3092
|
+
"parent"
|
|
3093
|
+
],
|
|
3094
|
+
"parameters": {
|
|
3095
|
+
"filter": {
|
|
3096
|
+
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
|
|
3097
|
+
"location": "query",
|
|
3098
|
+
"type": "string"
|
|
3099
|
+
},
|
|
3100
|
+
"orderBy": {
|
|
3101
|
+
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: \"update_time desc\" \"create_time\"",
|
|
3102
|
+
"location": "query",
|
|
3103
|
+
"type": "string"
|
|
3104
|
+
},
|
|
3105
|
+
"pageSize": {
|
|
3106
|
+
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
3107
|
+
"format": "int32",
|
|
3108
|
+
"location": "query",
|
|
3109
|
+
"type": "integer"
|
|
3110
|
+
},
|
|
3111
|
+
"pageToken": {
|
|
3112
|
+
"description": "A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.",
|
|
3113
|
+
"location": "query",
|
|
3114
|
+
"type": "string"
|
|
3115
|
+
},
|
|
3116
|
+
"parent": {
|
|
3117
|
+
"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`",
|
|
3118
|
+
"location": "path",
|
|
3119
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
|
|
3120
|
+
"required": true,
|
|
3121
|
+
"type": "string"
|
|
3122
|
+
}
|
|
3123
|
+
},
|
|
3124
|
+
"path": "v1beta/{+parent}/conversations",
|
|
3125
|
+
"response": {
|
|
3126
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaListConversationsResponse"
|
|
3127
|
+
},
|
|
3128
|
+
"scopes": [
|
|
3129
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3130
|
+
]
|
|
3131
|
+
},
|
|
3132
|
+
"patch": {
|
|
3133
|
+
"description": "Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.",
|
|
3134
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}",
|
|
3135
|
+
"httpMethod": "PATCH",
|
|
3136
|
+
"id": "discoveryengine.projects.locations.collections.engines.conversations.patch",
|
|
3137
|
+
"parameterOrder": [
|
|
3138
|
+
"name"
|
|
3139
|
+
],
|
|
3140
|
+
"parameters": {
|
|
3141
|
+
"name": {
|
|
3142
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.",
|
|
3143
|
+
"location": "path",
|
|
3144
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$",
|
|
3145
|
+
"required": true,
|
|
3146
|
+
"type": "string"
|
|
3147
|
+
},
|
|
3148
|
+
"updateMask": {
|
|
3149
|
+
"description": "Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.",
|
|
3150
|
+
"format": "google-fieldmask",
|
|
3151
|
+
"location": "query",
|
|
3152
|
+
"type": "string"
|
|
3153
|
+
}
|
|
3154
|
+
},
|
|
3155
|
+
"path": "v1beta/{+name}",
|
|
3156
|
+
"request": {
|
|
3157
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
3158
|
+
},
|
|
3159
|
+
"response": {
|
|
3160
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
3161
|
+
},
|
|
3162
|
+
"scopes": [
|
|
3163
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3164
|
+
]
|
|
3165
|
+
}
|
|
3166
|
+
}
|
|
3167
|
+
},
|
|
3168
|
+
"operations": {
|
|
3169
|
+
"methods": {
|
|
3170
|
+
"get": {
|
|
3171
|
+
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
|
|
3172
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}",
|
|
3173
|
+
"httpMethod": "GET",
|
|
3174
|
+
"id": "discoveryengine.projects.locations.collections.engines.operations.get",
|
|
3175
|
+
"parameterOrder": [
|
|
3176
|
+
"name"
|
|
3177
|
+
],
|
|
3178
|
+
"parameters": {
|
|
3179
|
+
"name": {
|
|
3180
|
+
"description": "The name of the operation resource.",
|
|
3181
|
+
"location": "path",
|
|
3182
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/operations/[^/]+$",
|
|
3183
|
+
"required": true,
|
|
3184
|
+
"type": "string"
|
|
3185
|
+
}
|
|
3186
|
+
},
|
|
3187
|
+
"path": "v1beta/{+name}",
|
|
3188
|
+
"response": {
|
|
3189
|
+
"$ref": "GoogleLongrunningOperation"
|
|
3190
|
+
},
|
|
3191
|
+
"scopes": [
|
|
3192
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3193
|
+
]
|
|
3194
|
+
},
|
|
3195
|
+
"list": {
|
|
3196
|
+
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
|
|
3197
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations",
|
|
3198
|
+
"httpMethod": "GET",
|
|
3199
|
+
"id": "discoveryengine.projects.locations.collections.engines.operations.list",
|
|
3200
|
+
"parameterOrder": [
|
|
3201
|
+
"name"
|
|
2843
3202
|
],
|
|
2844
3203
|
"parameters": {
|
|
2845
3204
|
"filter": {
|
|
@@ -3011,7 +3370,7 @@
|
|
|
3011
3370
|
],
|
|
3012
3371
|
"parameters": {
|
|
3013
3372
|
"servingConfig": {
|
|
3014
|
-
"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
|
|
3373
|
+
"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.",
|
|
3015
3374
|
"location": "path",
|
|
3016
3375
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
|
|
3017
3376
|
"required": true,
|
|
@@ -3496,7 +3855,7 @@
|
|
|
3496
3855
|
],
|
|
3497
3856
|
"parameters": {
|
|
3498
3857
|
"filter": {
|
|
3499
|
-
"description": "Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'",
|
|
3858
|
+
"description": "Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`",
|
|
3500
3859
|
"location": "query",
|
|
3501
3860
|
"type": "string"
|
|
3502
3861
|
},
|
|
@@ -3577,7 +3936,7 @@
|
|
|
3577
3936
|
],
|
|
3578
3937
|
"parameters": {
|
|
3579
3938
|
"documentId": {
|
|
3580
|
-
"description": "Required. The ID to use for the Document, which
|
|
3939
|
+
"description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
3581
3940
|
"location": "query",
|
|
3582
3941
|
"type": "string"
|
|
3583
3942
|
},
|
|
@@ -3651,7 +4010,7 @@
|
|
|
3651
4010
|
]
|
|
3652
4011
|
},
|
|
3653
4012
|
"import": {
|
|
3654
|
-
"description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items
|
|
4013
|
+
"description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.",
|
|
3655
4014
|
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import",
|
|
3656
4015
|
"httpMethod": "POST",
|
|
3657
4016
|
"id": "discoveryengine.projects.locations.dataStores.branches.documents.import",
|
|
@@ -3688,7 +4047,7 @@
|
|
|
3688
4047
|
],
|
|
3689
4048
|
"parameters": {
|
|
3690
4049
|
"pageSize": {
|
|
3691
|
-
"description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000
|
|
4050
|
+
"description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
|
|
3692
4051
|
"format": "int32",
|
|
3693
4052
|
"location": "query",
|
|
3694
4053
|
"type": "integer"
|
|
@@ -3724,7 +4083,7 @@
|
|
|
3724
4083
|
],
|
|
3725
4084
|
"parameters": {
|
|
3726
4085
|
"allowMissing": {
|
|
3727
|
-
"description": "If set to true
|
|
4086
|
+
"description": "If set to `true` and the Document is not found, a new Document is be created.",
|
|
3728
4087
|
"location": "query",
|
|
3729
4088
|
"type": "boolean"
|
|
3730
4089
|
},
|
|
@@ -3736,7 +4095,7 @@
|
|
|
3736
4095
|
"type": "string"
|
|
3737
4096
|
},
|
|
3738
4097
|
"updateMask": {
|
|
3739
|
-
"description": "Indicates which fields in the provided imported 'document' to update. If not set,
|
|
4098
|
+
"description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.",
|
|
3740
4099
|
"format": "google-fieldmask",
|
|
3741
4100
|
"location": "query",
|
|
3742
4101
|
"type": "string"
|
|
@@ -3883,6 +4242,168 @@
|
|
|
3883
4242
|
}
|
|
3884
4243
|
}
|
|
3885
4244
|
},
|
|
4245
|
+
"controls": {
|
|
4246
|
+
"methods": {
|
|
4247
|
+
"create": {
|
|
4248
|
+
"description": "Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.",
|
|
4249
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls",
|
|
4250
|
+
"httpMethod": "POST",
|
|
4251
|
+
"id": "discoveryengine.projects.locations.dataStores.controls.create",
|
|
4252
|
+
"parameterOrder": [
|
|
4253
|
+
"parent"
|
|
4254
|
+
],
|
|
4255
|
+
"parameters": {
|
|
4256
|
+
"controlId": {
|
|
4257
|
+
"description": "Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.",
|
|
4258
|
+
"location": "query",
|
|
4259
|
+
"type": "string"
|
|
4260
|
+
},
|
|
4261
|
+
"parent": {
|
|
4262
|
+
"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`",
|
|
4263
|
+
"location": "path",
|
|
4264
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
4265
|
+
"required": true,
|
|
4266
|
+
"type": "string"
|
|
4267
|
+
}
|
|
4268
|
+
},
|
|
4269
|
+
"path": "v1beta/{+parent}/controls",
|
|
4270
|
+
"request": {
|
|
4271
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
4272
|
+
},
|
|
4273
|
+
"response": {
|
|
4274
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
4275
|
+
},
|
|
4276
|
+
"scopes": [
|
|
4277
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
4278
|
+
]
|
|
4279
|
+
},
|
|
4280
|
+
"delete": {
|
|
4281
|
+
"description": "Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.",
|
|
4282
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}",
|
|
4283
|
+
"httpMethod": "DELETE",
|
|
4284
|
+
"id": "discoveryengine.projects.locations.dataStores.controls.delete",
|
|
4285
|
+
"parameterOrder": [
|
|
4286
|
+
"name"
|
|
4287
|
+
],
|
|
4288
|
+
"parameters": {
|
|
4289
|
+
"name": {
|
|
4290
|
+
"description": "Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`",
|
|
4291
|
+
"location": "path",
|
|
4292
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$",
|
|
4293
|
+
"required": true,
|
|
4294
|
+
"type": "string"
|
|
4295
|
+
}
|
|
4296
|
+
},
|
|
4297
|
+
"path": "v1beta/{+name}",
|
|
4298
|
+
"response": {
|
|
4299
|
+
"$ref": "GoogleProtobufEmpty"
|
|
4300
|
+
},
|
|
4301
|
+
"scopes": [
|
|
4302
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
4303
|
+
]
|
|
4304
|
+
},
|
|
4305
|
+
"get": {
|
|
4306
|
+
"description": "Gets a Control.",
|
|
4307
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}",
|
|
4308
|
+
"httpMethod": "GET",
|
|
4309
|
+
"id": "discoveryengine.projects.locations.dataStores.controls.get",
|
|
4310
|
+
"parameterOrder": [
|
|
4311
|
+
"name"
|
|
4312
|
+
],
|
|
4313
|
+
"parameters": {
|
|
4314
|
+
"name": {
|
|
4315
|
+
"description": "Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`",
|
|
4316
|
+
"location": "path",
|
|
4317
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$",
|
|
4318
|
+
"required": true,
|
|
4319
|
+
"type": "string"
|
|
4320
|
+
}
|
|
4321
|
+
},
|
|
4322
|
+
"path": "v1beta/{+name}",
|
|
4323
|
+
"response": {
|
|
4324
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
4325
|
+
},
|
|
4326
|
+
"scopes": [
|
|
4327
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
4328
|
+
]
|
|
4329
|
+
},
|
|
4330
|
+
"list": {
|
|
4331
|
+
"description": "Lists all Controls by their parent DataStore.",
|
|
4332
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls",
|
|
4333
|
+
"httpMethod": "GET",
|
|
4334
|
+
"id": "discoveryengine.projects.locations.dataStores.controls.list",
|
|
4335
|
+
"parameterOrder": [
|
|
4336
|
+
"parent"
|
|
4337
|
+
],
|
|
4338
|
+
"parameters": {
|
|
4339
|
+
"filter": {
|
|
4340
|
+
"description": "Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.",
|
|
4341
|
+
"location": "query",
|
|
4342
|
+
"type": "string"
|
|
4343
|
+
},
|
|
4344
|
+
"pageSize": {
|
|
4345
|
+
"description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
4346
|
+
"format": "int32",
|
|
4347
|
+
"location": "query",
|
|
4348
|
+
"type": "integer"
|
|
4349
|
+
},
|
|
4350
|
+
"pageToken": {
|
|
4351
|
+
"description": "Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.",
|
|
4352
|
+
"location": "query",
|
|
4353
|
+
"type": "string"
|
|
4354
|
+
},
|
|
4355
|
+
"parent": {
|
|
4356
|
+
"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`",
|
|
4357
|
+
"location": "path",
|
|
4358
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
4359
|
+
"required": true,
|
|
4360
|
+
"type": "string"
|
|
4361
|
+
}
|
|
4362
|
+
},
|
|
4363
|
+
"path": "v1beta/{+parent}/controls",
|
|
4364
|
+
"response": {
|
|
4365
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaListControlsResponse"
|
|
4366
|
+
},
|
|
4367
|
+
"scopes": [
|
|
4368
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
4369
|
+
]
|
|
4370
|
+
},
|
|
4371
|
+
"patch": {
|
|
4372
|
+
"description": "Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.",
|
|
4373
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}",
|
|
4374
|
+
"httpMethod": "PATCH",
|
|
4375
|
+
"id": "discoveryengine.projects.locations.dataStores.controls.patch",
|
|
4376
|
+
"parameterOrder": [
|
|
4377
|
+
"name"
|
|
4378
|
+
],
|
|
4379
|
+
"parameters": {
|
|
4380
|
+
"name": {
|
|
4381
|
+
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
4382
|
+
"location": "path",
|
|
4383
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$",
|
|
4384
|
+
"required": true,
|
|
4385
|
+
"type": "string"
|
|
4386
|
+
},
|
|
4387
|
+
"updateMask": {
|
|
4388
|
+
"description": "Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.",
|
|
4389
|
+
"format": "google-fieldmask",
|
|
4390
|
+
"location": "query",
|
|
4391
|
+
"type": "string"
|
|
4392
|
+
}
|
|
4393
|
+
},
|
|
4394
|
+
"path": "v1beta/{+name}",
|
|
4395
|
+
"request": {
|
|
4396
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
4397
|
+
},
|
|
4398
|
+
"response": {
|
|
4399
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
4400
|
+
},
|
|
4401
|
+
"scopes": [
|
|
4402
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
4403
|
+
]
|
|
4404
|
+
}
|
|
4405
|
+
}
|
|
4406
|
+
},
|
|
3886
4407
|
"conversations": {
|
|
3887
4408
|
"methods": {
|
|
3888
4409
|
"converse": {
|
|
@@ -4236,7 +4757,7 @@
|
|
|
4236
4757
|
"type": "string"
|
|
4237
4758
|
},
|
|
4238
4759
|
"schemaId": {
|
|
4239
|
-
"description": "Required. The ID to use for the Schema, which
|
|
4760
|
+
"description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.",
|
|
4240
4761
|
"location": "query",
|
|
4241
4762
|
"type": "string"
|
|
4242
4763
|
}
|
|
@@ -4312,7 +4833,7 @@
|
|
|
4312
4833
|
],
|
|
4313
4834
|
"parameters": {
|
|
4314
4835
|
"pageSize": {
|
|
4315
|
-
"description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas
|
|
4836
|
+
"description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.",
|
|
4316
4837
|
"format": "int32",
|
|
4317
4838
|
"location": "query",
|
|
4318
4839
|
"type": "integer"
|
|
@@ -4348,7 +4869,7 @@
|
|
|
4348
4869
|
],
|
|
4349
4870
|
"parameters": {
|
|
4350
4871
|
"allowMissing": {
|
|
4351
|
-
"description": "If set to true, and the Schema is not found, a new Schema
|
|
4872
|
+
"description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.",
|
|
4352
4873
|
"location": "query",
|
|
4353
4874
|
"type": "boolean"
|
|
4354
4875
|
},
|
|
@@ -4508,7 +5029,7 @@
|
|
|
4508
5029
|
],
|
|
4509
5030
|
"parameters": {
|
|
4510
5031
|
"servingConfig": {
|
|
4511
|
-
"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
|
|
5032
|
+
"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.",
|
|
4512
5033
|
"location": "path",
|
|
4513
5034
|
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
4514
5035
|
"required": true,
|
|
@@ -5117,7 +5638,7 @@
|
|
|
5117
5638
|
]
|
|
5118
5639
|
},
|
|
5119
5640
|
"import": {
|
|
5120
|
-
"description": "Bulk import of
|
|
5641
|
+
"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.",
|
|
5121
5642
|
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import",
|
|
5122
5643
|
"httpMethod": "POST",
|
|
5123
5644
|
"id": "discoveryengine.projects.locations.dataStores.userEvents.import",
|
|
@@ -5159,6 +5680,11 @@
|
|
|
5159
5680
|
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
5160
5681
|
"required": true,
|
|
5161
5682
|
"type": "string"
|
|
5683
|
+
},
|
|
5684
|
+
"writeAsync": {
|
|
5685
|
+
"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.",
|
|
5686
|
+
"location": "query",
|
|
5687
|
+
"type": "boolean"
|
|
5162
5688
|
}
|
|
5163
5689
|
},
|
|
5164
5690
|
"path": "v1beta/{+parent}/userEvents:write",
|
|
@@ -5327,6 +5853,11 @@
|
|
|
5327
5853
|
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
5328
5854
|
"required": true,
|
|
5329
5855
|
"type": "string"
|
|
5856
|
+
},
|
|
5857
|
+
"writeAsync": {
|
|
5858
|
+
"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.",
|
|
5859
|
+
"location": "query",
|
|
5860
|
+
"type": "boolean"
|
|
5330
5861
|
}
|
|
5331
5862
|
},
|
|
5332
5863
|
"path": "v1beta/{+parent}/userEvents:write",
|
|
@@ -5417,7 +5948,7 @@
|
|
|
5417
5948
|
}
|
|
5418
5949
|
}
|
|
5419
5950
|
},
|
|
5420
|
-
"revision": "
|
|
5951
|
+
"revision": "20240526",
|
|
5421
5952
|
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
5422
5953
|
"schemas": {
|
|
5423
5954
|
"GoogleApiHttpBody": {
|
|
@@ -5537,60 +6068,254 @@
|
|
|
5537
6068
|
"description": "The operation resource name of the LRO.",
|
|
5538
6069
|
"type": "string"
|
|
5539
6070
|
},
|
|
5540
|
-
"userEvent": {
|
|
5541
|
-
"description": "The detailed content which caused the error on importing a user event.",
|
|
5542
|
-
"type": "string"
|
|
6071
|
+
"userEvent": {
|
|
6072
|
+
"description": "The detailed content which caused the error on importing a user event.",
|
|
6073
|
+
"type": "string"
|
|
6074
|
+
}
|
|
6075
|
+
},
|
|
6076
|
+
"type": "object"
|
|
6077
|
+
},
|
|
6078
|
+
"GoogleCloudDiscoveryengineLoggingServiceContext": {
|
|
6079
|
+
"description": "Describes a running service that sends errors.",
|
|
6080
|
+
"id": "GoogleCloudDiscoveryengineLoggingServiceContext",
|
|
6081
|
+
"properties": {
|
|
6082
|
+
"service": {
|
|
6083
|
+
"description": "An identifier of the service\u2014for example, `discoveryengine.googleapis.com`.",
|
|
6084
|
+
"type": "string"
|
|
6085
|
+
}
|
|
6086
|
+
},
|
|
6087
|
+
"type": "object"
|
|
6088
|
+
},
|
|
6089
|
+
"GoogleCloudDiscoveryengineLoggingSourceLocation": {
|
|
6090
|
+
"description": "Indicates a location in the source code of the service for which errors are reported.",
|
|
6091
|
+
"id": "GoogleCloudDiscoveryengineLoggingSourceLocation",
|
|
6092
|
+
"properties": {
|
|
6093
|
+
"functionName": {
|
|
6094
|
+
"description": "Human-readable name of a function or method\u2014for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.",
|
|
6095
|
+
"type": "string"
|
|
6096
|
+
}
|
|
6097
|
+
},
|
|
6098
|
+
"type": "object"
|
|
6099
|
+
},
|
|
6100
|
+
"GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": {
|
|
6101
|
+
"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
6102
|
+
"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata",
|
|
6103
|
+
"properties": {
|
|
6104
|
+
"createTime": {
|
|
6105
|
+
"description": "Operation create time.",
|
|
6106
|
+
"format": "google-datetime",
|
|
6107
|
+
"type": "string"
|
|
6108
|
+
},
|
|
6109
|
+
"updateTime": {
|
|
6110
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
6111
|
+
"format": "google-datetime",
|
|
6112
|
+
"type": "string"
|
|
6113
|
+
}
|
|
6114
|
+
},
|
|
6115
|
+
"type": "object"
|
|
6116
|
+
},
|
|
6117
|
+
"GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": {
|
|
6118
|
+
"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.",
|
|
6119
|
+
"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse",
|
|
6120
|
+
"properties": {
|
|
6121
|
+
"targetSites": {
|
|
6122
|
+
"description": "TargetSites created.",
|
|
6123
|
+
"items": {
|
|
6124
|
+
"$ref": "GoogleCloudDiscoveryengineV1TargetSite"
|
|
6125
|
+
},
|
|
6126
|
+
"type": "array"
|
|
6127
|
+
}
|
|
6128
|
+
},
|
|
6129
|
+
"type": "object"
|
|
6130
|
+
},
|
|
6131
|
+
"GoogleCloudDiscoveryengineV1Condition": {
|
|
6132
|
+
"description": "Defines circumstances to be checked before allowing a behavior",
|
|
6133
|
+
"id": "GoogleCloudDiscoveryengineV1Condition",
|
|
6134
|
+
"properties": {
|
|
6135
|
+
"activeTimeRange": {
|
|
6136
|
+
"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.",
|
|
6137
|
+
"items": {
|
|
6138
|
+
"$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange"
|
|
6139
|
+
},
|
|
6140
|
+
"type": "array"
|
|
6141
|
+
},
|
|
6142
|
+
"queryTerms": {
|
|
6143
|
+
"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.",
|
|
6144
|
+
"items": {
|
|
6145
|
+
"$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm"
|
|
6146
|
+
},
|
|
6147
|
+
"type": "array"
|
|
6148
|
+
}
|
|
6149
|
+
},
|
|
6150
|
+
"type": "object"
|
|
6151
|
+
},
|
|
6152
|
+
"GoogleCloudDiscoveryengineV1ConditionQueryTerm": {
|
|
6153
|
+
"description": "Matcher for search request query",
|
|
6154
|
+
"id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm",
|
|
6155
|
+
"properties": {
|
|
6156
|
+
"fullMatch": {
|
|
6157
|
+
"description": "Whether the search query needs to exactly match the query term.",
|
|
6158
|
+
"type": "boolean"
|
|
6159
|
+
},
|
|
6160
|
+
"value": {
|
|
6161
|
+
"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.",
|
|
6162
|
+
"type": "string"
|
|
6163
|
+
}
|
|
6164
|
+
},
|
|
6165
|
+
"type": "object"
|
|
6166
|
+
},
|
|
6167
|
+
"GoogleCloudDiscoveryengineV1ConditionTimeRange": {
|
|
6168
|
+
"description": "Used for time-dependent conditions.",
|
|
6169
|
+
"id": "GoogleCloudDiscoveryengineV1ConditionTimeRange",
|
|
6170
|
+
"properties": {
|
|
6171
|
+
"endTime": {
|
|
6172
|
+
"description": "End of time range. Range is inclusive. Must be in the future.",
|
|
6173
|
+
"format": "google-datetime",
|
|
6174
|
+
"type": "string"
|
|
6175
|
+
},
|
|
6176
|
+
"startTime": {
|
|
6177
|
+
"description": "Start of time range. Range is inclusive.",
|
|
6178
|
+
"format": "google-datetime",
|
|
6179
|
+
"type": "string"
|
|
6180
|
+
}
|
|
6181
|
+
},
|
|
6182
|
+
"type": "object"
|
|
6183
|
+
},
|
|
6184
|
+
"GoogleCloudDiscoveryengineV1Control": {
|
|
6185
|
+
"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.",
|
|
6186
|
+
"id": "GoogleCloudDiscoveryengineV1Control",
|
|
6187
|
+
"properties": {
|
|
6188
|
+
"associatedServingConfigIds": {
|
|
6189
|
+
"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.",
|
|
6190
|
+
"items": {
|
|
6191
|
+
"type": "string"
|
|
6192
|
+
},
|
|
6193
|
+
"readOnly": true,
|
|
6194
|
+
"type": "array"
|
|
6195
|
+
},
|
|
6196
|
+
"boostAction": {
|
|
6197
|
+
"$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction",
|
|
6198
|
+
"description": "Defines a boost-type control"
|
|
6199
|
+
},
|
|
6200
|
+
"conditions": {
|
|
6201
|
+
"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
6202
|
+
"items": {
|
|
6203
|
+
"$ref": "GoogleCloudDiscoveryengineV1Condition"
|
|
6204
|
+
},
|
|
6205
|
+
"type": "array"
|
|
6206
|
+
},
|
|
6207
|
+
"displayName": {
|
|
6208
|
+
"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
6209
|
+
"type": "string"
|
|
6210
|
+
},
|
|
6211
|
+
"filterAction": {
|
|
6212
|
+
"$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction",
|
|
6213
|
+
"description": "Defines a filter-type control Currently not supported by Recommendation"
|
|
6214
|
+
},
|
|
6215
|
+
"name": {
|
|
6216
|
+
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
6217
|
+
"type": "string"
|
|
6218
|
+
},
|
|
6219
|
+
"redirectAction": {
|
|
6220
|
+
"$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
|
|
6221
|
+
"description": "Defines a redirect-type control."
|
|
6222
|
+
},
|
|
6223
|
+
"solutionType": {
|
|
6224
|
+
"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
6225
|
+
"enum": [
|
|
6226
|
+
"SOLUTION_TYPE_UNSPECIFIED",
|
|
6227
|
+
"SOLUTION_TYPE_RECOMMENDATION",
|
|
6228
|
+
"SOLUTION_TYPE_SEARCH",
|
|
6229
|
+
"SOLUTION_TYPE_CHAT",
|
|
6230
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
6231
|
+
],
|
|
6232
|
+
"enumDescriptions": [
|
|
6233
|
+
"Default value.",
|
|
6234
|
+
"Used for Recommendations AI.",
|
|
6235
|
+
"Used for Discovery Search.",
|
|
6236
|
+
"Used for use cases related to the Generative AI agent.",
|
|
6237
|
+
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
|
|
6238
|
+
],
|
|
6239
|
+
"type": "string"
|
|
6240
|
+
},
|
|
6241
|
+
"synonymsAction": {
|
|
6242
|
+
"$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction",
|
|
6243
|
+
"description": "Treats a group of terms as synonyms of one another."
|
|
6244
|
+
},
|
|
6245
|
+
"useCases": {
|
|
6246
|
+
"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.",
|
|
6247
|
+
"items": {
|
|
6248
|
+
"enum": [
|
|
6249
|
+
"SEARCH_USE_CASE_UNSPECIFIED",
|
|
6250
|
+
"SEARCH_USE_CASE_SEARCH",
|
|
6251
|
+
"SEARCH_USE_CASE_BROWSE"
|
|
6252
|
+
],
|
|
6253
|
+
"enumDescriptions": [
|
|
6254
|
+
"Value used when unset. Will not occur in CSS.",
|
|
6255
|
+
"Search use case. Expects the traffic has a non-empty query.",
|
|
6256
|
+
"Browse use case. Expects the traffic has an empty query."
|
|
6257
|
+
],
|
|
6258
|
+
"type": "string"
|
|
6259
|
+
},
|
|
6260
|
+
"type": "array"
|
|
5543
6261
|
}
|
|
5544
6262
|
},
|
|
5545
6263
|
"type": "object"
|
|
5546
6264
|
},
|
|
5547
|
-
"
|
|
5548
|
-
"description": "
|
|
5549
|
-
"id": "
|
|
6265
|
+
"GoogleCloudDiscoveryengineV1ControlBoostAction": {
|
|
6266
|
+
"description": "Adjusts order of products in returned list.",
|
|
6267
|
+
"id": "GoogleCloudDiscoveryengineV1ControlBoostAction",
|
|
5550
6268
|
"properties": {
|
|
5551
|
-
"
|
|
5552
|
-
"description": "
|
|
6269
|
+
"boost": {
|
|
6270
|
+
"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
|
|
6271
|
+
"format": "float",
|
|
6272
|
+
"type": "number"
|
|
6273
|
+
},
|
|
6274
|
+
"dataStore": {
|
|
6275
|
+
"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store",
|
|
6276
|
+
"type": "string"
|
|
6277
|
+
},
|
|
6278
|
+
"filter": {
|
|
6279
|
+
"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
5553
6280
|
"type": "string"
|
|
5554
6281
|
}
|
|
5555
6282
|
},
|
|
5556
6283
|
"type": "object"
|
|
5557
6284
|
},
|
|
5558
|
-
"
|
|
5559
|
-
"description": "
|
|
5560
|
-
"id": "
|
|
6285
|
+
"GoogleCloudDiscoveryengineV1ControlFilterAction": {
|
|
6286
|
+
"description": "Specified which products may be included in results. Uses same filter as boost.",
|
|
6287
|
+
"id": "GoogleCloudDiscoveryengineV1ControlFilterAction",
|
|
5561
6288
|
"properties": {
|
|
5562
|
-
"
|
|
5563
|
-
"description": "
|
|
6289
|
+
"dataStore": {
|
|
6290
|
+
"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store",
|
|
6291
|
+
"type": "string"
|
|
6292
|
+
},
|
|
6293
|
+
"filter": {
|
|
6294
|
+
"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
5564
6295
|
"type": "string"
|
|
5565
6296
|
}
|
|
5566
6297
|
},
|
|
5567
6298
|
"type": "object"
|
|
5568
6299
|
},
|
|
5569
|
-
"
|
|
5570
|
-
"description": "
|
|
5571
|
-
"id": "
|
|
6300
|
+
"GoogleCloudDiscoveryengineV1ControlRedirectAction": {
|
|
6301
|
+
"description": "Redirects a shopper to the provided URI.",
|
|
6302
|
+
"id": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
|
|
5572
6303
|
"properties": {
|
|
5573
|
-
"
|
|
5574
|
-
"description": "
|
|
5575
|
-
"format": "google-datetime",
|
|
5576
|
-
"type": "string"
|
|
5577
|
-
},
|
|
5578
|
-
"updateTime": {
|
|
5579
|
-
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
5580
|
-
"format": "google-datetime",
|
|
6304
|
+
"redirectUri": {
|
|
6305
|
+
"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
5581
6306
|
"type": "string"
|
|
5582
6307
|
}
|
|
5583
6308
|
},
|
|
5584
6309
|
"type": "object"
|
|
5585
6310
|
},
|
|
5586
|
-
"
|
|
5587
|
-
"description": "
|
|
5588
|
-
"id": "
|
|
6311
|
+
"GoogleCloudDiscoveryengineV1ControlSynonymsAction": {
|
|
6312
|
+
"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".",
|
|
6313
|
+
"id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction",
|
|
5589
6314
|
"properties": {
|
|
5590
|
-
"
|
|
5591
|
-
"description": "
|
|
6315
|
+
"synonyms": {
|
|
6316
|
+
"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
5592
6317
|
"items": {
|
|
5593
|
-
"
|
|
6318
|
+
"type": "string"
|
|
5594
6319
|
},
|
|
5595
6320
|
"type": "array"
|
|
5596
6321
|
}
|
|
@@ -5963,7 +6688,7 @@
|
|
|
5963
6688
|
"type": "string"
|
|
5964
6689
|
},
|
|
5965
6690
|
"industryVertical": {
|
|
5966
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore
|
|
6691
|
+
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.",
|
|
5967
6692
|
"enum": [
|
|
5968
6693
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
5969
6694
|
"GENERIC",
|
|
@@ -6067,7 +6792,7 @@
|
|
|
6067
6792
|
"id": "GoogleCloudDiscoveryengineV1EngineCommonConfig",
|
|
6068
6793
|
"properties": {
|
|
6069
6794
|
"companyName": {
|
|
6070
|
-
"description": "
|
|
6795
|
+
"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.",
|
|
6071
6796
|
"type": "string"
|
|
6072
6797
|
}
|
|
6073
6798
|
},
|
|
@@ -6266,6 +6991,85 @@
|
|
|
6266
6991
|
},
|
|
6267
6992
|
"type": "object"
|
|
6268
6993
|
},
|
|
6994
|
+
"GoogleCloudDiscoveryengineV1Project": {
|
|
6995
|
+
"description": "Metadata and configurations for a Google Cloud project in the service.",
|
|
6996
|
+
"id": "GoogleCloudDiscoveryengineV1Project",
|
|
6997
|
+
"properties": {
|
|
6998
|
+
"createTime": {
|
|
6999
|
+
"description": "Output only. The timestamp when this project is created.",
|
|
7000
|
+
"format": "google-datetime",
|
|
7001
|
+
"readOnly": true,
|
|
7002
|
+
"type": "string"
|
|
7003
|
+
},
|
|
7004
|
+
"name": {
|
|
7005
|
+
"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
|
|
7006
|
+
"readOnly": true,
|
|
7007
|
+
"type": "string"
|
|
7008
|
+
},
|
|
7009
|
+
"provisionCompletionTime": {
|
|
7010
|
+
"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.",
|
|
7011
|
+
"format": "google-datetime",
|
|
7012
|
+
"readOnly": true,
|
|
7013
|
+
"type": "string"
|
|
7014
|
+
},
|
|
7015
|
+
"serviceTermsMap": {
|
|
7016
|
+
"additionalProperties": {
|
|
7017
|
+
"$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms"
|
|
7018
|
+
},
|
|
7019
|
+
"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.",
|
|
7020
|
+
"readOnly": true,
|
|
7021
|
+
"type": "object"
|
|
7022
|
+
}
|
|
7023
|
+
},
|
|
7024
|
+
"type": "object"
|
|
7025
|
+
},
|
|
7026
|
+
"GoogleCloudDiscoveryengineV1ProjectServiceTerms": {
|
|
7027
|
+
"description": "Metadata about the terms of service.",
|
|
7028
|
+
"id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms",
|
|
7029
|
+
"properties": {
|
|
7030
|
+
"acceptTime": {
|
|
7031
|
+
"description": "The last time when the project agreed to the terms of service.",
|
|
7032
|
+
"format": "google-datetime",
|
|
7033
|
+
"type": "string"
|
|
7034
|
+
},
|
|
7035
|
+
"declineTime": {
|
|
7036
|
+
"description": "The last time when the project declined or revoked the agreement to terms of service.",
|
|
7037
|
+
"format": "google-datetime",
|
|
7038
|
+
"type": "string"
|
|
7039
|
+
},
|
|
7040
|
+
"id": {
|
|
7041
|
+
"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.",
|
|
7042
|
+
"type": "string"
|
|
7043
|
+
},
|
|
7044
|
+
"state": {
|
|
7045
|
+
"description": "Whether the project has accepted/rejected the service terms or it is still pending.",
|
|
7046
|
+
"enum": [
|
|
7047
|
+
"STATE_UNSPECIFIED",
|
|
7048
|
+
"TERMS_ACCEPTED",
|
|
7049
|
+
"TERMS_PENDING",
|
|
7050
|
+
"TERMS_DECLINED"
|
|
7051
|
+
],
|
|
7052
|
+
"enumDescriptions": [
|
|
7053
|
+
"The default value of the enum. This value is not actually used.",
|
|
7054
|
+
"The project has given consent to the terms of service.",
|
|
7055
|
+
"The project is pending to review and accept the terms of service.",
|
|
7056
|
+
"The project has declined or revoked the agreement to terms of service."
|
|
7057
|
+
],
|
|
7058
|
+
"type": "string"
|
|
7059
|
+
},
|
|
7060
|
+
"version": {
|
|
7061
|
+
"description": "The version string of the terms of service. For acceptable values, see the comments for id above.",
|
|
7062
|
+
"type": "string"
|
|
7063
|
+
}
|
|
7064
|
+
},
|
|
7065
|
+
"type": "object"
|
|
7066
|
+
},
|
|
7067
|
+
"GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": {
|
|
7068
|
+
"description": "Metadata associated with a project provision operation.",
|
|
7069
|
+
"id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata",
|
|
7070
|
+
"properties": {},
|
|
7071
|
+
"type": "object"
|
|
7072
|
+
},
|
|
6269
7073
|
"GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": {
|
|
6270
7074
|
"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
6271
7075
|
"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata",
|
|
@@ -6776,6 +7580,14 @@
|
|
|
6776
7580
|
"description": "Page identifier.",
|
|
6777
7581
|
"type": "string"
|
|
6778
7582
|
},
|
|
7583
|
+
"structData": {
|
|
7584
|
+
"additionalProperties": {
|
|
7585
|
+
"description": "Properties of the object.",
|
|
7586
|
+
"type": "any"
|
|
7587
|
+
},
|
|
7588
|
+
"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.",
|
|
7589
|
+
"type": "object"
|
|
7590
|
+
},
|
|
6779
7591
|
"title": {
|
|
6780
7592
|
"description": "Title.",
|
|
6781
7593
|
"type": "string"
|
|
@@ -6802,6 +7614,14 @@
|
|
|
6802
7614
|
"description": "Document resource name.",
|
|
6803
7615
|
"type": "string"
|
|
6804
7616
|
},
|
|
7617
|
+
"structData": {
|
|
7618
|
+
"additionalProperties": {
|
|
7619
|
+
"description": "Properties of the object.",
|
|
7620
|
+
"type": "any"
|
|
7621
|
+
},
|
|
7622
|
+
"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.",
|
|
7623
|
+
"type": "object"
|
|
7624
|
+
},
|
|
6805
7625
|
"title": {
|
|
6806
7626
|
"description": "Title.",
|
|
6807
7627
|
"type": "string"
|
|
@@ -7004,6 +7824,200 @@
|
|
|
7004
7824
|
},
|
|
7005
7825
|
"type": "object"
|
|
7006
7826
|
},
|
|
7827
|
+
"GoogleCloudDiscoveryengineV1alphaCondition": {
|
|
7828
|
+
"description": "Defines circumstances to be checked before allowing a behavior",
|
|
7829
|
+
"id": "GoogleCloudDiscoveryengineV1alphaCondition",
|
|
7830
|
+
"properties": {
|
|
7831
|
+
"activeTimeRange": {
|
|
7832
|
+
"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.",
|
|
7833
|
+
"items": {
|
|
7834
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange"
|
|
7835
|
+
},
|
|
7836
|
+
"type": "array"
|
|
7837
|
+
},
|
|
7838
|
+
"queryTerms": {
|
|
7839
|
+
"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.",
|
|
7840
|
+
"items": {
|
|
7841
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm"
|
|
7842
|
+
},
|
|
7843
|
+
"type": "array"
|
|
7844
|
+
}
|
|
7845
|
+
},
|
|
7846
|
+
"type": "object"
|
|
7847
|
+
},
|
|
7848
|
+
"GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": {
|
|
7849
|
+
"description": "Matcher for search request query",
|
|
7850
|
+
"id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm",
|
|
7851
|
+
"properties": {
|
|
7852
|
+
"fullMatch": {
|
|
7853
|
+
"description": "Whether the search query needs to exactly match the query term.",
|
|
7854
|
+
"type": "boolean"
|
|
7855
|
+
},
|
|
7856
|
+
"value": {
|
|
7857
|
+
"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.",
|
|
7858
|
+
"type": "string"
|
|
7859
|
+
}
|
|
7860
|
+
},
|
|
7861
|
+
"type": "object"
|
|
7862
|
+
},
|
|
7863
|
+
"GoogleCloudDiscoveryengineV1alphaConditionTimeRange": {
|
|
7864
|
+
"description": "Used for time-dependent conditions.",
|
|
7865
|
+
"id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange",
|
|
7866
|
+
"properties": {
|
|
7867
|
+
"endTime": {
|
|
7868
|
+
"description": "End of time range. Range is inclusive. Must be in the future.",
|
|
7869
|
+
"format": "google-datetime",
|
|
7870
|
+
"type": "string"
|
|
7871
|
+
},
|
|
7872
|
+
"startTime": {
|
|
7873
|
+
"description": "Start of time range. Range is inclusive.",
|
|
7874
|
+
"format": "google-datetime",
|
|
7875
|
+
"type": "string"
|
|
7876
|
+
}
|
|
7877
|
+
},
|
|
7878
|
+
"type": "object"
|
|
7879
|
+
},
|
|
7880
|
+
"GoogleCloudDiscoveryengineV1alphaControl": {
|
|
7881
|
+
"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.",
|
|
7882
|
+
"id": "GoogleCloudDiscoveryengineV1alphaControl",
|
|
7883
|
+
"properties": {
|
|
7884
|
+
"associatedServingConfigIds": {
|
|
7885
|
+
"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.",
|
|
7886
|
+
"items": {
|
|
7887
|
+
"type": "string"
|
|
7888
|
+
},
|
|
7889
|
+
"readOnly": true,
|
|
7890
|
+
"type": "array"
|
|
7891
|
+
},
|
|
7892
|
+
"boostAction": {
|
|
7893
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction",
|
|
7894
|
+
"description": "Defines a boost-type control"
|
|
7895
|
+
},
|
|
7896
|
+
"conditions": {
|
|
7897
|
+
"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
7898
|
+
"items": {
|
|
7899
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCondition"
|
|
7900
|
+
},
|
|
7901
|
+
"type": "array"
|
|
7902
|
+
},
|
|
7903
|
+
"displayName": {
|
|
7904
|
+
"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
7905
|
+
"type": "string"
|
|
7906
|
+
},
|
|
7907
|
+
"filterAction": {
|
|
7908
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction",
|
|
7909
|
+
"description": "Defines a filter-type control Currently not supported by Recommendation"
|
|
7910
|
+
},
|
|
7911
|
+
"name": {
|
|
7912
|
+
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
7913
|
+
"type": "string"
|
|
7914
|
+
},
|
|
7915
|
+
"redirectAction": {
|
|
7916
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
|
|
7917
|
+
"description": "Defines a redirect-type control."
|
|
7918
|
+
},
|
|
7919
|
+
"solutionType": {
|
|
7920
|
+
"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
7921
|
+
"enum": [
|
|
7922
|
+
"SOLUTION_TYPE_UNSPECIFIED",
|
|
7923
|
+
"SOLUTION_TYPE_RECOMMENDATION",
|
|
7924
|
+
"SOLUTION_TYPE_SEARCH",
|
|
7925
|
+
"SOLUTION_TYPE_CHAT",
|
|
7926
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
7927
|
+
],
|
|
7928
|
+
"enumDescriptions": [
|
|
7929
|
+
"Default value.",
|
|
7930
|
+
"Used for Recommendations AI.",
|
|
7931
|
+
"Used for Discovery Search.",
|
|
7932
|
+
"Used for use cases related to the Generative AI agent.",
|
|
7933
|
+
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
|
|
7934
|
+
],
|
|
7935
|
+
"type": "string"
|
|
7936
|
+
},
|
|
7937
|
+
"synonymsAction": {
|
|
7938
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction",
|
|
7939
|
+
"description": "Treats a group of terms as synonyms of one another."
|
|
7940
|
+
},
|
|
7941
|
+
"useCases": {
|
|
7942
|
+
"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.",
|
|
7943
|
+
"items": {
|
|
7944
|
+
"enum": [
|
|
7945
|
+
"SEARCH_USE_CASE_UNSPECIFIED",
|
|
7946
|
+
"SEARCH_USE_CASE_SEARCH",
|
|
7947
|
+
"SEARCH_USE_CASE_BROWSE"
|
|
7948
|
+
],
|
|
7949
|
+
"enumDescriptions": [
|
|
7950
|
+
"Value used when unset. Will not occur in CSS.",
|
|
7951
|
+
"Search use case. Expects the traffic has a non-empty query.",
|
|
7952
|
+
"Browse use case. Expects the traffic has an empty query."
|
|
7953
|
+
],
|
|
7954
|
+
"type": "string"
|
|
7955
|
+
},
|
|
7956
|
+
"type": "array"
|
|
7957
|
+
}
|
|
7958
|
+
},
|
|
7959
|
+
"type": "object"
|
|
7960
|
+
},
|
|
7961
|
+
"GoogleCloudDiscoveryengineV1alphaControlBoostAction": {
|
|
7962
|
+
"description": "Adjusts order of products in returned list.",
|
|
7963
|
+
"id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction",
|
|
7964
|
+
"properties": {
|
|
7965
|
+
"boost": {
|
|
7966
|
+
"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
|
|
7967
|
+
"format": "float",
|
|
7968
|
+
"type": "number"
|
|
7969
|
+
},
|
|
7970
|
+
"dataStore": {
|
|
7971
|
+
"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store",
|
|
7972
|
+
"type": "string"
|
|
7973
|
+
},
|
|
7974
|
+
"filter": {
|
|
7975
|
+
"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
7976
|
+
"type": "string"
|
|
7977
|
+
}
|
|
7978
|
+
},
|
|
7979
|
+
"type": "object"
|
|
7980
|
+
},
|
|
7981
|
+
"GoogleCloudDiscoveryengineV1alphaControlFilterAction": {
|
|
7982
|
+
"description": "Specified which products may be included in results. Uses same filter as boost.",
|
|
7983
|
+
"id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction",
|
|
7984
|
+
"properties": {
|
|
7985
|
+
"dataStore": {
|
|
7986
|
+
"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store",
|
|
7987
|
+
"type": "string"
|
|
7988
|
+
},
|
|
7989
|
+
"filter": {
|
|
7990
|
+
"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
7991
|
+
"type": "string"
|
|
7992
|
+
}
|
|
7993
|
+
},
|
|
7994
|
+
"type": "object"
|
|
7995
|
+
},
|
|
7996
|
+
"GoogleCloudDiscoveryengineV1alphaControlRedirectAction": {
|
|
7997
|
+
"description": "Redirects a shopper to the provided URI.",
|
|
7998
|
+
"id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
|
|
7999
|
+
"properties": {
|
|
8000
|
+
"redirectUri": {
|
|
8001
|
+
"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
8002
|
+
"type": "string"
|
|
8003
|
+
}
|
|
8004
|
+
},
|
|
8005
|
+
"type": "object"
|
|
8006
|
+
},
|
|
8007
|
+
"GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": {
|
|
8008
|
+
"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".",
|
|
8009
|
+
"id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction",
|
|
8010
|
+
"properties": {
|
|
8011
|
+
"synonyms": {
|
|
8012
|
+
"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
8013
|
+
"items": {
|
|
8014
|
+
"type": "string"
|
|
8015
|
+
},
|
|
8016
|
+
"type": "array"
|
|
8017
|
+
}
|
|
8018
|
+
},
|
|
8019
|
+
"type": "object"
|
|
8020
|
+
},
|
|
7007
8021
|
"GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": {
|
|
7008
8022
|
"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
7009
8023
|
"id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata",
|
|
@@ -7096,7 +8110,7 @@
|
|
|
7096
8110
|
"TRAINING_FAILED"
|
|
7097
8111
|
],
|
|
7098
8112
|
"enumDescriptions": [
|
|
7099
|
-
"",
|
|
8113
|
+
"Default value.",
|
|
7100
8114
|
"The model is in a paused training state.",
|
|
7101
8115
|
"The model is currently training.",
|
|
7102
8116
|
"The model has successfully completed training.",
|
|
@@ -7106,6 +8120,7 @@
|
|
|
7106
8120
|
"type": "string"
|
|
7107
8121
|
},
|
|
7108
8122
|
"modelVersion": {
|
|
8123
|
+
"description": "The version of the model.",
|
|
7109
8124
|
"format": "int64",
|
|
7110
8125
|
"type": "string"
|
|
7111
8126
|
},
|
|
@@ -7469,7 +8484,7 @@
|
|
|
7469
8484
|
"type": "string"
|
|
7470
8485
|
},
|
|
7471
8486
|
"industryVertical": {
|
|
7472
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore
|
|
8487
|
+
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.",
|
|
7473
8488
|
"enum": [
|
|
7474
8489
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
7475
8490
|
"GENERIC",
|
|
@@ -7586,7 +8601,7 @@
|
|
|
7586
8601
|
"id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig",
|
|
7587
8602
|
"properties": {
|
|
7588
8603
|
"companyName": {
|
|
7589
|
-
"description": "
|
|
8604
|
+
"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.",
|
|
7590
8605
|
"type": "string"
|
|
7591
8606
|
}
|
|
7592
8607
|
},
|
|
@@ -7772,12 +8787,14 @@
|
|
|
7772
8787
|
"enum": [
|
|
7773
8788
|
"ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED",
|
|
7774
8789
|
"METATAGS",
|
|
7775
|
-
"PAGEMAP"
|
|
8790
|
+
"PAGEMAP",
|
|
8791
|
+
"SCHEMA_ORG"
|
|
7776
8792
|
],
|
|
7777
8793
|
"enumDescriptions": [
|
|
7778
8794
|
"Value used when unset.",
|
|
7779
8795
|
"Retrieve value from meta tag.",
|
|
7780
|
-
"Retrieve value from page map."
|
|
8796
|
+
"Retrieve value from page map.",
|
|
8797
|
+
"Retrieve value from schema.org data."
|
|
7781
8798
|
],
|
|
7782
8799
|
"type": "string"
|
|
7783
8800
|
},
|
|
@@ -7887,6 +8904,13 @@
|
|
|
7887
8904
|
],
|
|
7888
8905
|
"type": "string"
|
|
7889
8906
|
},
|
|
8907
|
+
"schemaOrgPaths": {
|
|
8908
|
+
"description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished",
|
|
8909
|
+
"items": {
|
|
8910
|
+
"type": "string"
|
|
8911
|
+
},
|
|
8912
|
+
"type": "array"
|
|
8913
|
+
},
|
|
7890
8914
|
"searchableOption": {
|
|
7891
8915
|
"description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.",
|
|
7892
8916
|
"enum": [
|
|
@@ -8521,7 +9545,7 @@
|
|
|
8521
9545
|
"id": "GoogleCloudDiscoveryengineV1alphaSessionTurn",
|
|
8522
9546
|
"properties": {
|
|
8523
9547
|
"answer": {
|
|
8524
|
-
"description": "The resource name of the answer to the user query.",
|
|
9548
|
+
"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
|
|
8525
9549
|
"type": "string"
|
|
8526
9550
|
},
|
|
8527
9551
|
"query": {
|
|
@@ -8927,7 +9951,7 @@
|
|
|
8927
9951
|
"description": "Search specification."
|
|
8928
9952
|
},
|
|
8929
9953
|
"session": {
|
|
8930
|
-
"description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol
|
|
9954
|
+
"description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.",
|
|
8931
9955
|
"type": "string"
|
|
8932
9956
|
},
|
|
8933
9957
|
"userPseudoId": {
|
|
@@ -8949,6 +9973,10 @@
|
|
|
8949
9973
|
"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.",
|
|
8950
9974
|
"type": "boolean"
|
|
8951
9975
|
},
|
|
9976
|
+
"ignoreLowRelevantContent": {
|
|
9977
|
+
"description": "Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service.",
|
|
9978
|
+
"type": "boolean"
|
|
9979
|
+
},
|
|
8952
9980
|
"ignoreNonAnswerSeekingQuery": {
|
|
8953
9981
|
"description": "Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.",
|
|
8954
9982
|
"type": "boolean"
|
|
@@ -9090,6 +10118,13 @@
|
|
|
9090
10118
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
|
|
9091
10119
|
"description": "Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)"
|
|
9092
10120
|
},
|
|
10121
|
+
"dataStoreSpecs": {
|
|
10122
|
+
"description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.",
|
|
10123
|
+
"items": {
|
|
10124
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
|
|
10125
|
+
},
|
|
10126
|
+
"type": "array"
|
|
10127
|
+
},
|
|
9093
10128
|
"filter": {
|
|
9094
10129
|
"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
|
|
9095
10130
|
"type": "string"
|
|
@@ -9344,6 +10379,14 @@
|
|
|
9344
10379
|
"description": "Page identifier.",
|
|
9345
10380
|
"type": "string"
|
|
9346
10381
|
},
|
|
10382
|
+
"structData": {
|
|
10383
|
+
"additionalProperties": {
|
|
10384
|
+
"description": "Properties of the object.",
|
|
10385
|
+
"type": "any"
|
|
10386
|
+
},
|
|
10387
|
+
"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.",
|
|
10388
|
+
"type": "object"
|
|
10389
|
+
},
|
|
9347
10390
|
"title": {
|
|
9348
10391
|
"description": "Title.",
|
|
9349
10392
|
"type": "string"
|
|
@@ -9370,6 +10413,14 @@
|
|
|
9370
10413
|
"description": "Document resource name.",
|
|
9371
10414
|
"type": "string"
|
|
9372
10415
|
},
|
|
10416
|
+
"structData": {
|
|
10417
|
+
"additionalProperties": {
|
|
10418
|
+
"description": "Properties of the object.",
|
|
10419
|
+
"type": "any"
|
|
10420
|
+
},
|
|
10421
|
+
"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.",
|
|
10422
|
+
"type": "object"
|
|
10423
|
+
},
|
|
9373
10424
|
"title": {
|
|
9374
10425
|
"description": "Title.",
|
|
9375
10426
|
"type": "string"
|
|
@@ -9957,6 +11008,200 @@
|
|
|
9957
11008
|
},
|
|
9958
11009
|
"type": "object"
|
|
9959
11010
|
},
|
|
11011
|
+
"GoogleCloudDiscoveryengineV1betaCondition": {
|
|
11012
|
+
"description": "Defines circumstances to be checked before allowing a behavior",
|
|
11013
|
+
"id": "GoogleCloudDiscoveryengineV1betaCondition",
|
|
11014
|
+
"properties": {
|
|
11015
|
+
"activeTimeRange": {
|
|
11016
|
+
"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.",
|
|
11017
|
+
"items": {
|
|
11018
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange"
|
|
11019
|
+
},
|
|
11020
|
+
"type": "array"
|
|
11021
|
+
},
|
|
11022
|
+
"queryTerms": {
|
|
11023
|
+
"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.",
|
|
11024
|
+
"items": {
|
|
11025
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm"
|
|
11026
|
+
},
|
|
11027
|
+
"type": "array"
|
|
11028
|
+
}
|
|
11029
|
+
},
|
|
11030
|
+
"type": "object"
|
|
11031
|
+
},
|
|
11032
|
+
"GoogleCloudDiscoveryengineV1betaConditionQueryTerm": {
|
|
11033
|
+
"description": "Matcher for search request query",
|
|
11034
|
+
"id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm",
|
|
11035
|
+
"properties": {
|
|
11036
|
+
"fullMatch": {
|
|
11037
|
+
"description": "Whether the search query needs to exactly match the query term.",
|
|
11038
|
+
"type": "boolean"
|
|
11039
|
+
},
|
|
11040
|
+
"value": {
|
|
11041
|
+
"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.",
|
|
11042
|
+
"type": "string"
|
|
11043
|
+
}
|
|
11044
|
+
},
|
|
11045
|
+
"type": "object"
|
|
11046
|
+
},
|
|
11047
|
+
"GoogleCloudDiscoveryengineV1betaConditionTimeRange": {
|
|
11048
|
+
"description": "Used for time-dependent conditions.",
|
|
11049
|
+
"id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange",
|
|
11050
|
+
"properties": {
|
|
11051
|
+
"endTime": {
|
|
11052
|
+
"description": "End of time range. Range is inclusive. Must be in the future.",
|
|
11053
|
+
"format": "google-datetime",
|
|
11054
|
+
"type": "string"
|
|
11055
|
+
},
|
|
11056
|
+
"startTime": {
|
|
11057
|
+
"description": "Start of time range. Range is inclusive.",
|
|
11058
|
+
"format": "google-datetime",
|
|
11059
|
+
"type": "string"
|
|
11060
|
+
}
|
|
11061
|
+
},
|
|
11062
|
+
"type": "object"
|
|
11063
|
+
},
|
|
11064
|
+
"GoogleCloudDiscoveryengineV1betaControl": {
|
|
11065
|
+
"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.",
|
|
11066
|
+
"id": "GoogleCloudDiscoveryengineV1betaControl",
|
|
11067
|
+
"properties": {
|
|
11068
|
+
"associatedServingConfigIds": {
|
|
11069
|
+
"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.",
|
|
11070
|
+
"items": {
|
|
11071
|
+
"type": "string"
|
|
11072
|
+
},
|
|
11073
|
+
"readOnly": true,
|
|
11074
|
+
"type": "array"
|
|
11075
|
+
},
|
|
11076
|
+
"boostAction": {
|
|
11077
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction",
|
|
11078
|
+
"description": "Defines a boost-type control"
|
|
11079
|
+
},
|
|
11080
|
+
"conditions": {
|
|
11081
|
+
"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
11082
|
+
"items": {
|
|
11083
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCondition"
|
|
11084
|
+
},
|
|
11085
|
+
"type": "array"
|
|
11086
|
+
},
|
|
11087
|
+
"displayName": {
|
|
11088
|
+
"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
11089
|
+
"type": "string"
|
|
11090
|
+
},
|
|
11091
|
+
"filterAction": {
|
|
11092
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction",
|
|
11093
|
+
"description": "Defines a filter-type control Currently not supported by Recommendation"
|
|
11094
|
+
},
|
|
11095
|
+
"name": {
|
|
11096
|
+
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
11097
|
+
"type": "string"
|
|
11098
|
+
},
|
|
11099
|
+
"redirectAction": {
|
|
11100
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
|
|
11101
|
+
"description": "Defines a redirect-type control."
|
|
11102
|
+
},
|
|
11103
|
+
"solutionType": {
|
|
11104
|
+
"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
11105
|
+
"enum": [
|
|
11106
|
+
"SOLUTION_TYPE_UNSPECIFIED",
|
|
11107
|
+
"SOLUTION_TYPE_RECOMMENDATION",
|
|
11108
|
+
"SOLUTION_TYPE_SEARCH",
|
|
11109
|
+
"SOLUTION_TYPE_CHAT",
|
|
11110
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
11111
|
+
],
|
|
11112
|
+
"enumDescriptions": [
|
|
11113
|
+
"Default value.",
|
|
11114
|
+
"Used for Recommendations AI.",
|
|
11115
|
+
"Used for Discovery Search.",
|
|
11116
|
+
"Used for use cases related to the Generative AI agent.",
|
|
11117
|
+
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
|
|
11118
|
+
],
|
|
11119
|
+
"type": "string"
|
|
11120
|
+
},
|
|
11121
|
+
"synonymsAction": {
|
|
11122
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction",
|
|
11123
|
+
"description": "Treats a group of terms as synonyms of one another."
|
|
11124
|
+
},
|
|
11125
|
+
"useCases": {
|
|
11126
|
+
"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.",
|
|
11127
|
+
"items": {
|
|
11128
|
+
"enum": [
|
|
11129
|
+
"SEARCH_USE_CASE_UNSPECIFIED",
|
|
11130
|
+
"SEARCH_USE_CASE_SEARCH",
|
|
11131
|
+
"SEARCH_USE_CASE_BROWSE"
|
|
11132
|
+
],
|
|
11133
|
+
"enumDescriptions": [
|
|
11134
|
+
"Value used when unset. Will not occur in CSS.",
|
|
11135
|
+
"Search use case. Expects the traffic has a non-empty query.",
|
|
11136
|
+
"Browse use case. Expects the traffic has an empty query."
|
|
11137
|
+
],
|
|
11138
|
+
"type": "string"
|
|
11139
|
+
},
|
|
11140
|
+
"type": "array"
|
|
11141
|
+
}
|
|
11142
|
+
},
|
|
11143
|
+
"type": "object"
|
|
11144
|
+
},
|
|
11145
|
+
"GoogleCloudDiscoveryengineV1betaControlBoostAction": {
|
|
11146
|
+
"description": "Adjusts order of products in returned list.",
|
|
11147
|
+
"id": "GoogleCloudDiscoveryengineV1betaControlBoostAction",
|
|
11148
|
+
"properties": {
|
|
11149
|
+
"boost": {
|
|
11150
|
+
"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
|
|
11151
|
+
"format": "float",
|
|
11152
|
+
"type": "number"
|
|
11153
|
+
},
|
|
11154
|
+
"dataStore": {
|
|
11155
|
+
"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store",
|
|
11156
|
+
"type": "string"
|
|
11157
|
+
},
|
|
11158
|
+
"filter": {
|
|
11159
|
+
"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
11160
|
+
"type": "string"
|
|
11161
|
+
}
|
|
11162
|
+
},
|
|
11163
|
+
"type": "object"
|
|
11164
|
+
},
|
|
11165
|
+
"GoogleCloudDiscoveryengineV1betaControlFilterAction": {
|
|
11166
|
+
"description": "Specified which products may be included in results. Uses same filter as boost.",
|
|
11167
|
+
"id": "GoogleCloudDiscoveryengineV1betaControlFilterAction",
|
|
11168
|
+
"properties": {
|
|
11169
|
+
"dataStore": {
|
|
11170
|
+
"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store",
|
|
11171
|
+
"type": "string"
|
|
11172
|
+
},
|
|
11173
|
+
"filter": {
|
|
11174
|
+
"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
11175
|
+
"type": "string"
|
|
11176
|
+
}
|
|
11177
|
+
},
|
|
11178
|
+
"type": "object"
|
|
11179
|
+
},
|
|
11180
|
+
"GoogleCloudDiscoveryengineV1betaControlRedirectAction": {
|
|
11181
|
+
"description": "Redirects a shopper to the provided URI.",
|
|
11182
|
+
"id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
|
|
11183
|
+
"properties": {
|
|
11184
|
+
"redirectUri": {
|
|
11185
|
+
"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
11186
|
+
"type": "string"
|
|
11187
|
+
}
|
|
11188
|
+
},
|
|
11189
|
+
"type": "object"
|
|
11190
|
+
},
|
|
11191
|
+
"GoogleCloudDiscoveryengineV1betaControlSynonymsAction": {
|
|
11192
|
+
"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".",
|
|
11193
|
+
"id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction",
|
|
11194
|
+
"properties": {
|
|
11195
|
+
"synonyms": {
|
|
11196
|
+
"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.",
|
|
11197
|
+
"items": {
|
|
11198
|
+
"type": "string"
|
|
11199
|
+
},
|
|
11200
|
+
"type": "array"
|
|
11201
|
+
}
|
|
11202
|
+
},
|
|
11203
|
+
"type": "object"
|
|
11204
|
+
},
|
|
9960
11205
|
"GoogleCloudDiscoveryengineV1betaConversation": {
|
|
9961
11206
|
"description": "External conversation proto definition.",
|
|
9962
11207
|
"id": "GoogleCloudDiscoveryengineV1betaConversation",
|
|
@@ -10244,7 +11489,7 @@
|
|
|
10244
11489
|
"TRAINING_FAILED"
|
|
10245
11490
|
],
|
|
10246
11491
|
"enumDescriptions": [
|
|
10247
|
-
"",
|
|
11492
|
+
"Default value.",
|
|
10248
11493
|
"The model is in a paused training state.",
|
|
10249
11494
|
"The model is currently training.",
|
|
10250
11495
|
"The model has successfully completed training.",
|
|
@@ -10254,6 +11499,7 @@
|
|
|
10254
11499
|
"type": "string"
|
|
10255
11500
|
},
|
|
10256
11501
|
"modelVersion": {
|
|
11502
|
+
"description": "The version of the model.",
|
|
10257
11503
|
"format": "int64",
|
|
10258
11504
|
"type": "string"
|
|
10259
11505
|
},
|
|
@@ -10547,7 +11793,7 @@
|
|
|
10547
11793
|
"type": "array"
|
|
10548
11794
|
},
|
|
10549
11795
|
"quantity": {
|
|
10550
|
-
"description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field
|
|
11796
|
+
"description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`",
|
|
10551
11797
|
"format": "int32",
|
|
10552
11798
|
"type": "integer"
|
|
10553
11799
|
},
|
|
@@ -10710,7 +11956,7 @@
|
|
|
10710
11956
|
"type": "string"
|
|
10711
11957
|
},
|
|
10712
11958
|
"industryVertical": {
|
|
10713
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore
|
|
11959
|
+
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.",
|
|
10714
11960
|
"enum": [
|
|
10715
11961
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
10716
11962
|
"GENERIC",
|
|
@@ -10814,7 +12060,7 @@
|
|
|
10814
12060
|
"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig",
|
|
10815
12061
|
"properties": {
|
|
10816
12062
|
"companyName": {
|
|
10817
|
-
"description": "
|
|
12063
|
+
"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.",
|
|
10818
12064
|
"type": "string"
|
|
10819
12065
|
}
|
|
10820
12066
|
},
|
|
@@ -10926,7 +12172,7 @@
|
|
|
10926
12172
|
"id": "GoogleCloudDiscoveryengineV1betaFirestoreSource",
|
|
10927
12173
|
"properties": {
|
|
10928
12174
|
"collectionId": {
|
|
10929
|
-
"description": "Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.",
|
|
12175
|
+
"description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.",
|
|
10930
12176
|
"type": "string"
|
|
10931
12177
|
},
|
|
10932
12178
|
"databaseId": {
|
|
@@ -10949,11 +12195,11 @@
|
|
|
10949
12195
|
"id": "GoogleCloudDiscoveryengineV1betaGcsSource",
|
|
10950
12196
|
"properties": {
|
|
10951
12197
|
"dataSchema": {
|
|
10952
|
-
"description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user
|
|
12198
|
+
"description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.",
|
|
10953
12199
|
"type": "string"
|
|
10954
12200
|
},
|
|
10955
12201
|
"inputUris": {
|
|
10956
|
-
"description": "Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).",
|
|
12202
|
+
"description": "Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).",
|
|
10957
12203
|
"items": {
|
|
10958
12204
|
"type": "string"
|
|
10959
12205
|
},
|
|
@@ -11314,6 +12560,24 @@
|
|
|
11314
12560
|
},
|
|
11315
12561
|
"type": "object"
|
|
11316
12562
|
},
|
|
12563
|
+
"GoogleCloudDiscoveryengineV1betaListControlsResponse": {
|
|
12564
|
+
"description": "Response for ListControls method.",
|
|
12565
|
+
"id": "GoogleCloudDiscoveryengineV1betaListControlsResponse",
|
|
12566
|
+
"properties": {
|
|
12567
|
+
"controls": {
|
|
12568
|
+
"description": "All the Controls for a given data store.",
|
|
12569
|
+
"items": {
|
|
12570
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControl"
|
|
12571
|
+
},
|
|
12572
|
+
"type": "array"
|
|
12573
|
+
},
|
|
12574
|
+
"nextPageToken": {
|
|
12575
|
+
"description": "Pagination token, if not returned indicates the last page.",
|
|
12576
|
+
"type": "string"
|
|
12577
|
+
}
|
|
12578
|
+
},
|
|
12579
|
+
"type": "object"
|
|
12580
|
+
},
|
|
11317
12581
|
"GoogleCloudDiscoveryengineV1betaListConversationsResponse": {
|
|
11318
12582
|
"description": "Response for ListConversations method.",
|
|
11319
12583
|
"id": "GoogleCloudDiscoveryengineV1betaListConversationsResponse",
|
|
@@ -11548,6 +12812,100 @@
|
|
|
11548
12812
|
"properties": {},
|
|
11549
12813
|
"type": "object"
|
|
11550
12814
|
},
|
|
12815
|
+
"GoogleCloudDiscoveryengineV1betaProject": {
|
|
12816
|
+
"description": "Metadata and configurations for a Google Cloud project in the service.",
|
|
12817
|
+
"id": "GoogleCloudDiscoveryengineV1betaProject",
|
|
12818
|
+
"properties": {
|
|
12819
|
+
"createTime": {
|
|
12820
|
+
"description": "Output only. The timestamp when this project is created.",
|
|
12821
|
+
"format": "google-datetime",
|
|
12822
|
+
"readOnly": true,
|
|
12823
|
+
"type": "string"
|
|
12824
|
+
},
|
|
12825
|
+
"name": {
|
|
12826
|
+
"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
|
|
12827
|
+
"readOnly": true,
|
|
12828
|
+
"type": "string"
|
|
12829
|
+
},
|
|
12830
|
+
"provisionCompletionTime": {
|
|
12831
|
+
"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.",
|
|
12832
|
+
"format": "google-datetime",
|
|
12833
|
+
"readOnly": true,
|
|
12834
|
+
"type": "string"
|
|
12835
|
+
},
|
|
12836
|
+
"serviceTermsMap": {
|
|
12837
|
+
"additionalProperties": {
|
|
12838
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms"
|
|
12839
|
+
},
|
|
12840
|
+
"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.",
|
|
12841
|
+
"readOnly": true,
|
|
12842
|
+
"type": "object"
|
|
12843
|
+
}
|
|
12844
|
+
},
|
|
12845
|
+
"type": "object"
|
|
12846
|
+
},
|
|
12847
|
+
"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": {
|
|
12848
|
+
"description": "Metadata about the terms of service.",
|
|
12849
|
+
"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms",
|
|
12850
|
+
"properties": {
|
|
12851
|
+
"acceptTime": {
|
|
12852
|
+
"description": "The last time when the project agreed to the terms of service.",
|
|
12853
|
+
"format": "google-datetime",
|
|
12854
|
+
"type": "string"
|
|
12855
|
+
},
|
|
12856
|
+
"declineTime": {
|
|
12857
|
+
"description": "The last time when the project declined or revoked the agreement to terms of service.",
|
|
12858
|
+
"format": "google-datetime",
|
|
12859
|
+
"type": "string"
|
|
12860
|
+
},
|
|
12861
|
+
"id": {
|
|
12862
|
+
"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.",
|
|
12863
|
+
"type": "string"
|
|
12864
|
+
},
|
|
12865
|
+
"state": {
|
|
12866
|
+
"description": "Whether the project has accepted/rejected the service terms or it is still pending.",
|
|
12867
|
+
"enum": [
|
|
12868
|
+
"STATE_UNSPECIFIED",
|
|
12869
|
+
"TERMS_ACCEPTED",
|
|
12870
|
+
"TERMS_PENDING",
|
|
12871
|
+
"TERMS_DECLINED"
|
|
12872
|
+
],
|
|
12873
|
+
"enumDescriptions": [
|
|
12874
|
+
"The default value of the enum. This value is not actually used.",
|
|
12875
|
+
"The project has given consent to the terms of service.",
|
|
12876
|
+
"The project is pending to review and accept the terms of service.",
|
|
12877
|
+
"The project has declined or revoked the agreement to terms of service."
|
|
12878
|
+
],
|
|
12879
|
+
"type": "string"
|
|
12880
|
+
},
|
|
12881
|
+
"version": {
|
|
12882
|
+
"description": "The version string of the terms of service. For acceptable values, see the comments for id above.",
|
|
12883
|
+
"type": "string"
|
|
12884
|
+
}
|
|
12885
|
+
},
|
|
12886
|
+
"type": "object"
|
|
12887
|
+
},
|
|
12888
|
+
"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": {
|
|
12889
|
+
"description": "Metadata associated with a project provision operation.",
|
|
12890
|
+
"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata",
|
|
12891
|
+
"properties": {},
|
|
12892
|
+
"type": "object"
|
|
12893
|
+
},
|
|
12894
|
+
"GoogleCloudDiscoveryengineV1betaProvisionProjectRequest": {
|
|
12895
|
+
"description": "Request for ProjectService.ProvisionProject method.",
|
|
12896
|
+
"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectRequest",
|
|
12897
|
+
"properties": {
|
|
12898
|
+
"acceptDataUseTerms": {
|
|
12899
|
+
"description": "Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms).",
|
|
12900
|
+
"type": "boolean"
|
|
12901
|
+
},
|
|
12902
|
+
"dataUseTermsVersion": {
|
|
12903
|
+
"description": "Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.",
|
|
12904
|
+
"type": "string"
|
|
12905
|
+
}
|
|
12906
|
+
},
|
|
12907
|
+
"type": "object"
|
|
12908
|
+
},
|
|
11551
12909
|
"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": {
|
|
11552
12910
|
"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
11553
12911
|
"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata",
|
|
@@ -11698,6 +13056,13 @@
|
|
|
11698
13056
|
"description": "The number of results to return. If this is unset or no bigger than zero, returns all results.",
|
|
11699
13057
|
"format": "int32",
|
|
11700
13058
|
"type": "integer"
|
|
13059
|
+
},
|
|
13060
|
+
"userLabels": {
|
|
13061
|
+
"additionalProperties": {
|
|
13062
|
+
"type": "string"
|
|
13063
|
+
},
|
|
13064
|
+
"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.",
|
|
13065
|
+
"type": "object"
|
|
11701
13066
|
}
|
|
11702
13067
|
},
|
|
11703
13068
|
"type": "object"
|
|
@@ -11745,11 +13110,11 @@
|
|
|
11745
13110
|
"id": "GoogleCloudDiscoveryengineV1betaRecommendRequest",
|
|
11746
13111
|
"properties": {
|
|
11747
13112
|
"filter": {
|
|
11748
|
-
"description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API
|
|
13113
|
+
"description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.",
|
|
11749
13114
|
"type": "string"
|
|
11750
13115
|
},
|
|
11751
13116
|
"pageSize": {
|
|
11752
|
-
"description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service
|
|
13117
|
+
"description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100.",
|
|
11753
13118
|
"format": "int32",
|
|
11754
13119
|
"type": "integer"
|
|
11755
13120
|
},
|
|
@@ -11757,7 +13122,7 @@
|
|
|
11757
13122
|
"additionalProperties": {
|
|
11758
13123
|
"type": "any"
|
|
11759
13124
|
},
|
|
11760
|
-
"description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true
|
|
13125
|
+
"description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.",
|
|
11761
13126
|
"type": "object"
|
|
11762
13127
|
},
|
|
11763
13128
|
"userEvent": {
|
|
@@ -11772,7 +13137,7 @@
|
|
|
11772
13137
|
"type": "object"
|
|
11773
13138
|
},
|
|
11774
13139
|
"validateOnly": {
|
|
11775
|
-
"description": "Use validate only mode for this recommendation query. If set to true
|
|
13140
|
+
"description": "Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.",
|
|
11776
13141
|
"type": "boolean"
|
|
11777
13142
|
}
|
|
11778
13143
|
},
|
|
@@ -11823,7 +13188,7 @@
|
|
|
11823
13188
|
"additionalProperties": {
|
|
11824
13189
|
"type": "any"
|
|
11825
13190
|
},
|
|
11826
|
-
"description": "Additional Document metadata
|
|
13191
|
+
"description": "Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.",
|
|
11827
13192
|
"type": "object"
|
|
11828
13193
|
}
|
|
11829
13194
|
},
|
|
@@ -11948,7 +13313,7 @@
|
|
|
11948
13313
|
"properties": {
|
|
11949
13314
|
"boostSpec": {
|
|
11950
13315
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
|
|
11951
|
-
"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/
|
|
13316
|
+
"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)"
|
|
11952
13317
|
},
|
|
11953
13318
|
"branch": {
|
|
11954
13319
|
"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.",
|
|
@@ -11963,7 +13328,7 @@
|
|
|
11963
13328
|
"description": "A specification for configuring the behavior of content search."
|
|
11964
13329
|
},
|
|
11965
13330
|
"dataStoreSpecs": {
|
|
11966
|
-
"description": "
|
|
13331
|
+
"description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.",
|
|
11967
13332
|
"items": {
|
|
11968
13333
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
|
|
11969
13334
|
},
|
|
@@ -12010,7 +13375,7 @@
|
|
|
12010
13375
|
"additionalProperties": {
|
|
12011
13376
|
"type": "any"
|
|
12012
13377
|
},
|
|
12013
|
-
"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided.
|
|
13378
|
+
"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`",
|
|
12014
13379
|
"type": "object"
|
|
12015
13380
|
},
|
|
12016
13381
|
"query": {
|
|
@@ -12099,7 +13464,7 @@
|
|
|
12099
13464
|
"enumDescriptions": [
|
|
12100
13465
|
"Unspecified AttributeType.",
|
|
12101
13466
|
"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.",
|
|
12102
|
-
"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
|
|
13467
|
+
"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`."
|
|
12103
13468
|
],
|
|
12104
13469
|
"type": "string"
|
|
12105
13470
|
},
|
|
@@ -12280,7 +13645,7 @@
|
|
|
12280
13645
|
"type": "object"
|
|
12281
13646
|
},
|
|
12282
13647
|
"GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": {
|
|
12283
|
-
"description": "A struct to define data stores to filter on in a search call.",
|
|
13648
|
+
"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
12284
13649
|
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
|
|
12285
13650
|
"properties": {
|
|
12286
13651
|
"dataStore": {
|
|
@@ -12343,7 +13708,7 @@
|
|
|
12343
13708
|
"description": "Required. The facet key specification."
|
|
12344
13709
|
},
|
|
12345
13710
|
"limit": {
|
|
12346
|
-
"description": "Maximum
|
|
13711
|
+
"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.",
|
|
12347
13712
|
"format": "int32",
|
|
12348
13713
|
"type": "integer"
|
|
12349
13714
|
}
|
|
@@ -12359,7 +13724,7 @@
|
|
|
12359
13724
|
"type": "boolean"
|
|
12360
13725
|
},
|
|
12361
13726
|
"contains": {
|
|
12362
|
-
"description": "Only get facet values that
|
|
13727
|
+
"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.",
|
|
12363
13728
|
"items": {
|
|
12364
13729
|
"type": "string"
|
|
12365
13730
|
},
|
|
@@ -12438,7 +13803,7 @@
|
|
|
12438
13803
|
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec",
|
|
12439
13804
|
"properties": {
|
|
12440
13805
|
"mode": {
|
|
12441
|
-
"description": "The mode under which spell correction
|
|
13806
|
+
"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.",
|
|
12442
13807
|
"enum": [
|
|
12443
13808
|
"MODE_UNSPECIFIED",
|
|
12444
13809
|
"SUGGESTION_ONLY",
|
|
@@ -12446,7 +13811,7 @@
|
|
|
12446
13811
|
],
|
|
12447
13812
|
"enumDescriptions": [
|
|
12448
13813
|
"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.",
|
|
12449
|
-
"Search API
|
|
13814
|
+
"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.",
|
|
12450
13815
|
"Automatic spell correction built by the Search API. Search will be based on the corrected query if found."
|
|
12451
13816
|
],
|
|
12452
13817
|
"type": "string"
|
|
@@ -12530,7 +13895,7 @@
|
|
|
12530
13895
|
"type": "boolean"
|
|
12531
13896
|
},
|
|
12532
13897
|
"key": {
|
|
12533
|
-
"description": "The key for this facet.
|
|
13898
|
+
"description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key.",
|
|
12534
13899
|
"type": "string"
|
|
12535
13900
|
},
|
|
12536
13901
|
"values": {
|
|
@@ -12604,11 +13969,11 @@
|
|
|
12604
13969
|
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute",
|
|
12605
13970
|
"properties": {
|
|
12606
13971
|
"attributeKey": {
|
|
12607
|
-
"description": "Attribute key used to refine the results
|
|
13972
|
+
"description": "Attribute key used to refine the results. For example, `\"movie_type\"`.",
|
|
12608
13973
|
"type": "string"
|
|
12609
13974
|
},
|
|
12610
13975
|
"attributeValue": {
|
|
12611
|
-
"description": "Attribute value used to refine the results
|
|
13976
|
+
"description": "Attribute value used to refine the results. For example, `\"drama\"`.",
|
|
12612
13977
|
"type": "string"
|
|
12613
13978
|
}
|
|
12614
13979
|
},
|
|
@@ -12636,7 +14001,7 @@
|
|
|
12636
14001
|
"properties": {
|
|
12637
14002
|
"document": {
|
|
12638
14003
|
"$ref": "GoogleCloudDiscoveryengineV1betaDocument",
|
|
12639
|
-
"description": "The document data snippet in the search response. Only fields that are marked as retrievable are populated."
|
|
14004
|
+
"description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated."
|
|
12640
14005
|
},
|
|
12641
14006
|
"id": {
|
|
12642
14007
|
"description": "Document.id of the searched Document.",
|
|
@@ -12653,7 +14018,7 @@
|
|
|
12653
14018
|
"type": "object"
|
|
12654
14019
|
},
|
|
12655
14020
|
"GoogleCloudDiscoveryengineV1betaSearchResponseSummary": {
|
|
12656
|
-
"description": "Summary of the top N search
|
|
14021
|
+
"description": "Summary of the top N search results specified by the summary spec.",
|
|
12657
14022
|
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary",
|
|
12658
14023
|
"properties": {
|
|
12659
14024
|
"safetyAttributes": {
|
|
@@ -13042,7 +14407,7 @@
|
|
|
13042
14407
|
"id": "GoogleCloudDiscoveryengineV1betaSessionTurn",
|
|
13043
14408
|
"properties": {
|
|
13044
14409
|
"answer": {
|
|
13045
|
-
"description": "The resource name of the answer to the user query.",
|
|
14410
|
+
"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
|
|
13046
14411
|
"type": "string"
|
|
13047
14412
|
},
|
|
13048
14413
|
"query": {
|
|
@@ -13450,7 +14815,7 @@
|
|
|
13450
14815
|
"type": "object"
|
|
13451
14816
|
},
|
|
13452
14817
|
"GoogleCloudDiscoveryengineV1betaUserEvent": {
|
|
13453
|
-
"description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with
|
|
14818
|
+
"description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.",
|
|
13454
14819
|
"id": "GoogleCloudDiscoveryengineV1betaUserEvent",
|
|
13455
14820
|
"properties": {
|
|
13456
14821
|
"attributes": {
|
|
@@ -13468,6 +14833,10 @@
|
|
|
13468
14833
|
"$ref": "GoogleCloudDiscoveryengineV1betaCompletionInfo",
|
|
13469
14834
|
"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."
|
|
13470
14835
|
},
|
|
14836
|
+
"dataStore": {
|
|
14837
|
+
"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.",
|
|
14838
|
+
"type": "string"
|
|
14839
|
+
},
|
|
13471
14840
|
"directUserRequest": {
|
|
13472
14841
|
"description": "Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.",
|
|
13473
14842
|
"type": "boolean"
|
|
@@ -13479,6 +14848,10 @@
|
|
|
13479
14848
|
},
|
|
13480
14849
|
"type": "array"
|
|
13481
14850
|
},
|
|
14851
|
+
"engine": {
|
|
14852
|
+
"description": "The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search.",
|
|
14853
|
+
"type": "string"
|
|
14854
|
+
},
|
|
13482
14855
|
"eventTime": {
|
|
13483
14856
|
"description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.",
|
|
13484
14857
|
"format": "google-datetime",
|
|
@@ -13520,7 +14893,7 @@
|
|
|
13520
14893
|
"type": "string"
|
|
13521
14894
|
},
|
|
13522
14895
|
"tagIds": {
|
|
13523
|
-
"description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups
|
|
14896
|
+
"description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.",
|
|
13524
14897
|
"items": {
|
|
13525
14898
|
"type": "string"
|
|
13526
14899
|
},
|