google-api-python-client 2.97.0__py2.py3-none-any.whl → 2.99.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.97.0.dist-info → google_api_python_client-2.99.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.97.0.dist-info → google_api_python_client-2.99.0.dist-info}/RECORD +390 -387
- 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 +2 -2
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/acmedns.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 +43 -26
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +43 -26
- 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 +1036 -15
- 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 +177 -8
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +177 -29
- googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +72 -1
- googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +303 -5
- googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +2 -2
- googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +60 -1
- googleapiclient/discovery_cache/documents/androidenterprise.v1.json +1 -1
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +12 -10
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +28 -3
- 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 +223 -10
- 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/area120tables.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/artifactregistry.v1.json +2 -33
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +2 -2
- googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +11 -9
- googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +14 -23
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +2 -2
- googleapiclient/discovery_cache/documents/baremetalsolution.v2.json +15 -20
- googleapiclient/discovery_cache/documents/batch.v1.json +2 -2
- googleapiclient/discovery_cache/documents/beyondcorp.v1.json +189 -1
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +92 -1
- googleapiclient/discovery_cache/documents/bigquery.v2.json +29 -1
- googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +4 -4
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +1 -1
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +9 -9
- googleapiclient/discovery_cache/documents/billingbudgets.v1.json +10 -1
- googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json +10 -1
- googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +46 -46
- googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json +3 -3
- 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/certificatemanager.v1.json +2 -2
- googleapiclient/discovery_cache/documents/chat.v1.json +57 -57
- googleapiclient/discovery_cache/documents/checks.v1alpha.json +1323 -517
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +619 -1
- googleapiclient/discovery_cache/documents/chromepolicy.v1.json +23 -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 +9 -2
- googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudbilling.v1.json +3 -3
- googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +5 -24
- googleapiclient/discovery_cache/documents/cloudbuild.v1.json +12 -12
- googleapiclient/discovery_cache/documents/cloudbuild.v2.json +2744 -0
- googleapiclient/discovery_cache/documents/cloudchannel.v1.json +6 -4
- googleapiclient/discovery_cache/documents/clouddeploy.v1.json +99 -1
- googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +1 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +1 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +1 -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 +3 -3
- googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/cloudsearch.v1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudshell.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudsupport.v2.json +18 -18
- googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +18 -18
- googleapiclient/discovery_cache/documents/cloudtasks.v2.json +2 -2
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +2 -2
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +2 -2
- googleapiclient/discovery_cache/documents/cloudtrace.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudtrace.v2.json +1 -1
- googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json +1 -1
- googleapiclient/discovery_cache/documents/composer.v1.json +1 -1
- googleapiclient/discovery_cache/documents/composer.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/compute.alpha.json +1200 -203
- googleapiclient/discovery_cache/documents/compute.beta.json +1374 -40
- googleapiclient/discovery_cache/documents/compute.v1.json +454 -33
- googleapiclient/discovery_cache/documents/connectors.v1.json +81 -1
- googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +3 -3
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +25 -1
- googleapiclient/discovery_cache/documents/container.v1.json +18 -1
- googleapiclient/discovery_cache/documents/container.v1beta1.json +28 -3
- googleapiclient/discovery_cache/documents/containeranalysis.v1.json +24 -1
- googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +24 -1
- googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +24 -1
- googleapiclient/discovery_cache/documents/content.v2.1.json +474 -3
- googleapiclient/discovery_cache/documents/contentwarehouse.v1.json +2193 -289
- googleapiclient/discovery_cache/documents/customsearch.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datacatalog.v1.json +148 -7
- googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +144 -5
- googleapiclient/discovery_cache/documents/dataflow.v1b3.json +5 -1
- googleapiclient/discovery_cache/documents/datalineage.v1.json +61 -2
- googleapiclient/discovery_cache/documents/datamigration.v1.json +1 -1
- 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 +92 -1
- googleapiclient/discovery_cache/documents/dataproc.v1.json +688 -3
- googleapiclient/discovery_cache/documents/datastore.v1.json +2 -2
- googleapiclient/discovery_cache/documents/datastore.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/datastore.v1beta3.json +2 -2
- googleapiclient/discovery_cache/documents/datastream.v1.json +31 -5
- googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +140 -4
- googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +140 -4
- googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +140 -4
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +667 -16
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +594 -16
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +519 -13
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +519 -13
- googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +1 -1
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +2807 -218
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +2306 -199
- googleapiclient/discovery_cache/documents/displayvideo.v1.json +12 -26
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +44 -37
- googleapiclient/discovery_cache/documents/dlp.v2.json +39 -1
- googleapiclient/discovery_cache/documents/dns.v1.json +22 -19
- googleapiclient/discovery_cache/documents/dns.v1beta2.json +22 -19
- googleapiclient/discovery_cache/documents/docs.v1.json +1 -1
- googleapiclient/discovery_cache/documents/documentai.v1.json +39 -1
- googleapiclient/discovery_cache/documents/documentai.v1beta2.json +39 -1
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +95 -1
- googleapiclient/discovery_cache/documents/domains.v1.json +3 -3
- googleapiclient/discovery_cache/documents/domains.v1alpha2.json +3 -3
- googleapiclient/discovery_cache/documents/domains.v1beta1.json +3 -3
- 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 +16 -16
- googleapiclient/discovery_cache/documents/drive.v3.json +10 -10
- 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/eventarc.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/fcm.v1.json +1 -1
- googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/file.v1.json +1 -1
- googleapiclient/discovery_cache/documents/file.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/firebase.v1beta1.json +33 -16
- googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json +2 -2
- googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +30 -1
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +10 -10
- googleapiclient/discovery_cache/documents/firebasehosting.v1.json +373 -1
- googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +887 -16
- googleapiclient/discovery_cache/documents/firebaseml.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/firebaserules.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +3 -2
- googleapiclient/discovery_cache/documents/firestore.v1.json +18 -7
- googleapiclient/discovery_cache/documents/firestore.v1beta1.json +15 -4
- googleapiclient/discovery_cache/documents/firestore.v1beta2.json +13 -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 +249 -68
- 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 +1 -1
- googleapiclient/discovery_cache/documents/gkehub.v1.json +4 -10
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +68 -11
- googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json +1 -1
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +5 -10
- googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +1 -1
- googleapiclient/discovery_cache/documents/gkeonprem.v1.json +107 -5
- googleapiclient/discovery_cache/documents/gmail.v1.json +1 -1
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +12 -2
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +12 -2
- googleapiclient/discovery_cache/documents/groupsmigration.v1.json +1 -1
- googleapiclient/discovery_cache/documents/healthcare.v1.json +9 -9
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +32 -32
- googleapiclient/discovery_cache/documents/homegraph.v1.json +1 -1
- googleapiclient/discovery_cache/documents/iam.v1.json +1 -1
- googleapiclient/discovery_cache/documents/iam.v2.json +1 -1
- googleapiclient/discovery_cache/documents/iam.v2beta.json +1 -1
- googleapiclient/discovery_cache/documents/iamcredentials.v1.json +1 -1
- googleapiclient/discovery_cache/documents/iap.v1.json +9 -2
- googleapiclient/discovery_cache/documents/iap.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +1 -1
- googleapiclient/discovery_cache/documents/identitytoolkit.v2.json +1 -1
- googleapiclient/discovery_cache/documents/indexing.v3.json +1 -1
- googleapiclient/discovery_cache/documents/jobs.v3.json +10 -1
- googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json +11 -2
- googleapiclient/discovery_cache/documents/jobs.v4.json +11 -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 +3 -3
- 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 +4 -4
- googleapiclient/discovery_cache/documents/manufacturers.v1.json +6 -2
- googleapiclient/discovery_cache/documents/memcache.v1.json +78 -5
- googleapiclient/discovery_cache/documents/memcache.v1beta2.json +78 -5
- googleapiclient/discovery_cache/documents/metastore.v1.json +6 -1
- googleapiclient/discovery_cache/documents/metastore.v1alpha.json +7 -2
- googleapiclient/discovery_cache/documents/metastore.v1beta.json +6 -1
- googleapiclient/discovery_cache/documents/migrationcenter.v1.json +3 -2
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +4 -3
- googleapiclient/discovery_cache/documents/ml.v1.json +3 -3
- googleapiclient/discovery_cache/documents/monitoring.v1.json +66 -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 +444 -8
- googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +3 -3
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +9 -9
- googleapiclient/discovery_cache/documents/networkservices.v1.json +8 -1
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +8 -1
- 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 -5
- 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 +5 -1
- googleapiclient/discovery_cache/documents/oslogin.v1beta.json +5 -1
- googleapiclient/discovery_cache/documents/pagespeedonline.v5.json +1 -1
- googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +5 -13
- googleapiclient/discovery_cache/documents/people.v1.json +1 -1
- googleapiclient/discovery_cache/documents/places.v1.json +4 -51
- 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 +262 -0
- googleapiclient/discovery_cache/documents/playintegrity.v1.json +31 -20
- googleapiclient/discovery_cache/documents/policyanalyzer.v1.json +1 -1
- googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1.json +1 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +909 -65
- googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +909 -65
- 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 +7 -2
- googleapiclient/discovery_cache/documents/privateca.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json +38 -1
- 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 +8 -1
- googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +8 -1
- googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +8 -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 +16 -16
- googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +1 -1
- googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +2 -2
- 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 +1 -1
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +5 -4
- googleapiclient/discovery_cache/documents/reseller.v1.json +1 -1
- googleapiclient/discovery_cache/documents/resourcesettings.v1.json +1 -1
- googleapiclient/discovery_cache/documents/retail.v2.json +134 -1
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +134 -1
- googleapiclient/discovery_cache/documents/retail.v2beta.json +134 -1
- googleapiclient/discovery_cache/documents/run.v1.json +1 -1
- googleapiclient/discovery_cache/documents/run.v2.json +1 -1
- googleapiclient/discovery_cache/documents/runtimeconfig.v1.json +1 -1
- googleapiclient/discovery_cache/documents/runtimeconfig.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/safebrowsing.v4.json +1 -1
- googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json +38 -1
- googleapiclient/discovery_cache/documents/script.v1.json +1 -1
- googleapiclient/discovery_cache/documents/searchads360.v0.json +802 -15
- googleapiclient/discovery_cache/documents/searchconsole.v1.json +1 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1.json +1 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +9 -4
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +9 -4
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +13 -6
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +1 -1
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +5 -1
- googleapiclient/discovery_cache/documents/servicecontrol.v1.json +1 -1
- googleapiclient/discovery_cache/documents/servicecontrol.v2.json +1 -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 +1 -1
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +1 -1
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +40 -1
- googleapiclient/discovery_cache/documents/sheets.v4.json +14 -14
- googleapiclient/discovery_cache/documents/slides.v1.json +1 -1
- googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json +1 -1
- googleapiclient/discovery_cache/documents/sourcerepo.v1.json +1 -1
- googleapiclient/discovery_cache/documents/spanner.v1.json +3 -3
- googleapiclient/discovery_cache/documents/speech.v1.json +111 -1
- googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +111 -1
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +7 -2
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +7 -2
- googleapiclient/discovery_cache/documents/storage.v1.json +346 -2
- googleapiclient/discovery_cache/documents/storagetransfer.v1.json +5 -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 +3 -3
- googleapiclient/discovery_cache/documents/tasks.v1.json +1 -1
- googleapiclient/discovery_cache/documents/testing.v1.json +364 -2
- 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 +35 -3
- googleapiclient/discovery_cache/documents/trafficdirector.v2.json +1 -1
- googleapiclient/discovery_cache/documents/transcoder.v1.json +1 -1
- googleapiclient/discovery_cache/documents/translate.v3.json +1 -1
- googleapiclient/discovery_cache/documents/translate.v3beta1.json +1 -1
- googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +1 -1
- googleapiclient/discovery_cache/documents/vault.v1.json +2 -2
- googleapiclient/discovery_cache/documents/verifiedaccess.v1.json +5 -1
- googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +1 -1
- googleapiclient/discovery_cache/documents/versionhistory.v1.json +1 -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 +421 -18
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +421 -18
- googleapiclient/discovery_cache/documents/vpcaccess.v1.json +5 -5
- googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json +5 -5
- 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 +128 -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/workloadmanager.v1.json +46 -35
- googleapiclient/discovery_cache/documents/workstations.v1.json +2304 -0
- googleapiclient/discovery_cache/documents/workstations.v1beta.json +66 -1
- googleapiclient/discovery_cache/documents/youtube.v3.json +20 -7
- 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.97.0.dist-info → google_api_python_client-2.99.0.dist-info}/LICENSE +0 -0
- {google_api_python_client-2.97.0.dist-info → google_api_python_client-2.99.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.97.0.dist-info → google_api_python_client-2.99.0.dist-info}/top_level.txt +0 -0
|
@@ -112,6 +112,53 @@
|
|
|
112
112
|
"collections": {
|
|
113
113
|
"resources": {
|
|
114
114
|
"dataStores": {
|
|
115
|
+
"methods": {
|
|
116
|
+
"completeQuery": {
|
|
117
|
+
"description": "Completes the specified user input with keyword suggestions.",
|
|
118
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:completeQuery",
|
|
119
|
+
"httpMethod": "GET",
|
|
120
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.completeQuery",
|
|
121
|
+
"parameterOrder": [
|
|
122
|
+
"dataStore"
|
|
123
|
+
],
|
|
124
|
+
"parameters": {
|
|
125
|
+
"dataStore": {
|
|
126
|
+
"description": "Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.",
|
|
127
|
+
"location": "path",
|
|
128
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
129
|
+
"required": true,
|
|
130
|
+
"type": "string"
|
|
131
|
+
},
|
|
132
|
+
"includeTailSuggestions": {
|
|
133
|
+
"description": "Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.",
|
|
134
|
+
"location": "query",
|
|
135
|
+
"type": "boolean"
|
|
136
|
+
},
|
|
137
|
+
"query": {
|
|
138
|
+
"description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.",
|
|
139
|
+
"location": "query",
|
|
140
|
+
"type": "string"
|
|
141
|
+
},
|
|
142
|
+
"queryModel": {
|
|
143
|
+
"description": "Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores.",
|
|
144
|
+
"location": "query",
|
|
145
|
+
"type": "string"
|
|
146
|
+
},
|
|
147
|
+
"userPseudoId": {
|
|
148
|
+
"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
149
|
+
"location": "query",
|
|
150
|
+
"type": "string"
|
|
151
|
+
}
|
|
152
|
+
},
|
|
153
|
+
"path": "v1beta/{+dataStore}:completeQuery",
|
|
154
|
+
"response": {
|
|
155
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCompleteQueryResponse"
|
|
156
|
+
},
|
|
157
|
+
"scopes": [
|
|
158
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
159
|
+
]
|
|
160
|
+
}
|
|
161
|
+
},
|
|
115
162
|
"resources": {
|
|
116
163
|
"branches": {
|
|
117
164
|
"resources": {
|
|
@@ -399,6 +446,196 @@
|
|
|
399
446
|
}
|
|
400
447
|
}
|
|
401
448
|
},
|
|
449
|
+
"conversations": {
|
|
450
|
+
"methods": {
|
|
451
|
+
"converse": {
|
|
452
|
+
"description": "Converses a conversation.",
|
|
453
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse",
|
|
454
|
+
"httpMethod": "POST",
|
|
455
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.conversations.converse",
|
|
456
|
+
"parameterOrder": [
|
|
457
|
+
"name"
|
|
458
|
+
],
|
|
459
|
+
"parameters": {
|
|
460
|
+
"name": {
|
|
461
|
+
"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.",
|
|
462
|
+
"location": "path",
|
|
463
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
|
|
464
|
+
"required": true,
|
|
465
|
+
"type": "string"
|
|
466
|
+
}
|
|
467
|
+
},
|
|
468
|
+
"path": "v1beta/{+name}:converse",
|
|
469
|
+
"request": {
|
|
470
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationRequest"
|
|
471
|
+
},
|
|
472
|
+
"response": {
|
|
473
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationResponse"
|
|
474
|
+
},
|
|
475
|
+
"scopes": [
|
|
476
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
477
|
+
]
|
|
478
|
+
},
|
|
479
|
+
"create": {
|
|
480
|
+
"description": "Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.",
|
|
481
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations",
|
|
482
|
+
"httpMethod": "POST",
|
|
483
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.conversations.create",
|
|
484
|
+
"parameterOrder": [
|
|
485
|
+
"parent"
|
|
486
|
+
],
|
|
487
|
+
"parameters": {
|
|
488
|
+
"parent": {
|
|
489
|
+
"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`",
|
|
490
|
+
"location": "path",
|
|
491
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
492
|
+
"required": true,
|
|
493
|
+
"type": "string"
|
|
494
|
+
}
|
|
495
|
+
},
|
|
496
|
+
"path": "v1beta/{+parent}/conversations",
|
|
497
|
+
"request": {
|
|
498
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
499
|
+
},
|
|
500
|
+
"response": {
|
|
501
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
502
|
+
},
|
|
503
|
+
"scopes": [
|
|
504
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
505
|
+
]
|
|
506
|
+
},
|
|
507
|
+
"delete": {
|
|
508
|
+
"description": "Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.",
|
|
509
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}",
|
|
510
|
+
"httpMethod": "DELETE",
|
|
511
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.conversations.delete",
|
|
512
|
+
"parameterOrder": [
|
|
513
|
+
"name"
|
|
514
|
+
],
|
|
515
|
+
"parameters": {
|
|
516
|
+
"name": {
|
|
517
|
+
"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}`",
|
|
518
|
+
"location": "path",
|
|
519
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
|
|
520
|
+
"required": true,
|
|
521
|
+
"type": "string"
|
|
522
|
+
}
|
|
523
|
+
},
|
|
524
|
+
"path": "v1beta/{+name}",
|
|
525
|
+
"response": {
|
|
526
|
+
"$ref": "GoogleProtobufEmpty"
|
|
527
|
+
},
|
|
528
|
+
"scopes": [
|
|
529
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
530
|
+
]
|
|
531
|
+
},
|
|
532
|
+
"get": {
|
|
533
|
+
"description": "Gets a Conversation.",
|
|
534
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}",
|
|
535
|
+
"httpMethod": "GET",
|
|
536
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.conversations.get",
|
|
537
|
+
"parameterOrder": [
|
|
538
|
+
"name"
|
|
539
|
+
],
|
|
540
|
+
"parameters": {
|
|
541
|
+
"name": {
|
|
542
|
+
"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}`",
|
|
543
|
+
"location": "path",
|
|
544
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
|
|
545
|
+
"required": true,
|
|
546
|
+
"type": "string"
|
|
547
|
+
}
|
|
548
|
+
},
|
|
549
|
+
"path": "v1beta/{+name}",
|
|
550
|
+
"response": {
|
|
551
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
552
|
+
},
|
|
553
|
+
"scopes": [
|
|
554
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
555
|
+
]
|
|
556
|
+
},
|
|
557
|
+
"list": {
|
|
558
|
+
"description": "Lists all Conversations by their parent DataStore.",
|
|
559
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations",
|
|
560
|
+
"httpMethod": "GET",
|
|
561
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.conversations.list",
|
|
562
|
+
"parameterOrder": [
|
|
563
|
+
"parent"
|
|
564
|
+
],
|
|
565
|
+
"parameters": {
|
|
566
|
+
"filter": {
|
|
567
|
+
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
|
|
568
|
+
"location": "query",
|
|
569
|
+
"type": "string"
|
|
570
|
+
},
|
|
571
|
+
"orderBy": {
|
|
572
|
+
"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\"",
|
|
573
|
+
"location": "query",
|
|
574
|
+
"type": "string"
|
|
575
|
+
},
|
|
576
|
+
"pageSize": {
|
|
577
|
+
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
578
|
+
"format": "int32",
|
|
579
|
+
"location": "query",
|
|
580
|
+
"type": "integer"
|
|
581
|
+
},
|
|
582
|
+
"pageToken": {
|
|
583
|
+
"description": "A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.",
|
|
584
|
+
"location": "query",
|
|
585
|
+
"type": "string"
|
|
586
|
+
},
|
|
587
|
+
"parent": {
|
|
588
|
+
"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`",
|
|
589
|
+
"location": "path",
|
|
590
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
591
|
+
"required": true,
|
|
592
|
+
"type": "string"
|
|
593
|
+
}
|
|
594
|
+
},
|
|
595
|
+
"path": "v1beta/{+parent}/conversations",
|
|
596
|
+
"response": {
|
|
597
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaListConversationsResponse"
|
|
598
|
+
},
|
|
599
|
+
"scopes": [
|
|
600
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
601
|
+
]
|
|
602
|
+
},
|
|
603
|
+
"patch": {
|
|
604
|
+
"description": "Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.",
|
|
605
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}",
|
|
606
|
+
"httpMethod": "PATCH",
|
|
607
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.conversations.patch",
|
|
608
|
+
"parameterOrder": [
|
|
609
|
+
"name"
|
|
610
|
+
],
|
|
611
|
+
"parameters": {
|
|
612
|
+
"name": {
|
|
613
|
+
"description": "Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`",
|
|
614
|
+
"location": "path",
|
|
615
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
|
|
616
|
+
"required": true,
|
|
617
|
+
"type": "string"
|
|
618
|
+
},
|
|
619
|
+
"updateMask": {
|
|
620
|
+
"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.",
|
|
621
|
+
"format": "google-fieldmask",
|
|
622
|
+
"location": "query",
|
|
623
|
+
"type": "string"
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
"path": "v1beta/{+name}",
|
|
627
|
+
"request": {
|
|
628
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
629
|
+
},
|
|
630
|
+
"response": {
|
|
631
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
632
|
+
},
|
|
633
|
+
"scopes": [
|
|
634
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
635
|
+
]
|
|
636
|
+
}
|
|
637
|
+
}
|
|
638
|
+
},
|
|
402
639
|
"models": {
|
|
403
640
|
"resources": {
|
|
404
641
|
"operations": {
|
|
@@ -544,97 +781,251 @@
|
|
|
544
781
|
}
|
|
545
782
|
},
|
|
546
783
|
"schemas": {
|
|
547
|
-
"resources": {
|
|
548
|
-
"operations": {
|
|
549
|
-
"methods": {
|
|
550
|
-
"get": {
|
|
551
|
-
"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.",
|
|
552
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations/{operationsId}",
|
|
553
|
-
"httpMethod": "GET",
|
|
554
|
-
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.operations.get",
|
|
555
|
-
"parameterOrder": [
|
|
556
|
-
"name"
|
|
557
|
-
],
|
|
558
|
-
"parameters": {
|
|
559
|
-
"name": {
|
|
560
|
-
"description": "The name of the operation resource.",
|
|
561
|
-
"location": "path",
|
|
562
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+/operations/[^/]+$",
|
|
563
|
-
"required": true,
|
|
564
|
-
"type": "string"
|
|
565
|
-
}
|
|
566
|
-
},
|
|
567
|
-
"path": "v1beta/{+name}",
|
|
568
|
-
"response": {
|
|
569
|
-
"$ref": "GoogleLongrunningOperation"
|
|
570
|
-
},
|
|
571
|
-
"scopes": [
|
|
572
|
-
"https://www.googleapis.com/auth/cloud-platform"
|
|
573
|
-
]
|
|
574
|
-
},
|
|
575
|
-
"list": {
|
|
576
|
-
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
|
|
577
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations",
|
|
578
|
-
"httpMethod": "GET",
|
|
579
|
-
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.operations.list",
|
|
580
|
-
"parameterOrder": [
|
|
581
|
-
"name"
|
|
582
|
-
],
|
|
583
|
-
"parameters": {
|
|
584
|
-
"filter": {
|
|
585
|
-
"description": "The standard list filter.",
|
|
586
|
-
"location": "query",
|
|
587
|
-
"type": "string"
|
|
588
|
-
},
|
|
589
|
-
"name": {
|
|
590
|
-
"description": "The name of the operation's parent resource.",
|
|
591
|
-
"location": "path",
|
|
592
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
|
|
593
|
-
"required": true,
|
|
594
|
-
"type": "string"
|
|
595
|
-
},
|
|
596
|
-
"pageSize": {
|
|
597
|
-
"description": "The standard list page size.",
|
|
598
|
-
"format": "int32",
|
|
599
|
-
"location": "query",
|
|
600
|
-
"type": "integer"
|
|
601
|
-
},
|
|
602
|
-
"pageToken": {
|
|
603
|
-
"description": "The standard list page token.",
|
|
604
|
-
"location": "query",
|
|
605
|
-
"type": "string"
|
|
606
|
-
}
|
|
607
|
-
},
|
|
608
|
-
"path": "v1beta/{+name}/operations",
|
|
609
|
-
"response": {
|
|
610
|
-
"$ref": "GoogleLongrunningListOperationsResponse"
|
|
611
|
-
},
|
|
612
|
-
"scopes": [
|
|
613
|
-
"https://www.googleapis.com/auth/cloud-platform"
|
|
614
|
-
]
|
|
615
|
-
}
|
|
616
|
-
}
|
|
617
|
-
}
|
|
618
|
-
}
|
|
619
|
-
},
|
|
620
|
-
"servingConfigs": {
|
|
621
784
|
"methods": {
|
|
622
|
-
"
|
|
623
|
-
"description": "
|
|
624
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/
|
|
785
|
+
"create": {
|
|
786
|
+
"description": "Creates a Schema.",
|
|
787
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas",
|
|
625
788
|
"httpMethod": "POST",
|
|
626
|
-
"id": "discoveryengine.projects.locations.collections.dataStores.
|
|
789
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.create",
|
|
627
790
|
"parameterOrder": [
|
|
628
|
-
"
|
|
791
|
+
"parent"
|
|
629
792
|
],
|
|
630
793
|
"parameters": {
|
|
631
|
-
"
|
|
632
|
-
"description": "Required.
|
|
794
|
+
"parent": {
|
|
795
|
+
"description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
|
|
633
796
|
"location": "path",
|
|
634
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]
|
|
797
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
635
798
|
"required": true,
|
|
636
799
|
"type": "string"
|
|
637
|
-
}
|
|
800
|
+
},
|
|
801
|
+
"schemaId": {
|
|
802
|
+
"description": "Required. The ID to use for the Schema, which will become 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.",
|
|
803
|
+
"location": "query",
|
|
804
|
+
"type": "string"
|
|
805
|
+
}
|
|
806
|
+
},
|
|
807
|
+
"path": "v1beta/{+parent}/schemas",
|
|
808
|
+
"request": {
|
|
809
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
|
|
810
|
+
},
|
|
811
|
+
"response": {
|
|
812
|
+
"$ref": "GoogleLongrunningOperation"
|
|
813
|
+
},
|
|
814
|
+
"scopes": [
|
|
815
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
816
|
+
]
|
|
817
|
+
},
|
|
818
|
+
"delete": {
|
|
819
|
+
"description": "Deletes a Schema.",
|
|
820
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}",
|
|
821
|
+
"httpMethod": "DELETE",
|
|
822
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.delete",
|
|
823
|
+
"parameterOrder": [
|
|
824
|
+
"name"
|
|
825
|
+
],
|
|
826
|
+
"parameters": {
|
|
827
|
+
"name": {
|
|
828
|
+
"description": "Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.",
|
|
829
|
+
"location": "path",
|
|
830
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
|
|
831
|
+
"required": true,
|
|
832
|
+
"type": "string"
|
|
833
|
+
}
|
|
834
|
+
},
|
|
835
|
+
"path": "v1beta/{+name}",
|
|
836
|
+
"response": {
|
|
837
|
+
"$ref": "GoogleLongrunningOperation"
|
|
838
|
+
},
|
|
839
|
+
"scopes": [
|
|
840
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
841
|
+
]
|
|
842
|
+
},
|
|
843
|
+
"get": {
|
|
844
|
+
"description": "Gets a Schema.",
|
|
845
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}",
|
|
846
|
+
"httpMethod": "GET",
|
|
847
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.get",
|
|
848
|
+
"parameterOrder": [
|
|
849
|
+
"name"
|
|
850
|
+
],
|
|
851
|
+
"parameters": {
|
|
852
|
+
"name": {
|
|
853
|
+
"description": "Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.",
|
|
854
|
+
"location": "path",
|
|
855
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
|
|
856
|
+
"required": true,
|
|
857
|
+
"type": "string"
|
|
858
|
+
}
|
|
859
|
+
},
|
|
860
|
+
"path": "v1beta/{+name}",
|
|
861
|
+
"response": {
|
|
862
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
|
|
863
|
+
},
|
|
864
|
+
"scopes": [
|
|
865
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
866
|
+
]
|
|
867
|
+
},
|
|
868
|
+
"list": {
|
|
869
|
+
"description": "Gets a list of Schemas.",
|
|
870
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas",
|
|
871
|
+
"httpMethod": "GET",
|
|
872
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.list",
|
|
873
|
+
"parameterOrder": [
|
|
874
|
+
"parent"
|
|
875
|
+
],
|
|
876
|
+
"parameters": {
|
|
877
|
+
"pageSize": {
|
|
878
|
+
"description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
|
|
879
|
+
"format": "int32",
|
|
880
|
+
"location": "query",
|
|
881
|
+
"type": "integer"
|
|
882
|
+
},
|
|
883
|
+
"pageToken": {
|
|
884
|
+
"description": "A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.",
|
|
885
|
+
"location": "query",
|
|
886
|
+
"type": "string"
|
|
887
|
+
},
|
|
888
|
+
"parent": {
|
|
889
|
+
"description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
|
|
890
|
+
"location": "path",
|
|
891
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
892
|
+
"required": true,
|
|
893
|
+
"type": "string"
|
|
894
|
+
}
|
|
895
|
+
},
|
|
896
|
+
"path": "v1beta/{+parent}/schemas",
|
|
897
|
+
"response": {
|
|
898
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaListSchemasResponse"
|
|
899
|
+
},
|
|
900
|
+
"scopes": [
|
|
901
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
902
|
+
]
|
|
903
|
+
},
|
|
904
|
+
"patch": {
|
|
905
|
+
"description": "Updates a Schema.",
|
|
906
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}",
|
|
907
|
+
"httpMethod": "PATCH",
|
|
908
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.patch",
|
|
909
|
+
"parameterOrder": [
|
|
910
|
+
"name"
|
|
911
|
+
],
|
|
912
|
+
"parameters": {
|
|
913
|
+
"allowMissing": {
|
|
914
|
+
"description": "If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.",
|
|
915
|
+
"location": "query",
|
|
916
|
+
"type": "boolean"
|
|
917
|
+
},
|
|
918
|
+
"name": {
|
|
919
|
+
"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
920
|
+
"location": "path",
|
|
921
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
|
|
922
|
+
"required": true,
|
|
923
|
+
"type": "string"
|
|
924
|
+
}
|
|
925
|
+
},
|
|
926
|
+
"path": "v1beta/{+name}",
|
|
927
|
+
"request": {
|
|
928
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
|
|
929
|
+
},
|
|
930
|
+
"response": {
|
|
931
|
+
"$ref": "GoogleLongrunningOperation"
|
|
932
|
+
},
|
|
933
|
+
"scopes": [
|
|
934
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
935
|
+
]
|
|
936
|
+
}
|
|
937
|
+
},
|
|
938
|
+
"resources": {
|
|
939
|
+
"operations": {
|
|
940
|
+
"methods": {
|
|
941
|
+
"get": {
|
|
942
|
+
"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.",
|
|
943
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations/{operationsId}",
|
|
944
|
+
"httpMethod": "GET",
|
|
945
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.operations.get",
|
|
946
|
+
"parameterOrder": [
|
|
947
|
+
"name"
|
|
948
|
+
],
|
|
949
|
+
"parameters": {
|
|
950
|
+
"name": {
|
|
951
|
+
"description": "The name of the operation resource.",
|
|
952
|
+
"location": "path",
|
|
953
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+/operations/[^/]+$",
|
|
954
|
+
"required": true,
|
|
955
|
+
"type": "string"
|
|
956
|
+
}
|
|
957
|
+
},
|
|
958
|
+
"path": "v1beta/{+name}",
|
|
959
|
+
"response": {
|
|
960
|
+
"$ref": "GoogleLongrunningOperation"
|
|
961
|
+
},
|
|
962
|
+
"scopes": [
|
|
963
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
964
|
+
]
|
|
965
|
+
},
|
|
966
|
+
"list": {
|
|
967
|
+
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
|
|
968
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations",
|
|
969
|
+
"httpMethod": "GET",
|
|
970
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.schemas.operations.list",
|
|
971
|
+
"parameterOrder": [
|
|
972
|
+
"name"
|
|
973
|
+
],
|
|
974
|
+
"parameters": {
|
|
975
|
+
"filter": {
|
|
976
|
+
"description": "The standard list filter.",
|
|
977
|
+
"location": "query",
|
|
978
|
+
"type": "string"
|
|
979
|
+
},
|
|
980
|
+
"name": {
|
|
981
|
+
"description": "The name of the operation's parent resource.",
|
|
982
|
+
"location": "path",
|
|
983
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
|
|
984
|
+
"required": true,
|
|
985
|
+
"type": "string"
|
|
986
|
+
},
|
|
987
|
+
"pageSize": {
|
|
988
|
+
"description": "The standard list page size.",
|
|
989
|
+
"format": "int32",
|
|
990
|
+
"location": "query",
|
|
991
|
+
"type": "integer"
|
|
992
|
+
},
|
|
993
|
+
"pageToken": {
|
|
994
|
+
"description": "The standard list page token.",
|
|
995
|
+
"location": "query",
|
|
996
|
+
"type": "string"
|
|
997
|
+
}
|
|
998
|
+
},
|
|
999
|
+
"path": "v1beta/{+name}/operations",
|
|
1000
|
+
"response": {
|
|
1001
|
+
"$ref": "GoogleLongrunningListOperationsResponse"
|
|
1002
|
+
},
|
|
1003
|
+
"scopes": [
|
|
1004
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1005
|
+
]
|
|
1006
|
+
}
|
|
1007
|
+
}
|
|
1008
|
+
}
|
|
1009
|
+
}
|
|
1010
|
+
},
|
|
1011
|
+
"servingConfigs": {
|
|
1012
|
+
"methods": {
|
|
1013
|
+
"recommend": {
|
|
1014
|
+
"description": "Makes a recommendation, which requires a contextual user event.",
|
|
1015
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend",
|
|
1016
|
+
"httpMethod": "POST",
|
|
1017
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend",
|
|
1018
|
+
"parameterOrder": [
|
|
1019
|
+
"servingConfig"
|
|
1020
|
+
],
|
|
1021
|
+
"parameters": {
|
|
1022
|
+
"servingConfig": {
|
|
1023
|
+
"description": "Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.",
|
|
1024
|
+
"location": "path",
|
|
1025
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
1026
|
+
"required": true,
|
|
1027
|
+
"type": "string"
|
|
1028
|
+
}
|
|
638
1029
|
},
|
|
639
1030
|
"path": "v1beta/{+servingConfig}:recommend",
|
|
640
1031
|
"request": {
|
|
@@ -646,6 +1037,34 @@
|
|
|
646
1037
|
"scopes": [
|
|
647
1038
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
648
1039
|
]
|
|
1040
|
+
},
|
|
1041
|
+
"search": {
|
|
1042
|
+
"description": "Performs a search.",
|
|
1043
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search",
|
|
1044
|
+
"httpMethod": "POST",
|
|
1045
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.search",
|
|
1046
|
+
"parameterOrder": [
|
|
1047
|
+
"servingConfig"
|
|
1048
|
+
],
|
|
1049
|
+
"parameters": {
|
|
1050
|
+
"servingConfig": {
|
|
1051
|
+
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
|
|
1052
|
+
"location": "path",
|
|
1053
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
1054
|
+
"required": true,
|
|
1055
|
+
"type": "string"
|
|
1056
|
+
}
|
|
1057
|
+
},
|
|
1058
|
+
"path": "v1beta/{+servingConfig}:search",
|
|
1059
|
+
"request": {
|
|
1060
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest"
|
|
1061
|
+
},
|
|
1062
|
+
"response": {
|
|
1063
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse"
|
|
1064
|
+
},
|
|
1065
|
+
"scopes": [
|
|
1066
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1067
|
+
]
|
|
649
1068
|
}
|
|
650
1069
|
}
|
|
651
1070
|
},
|
|
@@ -1047,6 +1466,53 @@
|
|
|
1047
1466
|
}
|
|
1048
1467
|
},
|
|
1049
1468
|
"dataStores": {
|
|
1469
|
+
"methods": {
|
|
1470
|
+
"completeQuery": {
|
|
1471
|
+
"description": "Completes the specified user input with keyword suggestions.",
|
|
1472
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:completeQuery",
|
|
1473
|
+
"httpMethod": "GET",
|
|
1474
|
+
"id": "discoveryengine.projects.locations.dataStores.completeQuery",
|
|
1475
|
+
"parameterOrder": [
|
|
1476
|
+
"dataStore"
|
|
1477
|
+
],
|
|
1478
|
+
"parameters": {
|
|
1479
|
+
"dataStore": {
|
|
1480
|
+
"description": "Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.",
|
|
1481
|
+
"location": "path",
|
|
1482
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
1483
|
+
"required": true,
|
|
1484
|
+
"type": "string"
|
|
1485
|
+
},
|
|
1486
|
+
"includeTailSuggestions": {
|
|
1487
|
+
"description": "Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.",
|
|
1488
|
+
"location": "query",
|
|
1489
|
+
"type": "boolean"
|
|
1490
|
+
},
|
|
1491
|
+
"query": {
|
|
1492
|
+
"description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.",
|
|
1493
|
+
"location": "query",
|
|
1494
|
+
"type": "string"
|
|
1495
|
+
},
|
|
1496
|
+
"queryModel": {
|
|
1497
|
+
"description": "Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores.",
|
|
1498
|
+
"location": "query",
|
|
1499
|
+
"type": "string"
|
|
1500
|
+
},
|
|
1501
|
+
"userPseudoId": {
|
|
1502
|
+
"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
1503
|
+
"location": "query",
|
|
1504
|
+
"type": "string"
|
|
1505
|
+
}
|
|
1506
|
+
},
|
|
1507
|
+
"path": "v1beta/{+dataStore}:completeQuery",
|
|
1508
|
+
"response": {
|
|
1509
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCompleteQueryResponse"
|
|
1510
|
+
},
|
|
1511
|
+
"scopes": [
|
|
1512
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1513
|
+
]
|
|
1514
|
+
}
|
|
1515
|
+
},
|
|
1050
1516
|
"resources": {
|
|
1051
1517
|
"branches": {
|
|
1052
1518
|
"resources": {
|
|
@@ -1334,15 +1800,205 @@
|
|
|
1334
1800
|
}
|
|
1335
1801
|
}
|
|
1336
1802
|
},
|
|
1337
|
-
"
|
|
1338
|
-
"
|
|
1339
|
-
"
|
|
1340
|
-
"
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1803
|
+
"conversations": {
|
|
1804
|
+
"methods": {
|
|
1805
|
+
"converse": {
|
|
1806
|
+
"description": "Converses a conversation.",
|
|
1807
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse",
|
|
1808
|
+
"httpMethod": "POST",
|
|
1809
|
+
"id": "discoveryengine.projects.locations.dataStores.conversations.converse",
|
|
1810
|
+
"parameterOrder": [
|
|
1811
|
+
"name"
|
|
1812
|
+
],
|
|
1813
|
+
"parameters": {
|
|
1814
|
+
"name": {
|
|
1815
|
+
"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.",
|
|
1816
|
+
"location": "path",
|
|
1817
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
|
|
1818
|
+
"required": true,
|
|
1819
|
+
"type": "string"
|
|
1820
|
+
}
|
|
1821
|
+
},
|
|
1822
|
+
"path": "v1beta/{+name}:converse",
|
|
1823
|
+
"request": {
|
|
1824
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationRequest"
|
|
1825
|
+
},
|
|
1826
|
+
"response": {
|
|
1827
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConverseConversationResponse"
|
|
1828
|
+
},
|
|
1829
|
+
"scopes": [
|
|
1830
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1831
|
+
]
|
|
1832
|
+
},
|
|
1833
|
+
"create": {
|
|
1834
|
+
"description": "Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.",
|
|
1835
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations",
|
|
1836
|
+
"httpMethod": "POST",
|
|
1837
|
+
"id": "discoveryengine.projects.locations.dataStores.conversations.create",
|
|
1838
|
+
"parameterOrder": [
|
|
1839
|
+
"parent"
|
|
1840
|
+
],
|
|
1841
|
+
"parameters": {
|
|
1842
|
+
"parent": {
|
|
1843
|
+
"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`",
|
|
1844
|
+
"location": "path",
|
|
1845
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
1846
|
+
"required": true,
|
|
1847
|
+
"type": "string"
|
|
1848
|
+
}
|
|
1849
|
+
},
|
|
1850
|
+
"path": "v1beta/{+parent}/conversations",
|
|
1851
|
+
"request": {
|
|
1852
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
1853
|
+
},
|
|
1854
|
+
"response": {
|
|
1855
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
1856
|
+
},
|
|
1857
|
+
"scopes": [
|
|
1858
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1859
|
+
]
|
|
1860
|
+
},
|
|
1861
|
+
"delete": {
|
|
1862
|
+
"description": "Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.",
|
|
1863
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}",
|
|
1864
|
+
"httpMethod": "DELETE",
|
|
1865
|
+
"id": "discoveryengine.projects.locations.dataStores.conversations.delete",
|
|
1866
|
+
"parameterOrder": [
|
|
1867
|
+
"name"
|
|
1868
|
+
],
|
|
1869
|
+
"parameters": {
|
|
1870
|
+
"name": {
|
|
1871
|
+
"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}`",
|
|
1872
|
+
"location": "path",
|
|
1873
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
|
|
1874
|
+
"required": true,
|
|
1875
|
+
"type": "string"
|
|
1876
|
+
}
|
|
1877
|
+
},
|
|
1878
|
+
"path": "v1beta/{+name}",
|
|
1879
|
+
"response": {
|
|
1880
|
+
"$ref": "GoogleProtobufEmpty"
|
|
1881
|
+
},
|
|
1882
|
+
"scopes": [
|
|
1883
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1884
|
+
]
|
|
1885
|
+
},
|
|
1886
|
+
"get": {
|
|
1887
|
+
"description": "Gets a Conversation.",
|
|
1888
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}",
|
|
1889
|
+
"httpMethod": "GET",
|
|
1890
|
+
"id": "discoveryengine.projects.locations.dataStores.conversations.get",
|
|
1891
|
+
"parameterOrder": [
|
|
1892
|
+
"name"
|
|
1893
|
+
],
|
|
1894
|
+
"parameters": {
|
|
1895
|
+
"name": {
|
|
1896
|
+
"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}`",
|
|
1897
|
+
"location": "path",
|
|
1898
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
|
|
1899
|
+
"required": true,
|
|
1900
|
+
"type": "string"
|
|
1901
|
+
}
|
|
1902
|
+
},
|
|
1903
|
+
"path": "v1beta/{+name}",
|
|
1904
|
+
"response": {
|
|
1905
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
1906
|
+
},
|
|
1907
|
+
"scopes": [
|
|
1908
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1909
|
+
]
|
|
1910
|
+
},
|
|
1911
|
+
"list": {
|
|
1912
|
+
"description": "Lists all Conversations by their parent DataStore.",
|
|
1913
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations",
|
|
1914
|
+
"httpMethod": "GET",
|
|
1915
|
+
"id": "discoveryengine.projects.locations.dataStores.conversations.list",
|
|
1916
|
+
"parameterOrder": [
|
|
1917
|
+
"parent"
|
|
1918
|
+
],
|
|
1919
|
+
"parameters": {
|
|
1920
|
+
"filter": {
|
|
1921
|
+
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
|
|
1922
|
+
"location": "query",
|
|
1923
|
+
"type": "string"
|
|
1924
|
+
},
|
|
1925
|
+
"orderBy": {
|
|
1926
|
+
"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\"",
|
|
1927
|
+
"location": "query",
|
|
1928
|
+
"type": "string"
|
|
1929
|
+
},
|
|
1930
|
+
"pageSize": {
|
|
1931
|
+
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
1932
|
+
"format": "int32",
|
|
1933
|
+
"location": "query",
|
|
1934
|
+
"type": "integer"
|
|
1935
|
+
},
|
|
1936
|
+
"pageToken": {
|
|
1937
|
+
"description": "A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.",
|
|
1938
|
+
"location": "query",
|
|
1939
|
+
"type": "string"
|
|
1940
|
+
},
|
|
1941
|
+
"parent": {
|
|
1942
|
+
"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`",
|
|
1943
|
+
"location": "path",
|
|
1944
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
1945
|
+
"required": true,
|
|
1946
|
+
"type": "string"
|
|
1947
|
+
}
|
|
1948
|
+
},
|
|
1949
|
+
"path": "v1beta/{+parent}/conversations",
|
|
1950
|
+
"response": {
|
|
1951
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaListConversationsResponse"
|
|
1952
|
+
},
|
|
1953
|
+
"scopes": [
|
|
1954
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1955
|
+
]
|
|
1956
|
+
},
|
|
1957
|
+
"patch": {
|
|
1958
|
+
"description": "Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.",
|
|
1959
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}",
|
|
1960
|
+
"httpMethod": "PATCH",
|
|
1961
|
+
"id": "discoveryengine.projects.locations.dataStores.conversations.patch",
|
|
1962
|
+
"parameterOrder": [
|
|
1963
|
+
"name"
|
|
1964
|
+
],
|
|
1965
|
+
"parameters": {
|
|
1966
|
+
"name": {
|
|
1967
|
+
"description": "Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`",
|
|
1968
|
+
"location": "path",
|
|
1969
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
|
|
1970
|
+
"required": true,
|
|
1971
|
+
"type": "string"
|
|
1972
|
+
},
|
|
1973
|
+
"updateMask": {
|
|
1974
|
+
"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.",
|
|
1975
|
+
"format": "google-fieldmask",
|
|
1976
|
+
"location": "query",
|
|
1977
|
+
"type": "string"
|
|
1978
|
+
}
|
|
1979
|
+
},
|
|
1980
|
+
"path": "v1beta/{+name}",
|
|
1981
|
+
"request": {
|
|
1982
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
1983
|
+
},
|
|
1984
|
+
"response": {
|
|
1985
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
1986
|
+
},
|
|
1987
|
+
"scopes": [
|
|
1988
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1989
|
+
]
|
|
1990
|
+
}
|
|
1991
|
+
}
|
|
1992
|
+
},
|
|
1993
|
+
"models": {
|
|
1994
|
+
"resources": {
|
|
1995
|
+
"operations": {
|
|
1996
|
+
"methods": {
|
|
1997
|
+
"get": {
|
|
1998
|
+
"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.",
|
|
1999
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}",
|
|
2000
|
+
"httpMethod": "GET",
|
|
2001
|
+
"id": "discoveryengine.projects.locations.dataStores.models.operations.get",
|
|
1346
2002
|
"parameterOrder": [
|
|
1347
2003
|
"name"
|
|
1348
2004
|
],
|
|
@@ -1478,151 +2134,335 @@
|
|
|
1478
2134
|
}
|
|
1479
2135
|
}
|
|
1480
2136
|
},
|
|
1481
|
-
"
|
|
2137
|
+
"schemas": {
|
|
1482
2138
|
"methods": {
|
|
1483
|
-
"
|
|
1484
|
-
"description": "
|
|
1485
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/
|
|
2139
|
+
"create": {
|
|
2140
|
+
"description": "Creates a Schema.",
|
|
2141
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas",
|
|
1486
2142
|
"httpMethod": "POST",
|
|
1487
|
-
"id": "discoveryengine.projects.locations.dataStores.
|
|
2143
|
+
"id": "discoveryengine.projects.locations.dataStores.schemas.create",
|
|
1488
2144
|
"parameterOrder": [
|
|
1489
|
-
"
|
|
2145
|
+
"parent"
|
|
1490
2146
|
],
|
|
1491
2147
|
"parameters": {
|
|
1492
|
-
"
|
|
1493
|
-
"description": "Required.
|
|
2148
|
+
"parent": {
|
|
2149
|
+
"description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
|
|
1494
2150
|
"location": "path",
|
|
1495
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]
|
|
2151
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
1496
2152
|
"required": true,
|
|
1497
2153
|
"type": "string"
|
|
2154
|
+
},
|
|
2155
|
+
"schemaId": {
|
|
2156
|
+
"description": "Required. The ID to use for the Schema, which will become 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.",
|
|
2157
|
+
"location": "query",
|
|
2158
|
+
"type": "string"
|
|
1498
2159
|
}
|
|
1499
2160
|
},
|
|
1500
|
-
"path": "v1beta/{+
|
|
2161
|
+
"path": "v1beta/{+parent}/schemas",
|
|
1501
2162
|
"request": {
|
|
1502
|
-
"$ref": "
|
|
2163
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
|
|
1503
2164
|
},
|
|
1504
2165
|
"response": {
|
|
1505
|
-
"$ref": "
|
|
2166
|
+
"$ref": "GoogleLongrunningOperation"
|
|
1506
2167
|
},
|
|
1507
2168
|
"scopes": [
|
|
1508
2169
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
1509
2170
|
]
|
|
1510
|
-
}
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
|
|
1516
|
-
"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.",
|
|
1517
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect",
|
|
1518
|
-
"httpMethod": "GET",
|
|
1519
|
-
"id": "discoveryengine.projects.locations.dataStores.userEvents.collect",
|
|
2171
|
+
},
|
|
2172
|
+
"delete": {
|
|
2173
|
+
"description": "Deletes a Schema.",
|
|
2174
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}",
|
|
2175
|
+
"httpMethod": "DELETE",
|
|
2176
|
+
"id": "discoveryengine.projects.locations.dataStores.schemas.delete",
|
|
1520
2177
|
"parameterOrder": [
|
|
1521
|
-
"
|
|
2178
|
+
"name"
|
|
1522
2179
|
],
|
|
1523
2180
|
"parameters": {
|
|
1524
|
-
"
|
|
1525
|
-
"description": "
|
|
1526
|
-
"format": "int64",
|
|
1527
|
-
"location": "query",
|
|
1528
|
-
"type": "string"
|
|
1529
|
-
},
|
|
1530
|
-
"parent": {
|
|
1531
|
-
"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
|
|
2181
|
+
"name": {
|
|
2182
|
+
"description": "Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.",
|
|
1532
2183
|
"location": "path",
|
|
1533
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
2184
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
|
|
1534
2185
|
"required": true,
|
|
1535
2186
|
"type": "string"
|
|
1536
|
-
},
|
|
1537
|
-
"uri": {
|
|
1538
|
-
"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.",
|
|
1539
|
-
"location": "query",
|
|
1540
|
-
"type": "string"
|
|
1541
|
-
},
|
|
1542
|
-
"userEvent": {
|
|
1543
|
-
"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.",
|
|
1544
|
-
"location": "query",
|
|
1545
|
-
"type": "string"
|
|
1546
2187
|
}
|
|
1547
2188
|
},
|
|
1548
|
-
"path": "v1beta/{+
|
|
2189
|
+
"path": "v1beta/{+name}",
|
|
1549
2190
|
"response": {
|
|
1550
|
-
"$ref": "
|
|
2191
|
+
"$ref": "GoogleLongrunningOperation"
|
|
1551
2192
|
},
|
|
1552
2193
|
"scopes": [
|
|
1553
2194
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
1554
2195
|
]
|
|
1555
2196
|
},
|
|
1556
|
-
"
|
|
1557
|
-
"description": "
|
|
1558
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/
|
|
1559
|
-
"httpMethod": "
|
|
1560
|
-
"id": "discoveryengine.projects.locations.dataStores.
|
|
2197
|
+
"get": {
|
|
2198
|
+
"description": "Gets a Schema.",
|
|
2199
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}",
|
|
2200
|
+
"httpMethod": "GET",
|
|
2201
|
+
"id": "discoveryengine.projects.locations.dataStores.schemas.get",
|
|
1561
2202
|
"parameterOrder": [
|
|
1562
|
-
"
|
|
2203
|
+
"name"
|
|
1563
2204
|
],
|
|
1564
2205
|
"parameters": {
|
|
1565
|
-
"
|
|
1566
|
-
"description": "Required.
|
|
2206
|
+
"name": {
|
|
2207
|
+
"description": "Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.",
|
|
1567
2208
|
"location": "path",
|
|
1568
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
2209
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
|
|
1569
2210
|
"required": true,
|
|
1570
2211
|
"type": "string"
|
|
1571
2212
|
}
|
|
1572
2213
|
},
|
|
1573
|
-
"path": "v1beta/{+
|
|
1574
|
-
"request": {
|
|
1575
|
-
"$ref": "GoogleCloudDiscoveryengineV1betaImportUserEventsRequest"
|
|
1576
|
-
},
|
|
2214
|
+
"path": "v1beta/{+name}",
|
|
1577
2215
|
"response": {
|
|
1578
|
-
"$ref": "
|
|
2216
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
|
|
1579
2217
|
},
|
|
1580
2218
|
"scopes": [
|
|
1581
2219
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
1582
2220
|
]
|
|
1583
2221
|
},
|
|
1584
|
-
"
|
|
1585
|
-
"description": "
|
|
1586
|
-
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/
|
|
1587
|
-
"httpMethod": "
|
|
1588
|
-
"id": "discoveryengine.projects.locations.dataStores.
|
|
2222
|
+
"list": {
|
|
2223
|
+
"description": "Gets a list of Schemas.",
|
|
2224
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas",
|
|
2225
|
+
"httpMethod": "GET",
|
|
2226
|
+
"id": "discoveryengine.projects.locations.dataStores.schemas.list",
|
|
1589
2227
|
"parameterOrder": [
|
|
1590
2228
|
"parent"
|
|
1591
2229
|
],
|
|
1592
2230
|
"parameters": {
|
|
2231
|
+
"pageSize": {
|
|
2232
|
+
"description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
|
|
2233
|
+
"format": "int32",
|
|
2234
|
+
"location": "query",
|
|
2235
|
+
"type": "integer"
|
|
2236
|
+
},
|
|
2237
|
+
"pageToken": {
|
|
2238
|
+
"description": "A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.",
|
|
2239
|
+
"location": "query",
|
|
2240
|
+
"type": "string"
|
|
2241
|
+
},
|
|
1593
2242
|
"parent": {
|
|
1594
|
-
"description": "Required. The parent
|
|
2243
|
+
"description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
|
|
1595
2244
|
"location": "path",
|
|
1596
2245
|
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
1597
2246
|
"required": true,
|
|
1598
2247
|
"type": "string"
|
|
1599
2248
|
}
|
|
1600
2249
|
},
|
|
1601
|
-
"path": "v1beta/{+parent}/
|
|
1602
|
-
"request": {
|
|
1603
|
-
"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent"
|
|
1604
|
-
},
|
|
2250
|
+
"path": "v1beta/{+parent}/schemas",
|
|
1605
2251
|
"response": {
|
|
1606
|
-
"$ref": "
|
|
2252
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaListSchemasResponse"
|
|
1607
2253
|
},
|
|
1608
2254
|
"scopes": [
|
|
1609
2255
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
1610
2256
|
]
|
|
1611
|
-
}
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
|
|
1625
|
-
|
|
2257
|
+
},
|
|
2258
|
+
"patch": {
|
|
2259
|
+
"description": "Updates a Schema.",
|
|
2260
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}",
|
|
2261
|
+
"httpMethod": "PATCH",
|
|
2262
|
+
"id": "discoveryengine.projects.locations.dataStores.schemas.patch",
|
|
2263
|
+
"parameterOrder": [
|
|
2264
|
+
"name"
|
|
2265
|
+
],
|
|
2266
|
+
"parameters": {
|
|
2267
|
+
"allowMissing": {
|
|
2268
|
+
"description": "If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.",
|
|
2269
|
+
"location": "query",
|
|
2270
|
+
"type": "boolean"
|
|
2271
|
+
},
|
|
2272
|
+
"name": {
|
|
2273
|
+
"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
2274
|
+
"location": "path",
|
|
2275
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/schemas/[^/]+$",
|
|
2276
|
+
"required": true,
|
|
2277
|
+
"type": "string"
|
|
2278
|
+
}
|
|
2279
|
+
},
|
|
2280
|
+
"path": "v1beta/{+name}",
|
|
2281
|
+
"request": {
|
|
2282
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
|
|
2283
|
+
},
|
|
2284
|
+
"response": {
|
|
2285
|
+
"$ref": "GoogleLongrunningOperation"
|
|
2286
|
+
},
|
|
2287
|
+
"scopes": [
|
|
2288
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2289
|
+
]
|
|
2290
|
+
}
|
|
2291
|
+
}
|
|
2292
|
+
},
|
|
2293
|
+
"servingConfigs": {
|
|
2294
|
+
"methods": {
|
|
2295
|
+
"recommend": {
|
|
2296
|
+
"description": "Makes a recommendation, which requires a contextual user event.",
|
|
2297
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend",
|
|
2298
|
+
"httpMethod": "POST",
|
|
2299
|
+
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.recommend",
|
|
2300
|
+
"parameterOrder": [
|
|
2301
|
+
"servingConfig"
|
|
2302
|
+
],
|
|
2303
|
+
"parameters": {
|
|
2304
|
+
"servingConfig": {
|
|
2305
|
+
"description": "Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.",
|
|
2306
|
+
"location": "path",
|
|
2307
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
2308
|
+
"required": true,
|
|
2309
|
+
"type": "string"
|
|
2310
|
+
}
|
|
2311
|
+
},
|
|
2312
|
+
"path": "v1beta/{+servingConfig}:recommend",
|
|
2313
|
+
"request": {
|
|
2314
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaRecommendRequest"
|
|
2315
|
+
},
|
|
2316
|
+
"response": {
|
|
2317
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaRecommendResponse"
|
|
2318
|
+
},
|
|
2319
|
+
"scopes": [
|
|
2320
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2321
|
+
]
|
|
2322
|
+
},
|
|
2323
|
+
"search": {
|
|
2324
|
+
"description": "Performs a search.",
|
|
2325
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search",
|
|
2326
|
+
"httpMethod": "POST",
|
|
2327
|
+
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.search",
|
|
2328
|
+
"parameterOrder": [
|
|
2329
|
+
"servingConfig"
|
|
2330
|
+
],
|
|
2331
|
+
"parameters": {
|
|
2332
|
+
"servingConfig": {
|
|
2333
|
+
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
|
|
2334
|
+
"location": "path",
|
|
2335
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
2336
|
+
"required": true,
|
|
2337
|
+
"type": "string"
|
|
2338
|
+
}
|
|
2339
|
+
},
|
|
2340
|
+
"path": "v1beta/{+servingConfig}:search",
|
|
2341
|
+
"request": {
|
|
2342
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest"
|
|
2343
|
+
},
|
|
2344
|
+
"response": {
|
|
2345
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse"
|
|
2346
|
+
},
|
|
2347
|
+
"scopes": [
|
|
2348
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2349
|
+
]
|
|
2350
|
+
}
|
|
2351
|
+
}
|
|
2352
|
+
},
|
|
2353
|
+
"userEvents": {
|
|
2354
|
+
"methods": {
|
|
2355
|
+
"collect": {
|
|
2356
|
+
"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.",
|
|
2357
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect",
|
|
2358
|
+
"httpMethod": "GET",
|
|
2359
|
+
"id": "discoveryengine.projects.locations.dataStores.userEvents.collect",
|
|
2360
|
+
"parameterOrder": [
|
|
2361
|
+
"parent"
|
|
2362
|
+
],
|
|
2363
|
+
"parameters": {
|
|
2364
|
+
"ets": {
|
|
2365
|
+
"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.",
|
|
2366
|
+
"format": "int64",
|
|
2367
|
+
"location": "query",
|
|
2368
|
+
"type": "string"
|
|
2369
|
+
},
|
|
2370
|
+
"parent": {
|
|
2371
|
+
"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
|
|
2372
|
+
"location": "path",
|
|
2373
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
2374
|
+
"required": true,
|
|
2375
|
+
"type": "string"
|
|
2376
|
+
},
|
|
2377
|
+
"uri": {
|
|
2378
|
+
"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.",
|
|
2379
|
+
"location": "query",
|
|
2380
|
+
"type": "string"
|
|
2381
|
+
},
|
|
2382
|
+
"userEvent": {
|
|
2383
|
+
"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.",
|
|
2384
|
+
"location": "query",
|
|
2385
|
+
"type": "string"
|
|
2386
|
+
}
|
|
2387
|
+
},
|
|
2388
|
+
"path": "v1beta/{+parent}/userEvents:collect",
|
|
2389
|
+
"response": {
|
|
2390
|
+
"$ref": "GoogleApiHttpBody"
|
|
2391
|
+
},
|
|
2392
|
+
"scopes": [
|
|
2393
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2394
|
+
]
|
|
2395
|
+
},
|
|
2396
|
+
"import": {
|
|
2397
|
+
"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.",
|
|
2398
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import",
|
|
2399
|
+
"httpMethod": "POST",
|
|
2400
|
+
"id": "discoveryengine.projects.locations.dataStores.userEvents.import",
|
|
2401
|
+
"parameterOrder": [
|
|
2402
|
+
"parent"
|
|
2403
|
+
],
|
|
2404
|
+
"parameters": {
|
|
2405
|
+
"parent": {
|
|
2406
|
+
"description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`",
|
|
2407
|
+
"location": "path",
|
|
2408
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
2409
|
+
"required": true,
|
|
2410
|
+
"type": "string"
|
|
2411
|
+
}
|
|
2412
|
+
},
|
|
2413
|
+
"path": "v1beta/{+parent}/userEvents:import",
|
|
2414
|
+
"request": {
|
|
2415
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaImportUserEventsRequest"
|
|
2416
|
+
},
|
|
2417
|
+
"response": {
|
|
2418
|
+
"$ref": "GoogleLongrunningOperation"
|
|
2419
|
+
},
|
|
2420
|
+
"scopes": [
|
|
2421
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2422
|
+
]
|
|
2423
|
+
},
|
|
2424
|
+
"write": {
|
|
2425
|
+
"description": "Writes a single user event.",
|
|
2426
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write",
|
|
2427
|
+
"httpMethod": "POST",
|
|
2428
|
+
"id": "discoveryengine.projects.locations.dataStores.userEvents.write",
|
|
2429
|
+
"parameterOrder": [
|
|
2430
|
+
"parent"
|
|
2431
|
+
],
|
|
2432
|
+
"parameters": {
|
|
2433
|
+
"parent": {
|
|
2434
|
+
"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
|
|
2435
|
+
"location": "path",
|
|
2436
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
2437
|
+
"required": true,
|
|
2438
|
+
"type": "string"
|
|
2439
|
+
}
|
|
2440
|
+
},
|
|
2441
|
+
"path": "v1beta/{+parent}/userEvents:write",
|
|
2442
|
+
"request": {
|
|
2443
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent"
|
|
2444
|
+
},
|
|
2445
|
+
"response": {
|
|
2446
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent"
|
|
2447
|
+
},
|
|
2448
|
+
"scopes": [
|
|
2449
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2450
|
+
]
|
|
2451
|
+
}
|
|
2452
|
+
}
|
|
2453
|
+
}
|
|
2454
|
+
}
|
|
2455
|
+
},
|
|
2456
|
+
"operations": {
|
|
2457
|
+
"methods": {
|
|
2458
|
+
"get": {
|
|
2459
|
+
"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.",
|
|
2460
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
|
|
2461
|
+
"httpMethod": "GET",
|
|
2462
|
+
"id": "discoveryengine.projects.locations.operations.get",
|
|
2463
|
+
"parameterOrder": [
|
|
2464
|
+
"name"
|
|
2465
|
+
],
|
|
1626
2466
|
"parameters": {
|
|
1627
2467
|
"name": {
|
|
1628
2468
|
"description": "The name of the operation resource.",
|
|
@@ -1758,7 +2598,7 @@
|
|
|
1758
2598
|
}
|
|
1759
2599
|
}
|
|
1760
2600
|
},
|
|
1761
|
-
"revision": "
|
|
2601
|
+
"revision": "20230907",
|
|
1762
2602
|
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
1763
2603
|
"schemas": {
|
|
1764
2604
|
"GoogleApiHttpBody": {
|
|
@@ -1907,6 +2747,40 @@
|
|
|
1907
2747
|
},
|
|
1908
2748
|
"type": "object"
|
|
1909
2749
|
},
|
|
2750
|
+
"GoogleCloudDiscoveryengineV1CreateSchemaMetadata": {
|
|
2751
|
+
"description": "Metadata for Create Schema LRO.",
|
|
2752
|
+
"id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata",
|
|
2753
|
+
"properties": {
|
|
2754
|
+
"createTime": {
|
|
2755
|
+
"description": "Operation create time.",
|
|
2756
|
+
"format": "google-datetime",
|
|
2757
|
+
"type": "string"
|
|
2758
|
+
},
|
|
2759
|
+
"updateTime": {
|
|
2760
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
2761
|
+
"format": "google-datetime",
|
|
2762
|
+
"type": "string"
|
|
2763
|
+
}
|
|
2764
|
+
},
|
|
2765
|
+
"type": "object"
|
|
2766
|
+
},
|
|
2767
|
+
"GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": {
|
|
2768
|
+
"description": "Metadata for DeleteSchema LRO.",
|
|
2769
|
+
"id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata",
|
|
2770
|
+
"properties": {
|
|
2771
|
+
"createTime": {
|
|
2772
|
+
"description": "Operation create time.",
|
|
2773
|
+
"format": "google-datetime",
|
|
2774
|
+
"type": "string"
|
|
2775
|
+
},
|
|
2776
|
+
"updateTime": {
|
|
2777
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
2778
|
+
"format": "google-datetime",
|
|
2779
|
+
"type": "string"
|
|
2780
|
+
}
|
|
2781
|
+
},
|
|
2782
|
+
"type": "object"
|
|
2783
|
+
},
|
|
1910
2784
|
"GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": {
|
|
1911
2785
|
"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.",
|
|
1912
2786
|
"id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata",
|
|
@@ -2087,6 +2961,23 @@
|
|
|
2087
2961
|
},
|
|
2088
2962
|
"type": "object"
|
|
2089
2963
|
},
|
|
2964
|
+
"GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": {
|
|
2965
|
+
"description": "Metadata for UpdateSchema LRO.",
|
|
2966
|
+
"id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata",
|
|
2967
|
+
"properties": {
|
|
2968
|
+
"createTime": {
|
|
2969
|
+
"description": "Operation create time.",
|
|
2970
|
+
"format": "google-datetime",
|
|
2971
|
+
"type": "string"
|
|
2972
|
+
},
|
|
2973
|
+
"updateTime": {
|
|
2974
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
2975
|
+
"format": "google-datetime",
|
|
2976
|
+
"type": "string"
|
|
2977
|
+
}
|
|
2978
|
+
},
|
|
2979
|
+
"type": "object"
|
|
2980
|
+
},
|
|
2090
2981
|
"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": {
|
|
2091
2982
|
"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.",
|
|
2092
2983
|
"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse",
|
|
@@ -2101,23 +2992,30 @@
|
|
|
2101
2992
|
},
|
|
2102
2993
|
"type": "object"
|
|
2103
2994
|
},
|
|
2104
|
-
"
|
|
2105
|
-
"description": "Metadata
|
|
2106
|
-
"id": "
|
|
2995
|
+
"GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": {
|
|
2996
|
+
"description": "Metadata for Create Schema LRO.",
|
|
2997
|
+
"id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata",
|
|
2107
2998
|
"properties": {
|
|
2108
2999
|
"createTime": {
|
|
2109
3000
|
"description": "Operation create time.",
|
|
2110
3001
|
"format": "google-datetime",
|
|
2111
3002
|
"type": "string"
|
|
2112
3003
|
},
|
|
2113
|
-
"
|
|
2114
|
-
"description": "
|
|
2115
|
-
"format": "
|
|
3004
|
+
"updateTime": {
|
|
3005
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
3006
|
+
"format": "google-datetime",
|
|
2116
3007
|
"type": "string"
|
|
2117
|
-
}
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
|
|
3008
|
+
}
|
|
3009
|
+
},
|
|
3010
|
+
"type": "object"
|
|
3011
|
+
},
|
|
3012
|
+
"GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": {
|
|
3013
|
+
"description": "Metadata for DeleteSchema LRO.",
|
|
3014
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata",
|
|
3015
|
+
"properties": {
|
|
3016
|
+
"createTime": {
|
|
3017
|
+
"description": "Operation create time.",
|
|
3018
|
+
"format": "google-datetime",
|
|
2121
3019
|
"type": "string"
|
|
2122
3020
|
},
|
|
2123
3021
|
"updateTime": {
|
|
@@ -2128,9 +3026,157 @@
|
|
|
2128
3026
|
},
|
|
2129
3027
|
"type": "object"
|
|
2130
3028
|
},
|
|
2131
|
-
"
|
|
2132
|
-
"description": "
|
|
2133
|
-
"id": "
|
|
3029
|
+
"GoogleCloudDiscoveryengineV1alphaFieldConfig": {
|
|
3030
|
+
"description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.",
|
|
3031
|
+
"id": "GoogleCloudDiscoveryengineV1alphaFieldConfig",
|
|
3032
|
+
"properties": {
|
|
3033
|
+
"completableOption": {
|
|
3034
|
+
"description": "If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.",
|
|
3035
|
+
"enum": [
|
|
3036
|
+
"COMPLETABLE_OPTION_UNSPECIFIED",
|
|
3037
|
+
"COMPLETABLE_ENABLED",
|
|
3038
|
+
"COMPLETABLE_DISABLED"
|
|
3039
|
+
],
|
|
3040
|
+
"enumDescriptions": [
|
|
3041
|
+
"Value used when unset.",
|
|
3042
|
+
"Completable option enabled for a schema field.",
|
|
3043
|
+
"Completable option disabled for a schema field."
|
|
3044
|
+
],
|
|
3045
|
+
"type": "string"
|
|
3046
|
+
},
|
|
3047
|
+
"dynamicFacetableOption": {
|
|
3048
|
+
"description": "If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.",
|
|
3049
|
+
"enum": [
|
|
3050
|
+
"DYNAMIC_FACETABLE_OPTION_UNSPECIFIED",
|
|
3051
|
+
"DYNAMIC_FACETABLE_ENABLED",
|
|
3052
|
+
"DYNAMIC_FACETABLE_DISABLED"
|
|
3053
|
+
],
|
|
3054
|
+
"enumDescriptions": [
|
|
3055
|
+
"Value used when unset.",
|
|
3056
|
+
"Dynamic facetable option enabled for a schema field.",
|
|
3057
|
+
"Dynamic facetable option disabled for a schema field."
|
|
3058
|
+
],
|
|
3059
|
+
"type": "string"
|
|
3060
|
+
},
|
|
3061
|
+
"fieldPath": {
|
|
3062
|
+
"description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.",
|
|
3063
|
+
"type": "string"
|
|
3064
|
+
},
|
|
3065
|
+
"fieldType": {
|
|
3066
|
+
"description": "Output only. Raw type of the field.",
|
|
3067
|
+
"enum": [
|
|
3068
|
+
"FIELD_TYPE_UNSPECIFIED",
|
|
3069
|
+
"OBJECT",
|
|
3070
|
+
"STRING",
|
|
3071
|
+
"NUMBER",
|
|
3072
|
+
"INTEGER",
|
|
3073
|
+
"BOOLEAN"
|
|
3074
|
+
],
|
|
3075
|
+
"enumDescriptions": [
|
|
3076
|
+
"Field type is unspecified.",
|
|
3077
|
+
"Field value type is Object.",
|
|
3078
|
+
"Field value type is String.",
|
|
3079
|
+
"Field value type is Number.",
|
|
3080
|
+
"Field value type is Integer.",
|
|
3081
|
+
"Field value type is Boolean."
|
|
3082
|
+
],
|
|
3083
|
+
"readOnly": true,
|
|
3084
|
+
"type": "string"
|
|
3085
|
+
},
|
|
3086
|
+
"indexableOption": {
|
|
3087
|
+
"description": "If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.",
|
|
3088
|
+
"enum": [
|
|
3089
|
+
"INDEXABLE_OPTION_UNSPECIFIED",
|
|
3090
|
+
"INDEXABLE_ENABLED",
|
|
3091
|
+
"INDEXABLE_DISABLED"
|
|
3092
|
+
],
|
|
3093
|
+
"enumDescriptions": [
|
|
3094
|
+
"Value used when unset.",
|
|
3095
|
+
"Indexable option enabled for a schema field.",
|
|
3096
|
+
"Indexable option disabled for a schema field."
|
|
3097
|
+
],
|
|
3098
|
+
"type": "string"
|
|
3099
|
+
},
|
|
3100
|
+
"keyPropertyType": {
|
|
3101
|
+
"description": "Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.",
|
|
3102
|
+
"readOnly": true,
|
|
3103
|
+
"type": "string"
|
|
3104
|
+
},
|
|
3105
|
+
"recsFilterableOption": {
|
|
3106
|
+
"description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.",
|
|
3107
|
+
"enum": [
|
|
3108
|
+
"FILTERABLE_OPTION_UNSPECIFIED",
|
|
3109
|
+
"FILTERABLE_ENABLED",
|
|
3110
|
+
"FILTERABLE_DISABLED"
|
|
3111
|
+
],
|
|
3112
|
+
"enumDescriptions": [
|
|
3113
|
+
"Value used when unset.",
|
|
3114
|
+
"Filterable option enabled for a schema field.",
|
|
3115
|
+
"Filterable option disabled for a schema field."
|
|
3116
|
+
],
|
|
3117
|
+
"type": "string"
|
|
3118
|
+
},
|
|
3119
|
+
"retrievableOption": {
|
|
3120
|
+
"description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.",
|
|
3121
|
+
"enum": [
|
|
3122
|
+
"RETRIEVABLE_OPTION_UNSPECIFIED",
|
|
3123
|
+
"RETRIEVABLE_ENABLED",
|
|
3124
|
+
"RETRIEVABLE_DISABLED"
|
|
3125
|
+
],
|
|
3126
|
+
"enumDescriptions": [
|
|
3127
|
+
"Value used when unset.",
|
|
3128
|
+
"Retrievable option enabled for a schema field.",
|
|
3129
|
+
"Retrievable option disabled for a schema field."
|
|
3130
|
+
],
|
|
3131
|
+
"type": "string"
|
|
3132
|
+
},
|
|
3133
|
+
"searchableOption": {
|
|
3134
|
+
"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.",
|
|
3135
|
+
"enum": [
|
|
3136
|
+
"SEARCHABLE_OPTION_UNSPECIFIED",
|
|
3137
|
+
"SEARCHABLE_ENABLED",
|
|
3138
|
+
"SEARCHABLE_DISABLED"
|
|
3139
|
+
],
|
|
3140
|
+
"enumDescriptions": [
|
|
3141
|
+
"Value used when unset.",
|
|
3142
|
+
"Searchable option enabled for a schema field.",
|
|
3143
|
+
"Searchable option disabled for a schema field."
|
|
3144
|
+
],
|
|
3145
|
+
"type": "string"
|
|
3146
|
+
}
|
|
3147
|
+
},
|
|
3148
|
+
"type": "object"
|
|
3149
|
+
},
|
|
3150
|
+
"GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": {
|
|
3151
|
+
"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.",
|
|
3152
|
+
"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata",
|
|
3153
|
+
"properties": {
|
|
3154
|
+
"createTime": {
|
|
3155
|
+
"description": "Operation create time.",
|
|
3156
|
+
"format": "google-datetime",
|
|
3157
|
+
"type": "string"
|
|
3158
|
+
},
|
|
3159
|
+
"failureCount": {
|
|
3160
|
+
"description": "Count of entries that encountered errors while processing.",
|
|
3161
|
+
"format": "int64",
|
|
3162
|
+
"type": "string"
|
|
3163
|
+
},
|
|
3164
|
+
"successCount": {
|
|
3165
|
+
"description": "Count of entries that were processed successfully.",
|
|
3166
|
+
"format": "int64",
|
|
3167
|
+
"type": "string"
|
|
3168
|
+
},
|
|
3169
|
+
"updateTime": {
|
|
3170
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
3171
|
+
"format": "google-datetime",
|
|
3172
|
+
"type": "string"
|
|
3173
|
+
}
|
|
3174
|
+
},
|
|
3175
|
+
"type": "object"
|
|
3176
|
+
},
|
|
3177
|
+
"GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": {
|
|
3178
|
+
"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.",
|
|
3179
|
+
"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse",
|
|
2134
3180
|
"properties": {
|
|
2135
3181
|
"errorConfig": {
|
|
2136
3182
|
"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig",
|
|
@@ -2301,6 +3347,14 @@
|
|
|
2301
3347
|
"description": "Defines the structure and layout of a type of document data.",
|
|
2302
3348
|
"id": "GoogleCloudDiscoveryengineV1alphaSchema",
|
|
2303
3349
|
"properties": {
|
|
3350
|
+
"fieldConfigs": {
|
|
3351
|
+
"description": "Output only. Configurations for fields of the schema.",
|
|
3352
|
+
"items": {
|
|
3353
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig"
|
|
3354
|
+
},
|
|
3355
|
+
"readOnly": true,
|
|
3356
|
+
"type": "array"
|
|
3357
|
+
},
|
|
2304
3358
|
"jsonSchema": {
|
|
2305
3359
|
"description": "The JSON representation of the schema.",
|
|
2306
3360
|
"type": "string"
|
|
@@ -2435,10 +3489,21 @@
|
|
|
2435
3489
|
},
|
|
2436
3490
|
"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": {
|
|
2437
3491
|
"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure",
|
|
3492
|
+
"properties": {},
|
|
3493
|
+
"type": "object"
|
|
3494
|
+
},
|
|
3495
|
+
"GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": {
|
|
3496
|
+
"description": "Metadata for UpdateSchema LRO.",
|
|
3497
|
+
"id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata",
|
|
2438
3498
|
"properties": {
|
|
2439
|
-
"
|
|
2440
|
-
"description": "
|
|
2441
|
-
"format": "
|
|
3499
|
+
"createTime": {
|
|
3500
|
+
"description": "Operation create time.",
|
|
3501
|
+
"format": "google-datetime",
|
|
3502
|
+
"type": "string"
|
|
3503
|
+
},
|
|
3504
|
+
"updateTime": {
|
|
3505
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
3506
|
+
"format": "google-datetime",
|
|
2442
3507
|
"type": "string"
|
|
2443
3508
|
}
|
|
2444
3509
|
},
|
|
@@ -2475,6 +3540,42 @@
|
|
|
2475
3540
|
},
|
|
2476
3541
|
"type": "object"
|
|
2477
3542
|
},
|
|
3543
|
+
"GoogleCloudDiscoveryengineV1betaCompleteQueryResponse": {
|
|
3544
|
+
"description": "Response message for CompletionService.CompleteQuery method.",
|
|
3545
|
+
"id": "GoogleCloudDiscoveryengineV1betaCompleteQueryResponse",
|
|
3546
|
+
"properties": {
|
|
3547
|
+
"querySuggestions": {
|
|
3548
|
+
"description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.",
|
|
3549
|
+
"items": {
|
|
3550
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion"
|
|
3551
|
+
},
|
|
3552
|
+
"type": "array"
|
|
3553
|
+
},
|
|
3554
|
+
"tailMatchTriggered": {
|
|
3555
|
+
"description": "True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.",
|
|
3556
|
+
"type": "boolean"
|
|
3557
|
+
}
|
|
3558
|
+
},
|
|
3559
|
+
"type": "object"
|
|
3560
|
+
},
|
|
3561
|
+
"GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion": {
|
|
3562
|
+
"description": "Suggestions as search queries.",
|
|
3563
|
+
"id": "GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion",
|
|
3564
|
+
"properties": {
|
|
3565
|
+
"completableFieldPaths": {
|
|
3566
|
+
"description": "The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.",
|
|
3567
|
+
"items": {
|
|
3568
|
+
"type": "string"
|
|
3569
|
+
},
|
|
3570
|
+
"type": "array"
|
|
3571
|
+
},
|
|
3572
|
+
"suggestion": {
|
|
3573
|
+
"description": "The suggestion for the query.",
|
|
3574
|
+
"type": "string"
|
|
3575
|
+
}
|
|
3576
|
+
},
|
|
3577
|
+
"type": "object"
|
|
3578
|
+
},
|
|
2478
3579
|
"GoogleCloudDiscoveryengineV1betaCompletionInfo": {
|
|
2479
3580
|
"description": "Detailed completion information including completion attribution token and clicked completion info.",
|
|
2480
3581
|
"id": "GoogleCloudDiscoveryengineV1betaCompletionInfo",
|
|
@@ -2491,6 +3592,173 @@
|
|
|
2491
3592
|
},
|
|
2492
3593
|
"type": "object"
|
|
2493
3594
|
},
|
|
3595
|
+
"GoogleCloudDiscoveryengineV1betaConversation": {
|
|
3596
|
+
"description": "External conversation proto definition.",
|
|
3597
|
+
"id": "GoogleCloudDiscoveryengineV1betaConversation",
|
|
3598
|
+
"properties": {
|
|
3599
|
+
"endTime": {
|
|
3600
|
+
"description": "Output only. The time the conversation finished.",
|
|
3601
|
+
"format": "google-datetime",
|
|
3602
|
+
"readOnly": true,
|
|
3603
|
+
"type": "string"
|
|
3604
|
+
},
|
|
3605
|
+
"messages": {
|
|
3606
|
+
"description": "Conversation messages.",
|
|
3607
|
+
"items": {
|
|
3608
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversationMessage"
|
|
3609
|
+
},
|
|
3610
|
+
"type": "array"
|
|
3611
|
+
},
|
|
3612
|
+
"name": {
|
|
3613
|
+
"description": "Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`",
|
|
3614
|
+
"type": "string"
|
|
3615
|
+
},
|
|
3616
|
+
"startTime": {
|
|
3617
|
+
"description": "Output only. The time the conversation started.",
|
|
3618
|
+
"format": "google-datetime",
|
|
3619
|
+
"readOnly": true,
|
|
3620
|
+
"type": "string"
|
|
3621
|
+
},
|
|
3622
|
+
"state": {
|
|
3623
|
+
"description": "The state of the Conversation.",
|
|
3624
|
+
"enum": [
|
|
3625
|
+
"STATE_UNSPECIFIED",
|
|
3626
|
+
"IN_PROGRESS",
|
|
3627
|
+
"COMPLETED"
|
|
3628
|
+
],
|
|
3629
|
+
"enumDescriptions": [
|
|
3630
|
+
"Unknown.",
|
|
3631
|
+
"Conversation is currently open.",
|
|
3632
|
+
"Conversation has been completed."
|
|
3633
|
+
],
|
|
3634
|
+
"type": "string"
|
|
3635
|
+
},
|
|
3636
|
+
"userPseudoId": {
|
|
3637
|
+
"description": "A unique identifier for tracking users.",
|
|
3638
|
+
"type": "string"
|
|
3639
|
+
}
|
|
3640
|
+
},
|
|
3641
|
+
"type": "object"
|
|
3642
|
+
},
|
|
3643
|
+
"GoogleCloudDiscoveryengineV1betaConversationContext": {
|
|
3644
|
+
"description": "Defines context of the conversation",
|
|
3645
|
+
"id": "GoogleCloudDiscoveryengineV1betaConversationContext",
|
|
3646
|
+
"properties": {
|
|
3647
|
+
"activeDocument": {
|
|
3648
|
+
"description": "The current active document the user opened. It contains the document resource reference.",
|
|
3649
|
+
"type": "string"
|
|
3650
|
+
},
|
|
3651
|
+
"contextDocuments": {
|
|
3652
|
+
"description": "The current list of documents the user is seeing. It contains the document resource references.",
|
|
3653
|
+
"items": {
|
|
3654
|
+
"type": "string"
|
|
3655
|
+
},
|
|
3656
|
+
"type": "array"
|
|
3657
|
+
}
|
|
3658
|
+
},
|
|
3659
|
+
"type": "object"
|
|
3660
|
+
},
|
|
3661
|
+
"GoogleCloudDiscoveryengineV1betaConversationMessage": {
|
|
3662
|
+
"description": "Defines a conversation message.",
|
|
3663
|
+
"id": "GoogleCloudDiscoveryengineV1betaConversationMessage",
|
|
3664
|
+
"properties": {
|
|
3665
|
+
"createTime": {
|
|
3666
|
+
"description": "Output only. Message creation timestamp.",
|
|
3667
|
+
"format": "google-datetime",
|
|
3668
|
+
"readOnly": true,
|
|
3669
|
+
"type": "string"
|
|
3670
|
+
},
|
|
3671
|
+
"reply": {
|
|
3672
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaReply",
|
|
3673
|
+
"description": "Search reply."
|
|
3674
|
+
},
|
|
3675
|
+
"userInput": {
|
|
3676
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaTextInput",
|
|
3677
|
+
"description": "User text input."
|
|
3678
|
+
}
|
|
3679
|
+
},
|
|
3680
|
+
"type": "object"
|
|
3681
|
+
},
|
|
3682
|
+
"GoogleCloudDiscoveryengineV1betaConverseConversationRequest": {
|
|
3683
|
+
"description": "Request message for ConversationalSearchService.ConverseConversation method.",
|
|
3684
|
+
"id": "GoogleCloudDiscoveryengineV1betaConverseConversationRequest",
|
|
3685
|
+
"properties": {
|
|
3686
|
+
"conversation": {
|
|
3687
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation",
|
|
3688
|
+
"description": "The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session."
|
|
3689
|
+
},
|
|
3690
|
+
"query": {
|
|
3691
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaTextInput",
|
|
3692
|
+
"description": "Required. Current user input."
|
|
3693
|
+
},
|
|
3694
|
+
"safeSearch": {
|
|
3695
|
+
"description": "Whether to turn on safe search.",
|
|
3696
|
+
"type": "boolean"
|
|
3697
|
+
},
|
|
3698
|
+
"servingConfig": {
|
|
3699
|
+
"description": "The resource name of the Serving Config to use. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.",
|
|
3700
|
+
"type": "string"
|
|
3701
|
+
},
|
|
3702
|
+
"summarySpec": {
|
|
3703
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec",
|
|
3704
|
+
"description": "A specification for configuring the summary returned in the response."
|
|
3705
|
+
},
|
|
3706
|
+
"userLabels": {
|
|
3707
|
+
"additionalProperties": {
|
|
3708
|
+
"type": "string"
|
|
3709
|
+
},
|
|
3710
|
+
"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.",
|
|
3711
|
+
"type": "object"
|
|
3712
|
+
}
|
|
3713
|
+
},
|
|
3714
|
+
"type": "object"
|
|
3715
|
+
},
|
|
3716
|
+
"GoogleCloudDiscoveryengineV1betaConverseConversationResponse": {
|
|
3717
|
+
"description": "Response message for ConversationalSearchService.ConverseConversation method.",
|
|
3718
|
+
"id": "GoogleCloudDiscoveryengineV1betaConverseConversationResponse",
|
|
3719
|
+
"properties": {
|
|
3720
|
+
"conversation": {
|
|
3721
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation",
|
|
3722
|
+
"description": "Updated conversation including the answer."
|
|
3723
|
+
},
|
|
3724
|
+
"relatedQuestions": {
|
|
3725
|
+
"description": "Suggested related questions.",
|
|
3726
|
+
"items": {
|
|
3727
|
+
"type": "string"
|
|
3728
|
+
},
|
|
3729
|
+
"type": "array"
|
|
3730
|
+
},
|
|
3731
|
+
"reply": {
|
|
3732
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaReply",
|
|
3733
|
+
"description": "Answer to the current query."
|
|
3734
|
+
},
|
|
3735
|
+
"searchResults": {
|
|
3736
|
+
"description": "Search Results.",
|
|
3737
|
+
"items": {
|
|
3738
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult"
|
|
3739
|
+
},
|
|
3740
|
+
"type": "array"
|
|
3741
|
+
}
|
|
3742
|
+
},
|
|
3743
|
+
"type": "object"
|
|
3744
|
+
},
|
|
3745
|
+
"GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": {
|
|
3746
|
+
"description": "Metadata for Create Schema LRO.",
|
|
3747
|
+
"id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata",
|
|
3748
|
+
"properties": {
|
|
3749
|
+
"createTime": {
|
|
3750
|
+
"description": "Operation create time.",
|
|
3751
|
+
"format": "google-datetime",
|
|
3752
|
+
"type": "string"
|
|
3753
|
+
},
|
|
3754
|
+
"updateTime": {
|
|
3755
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
3756
|
+
"format": "google-datetime",
|
|
3757
|
+
"type": "string"
|
|
3758
|
+
}
|
|
3759
|
+
},
|
|
3760
|
+
"type": "object"
|
|
3761
|
+
},
|
|
2494
3762
|
"GoogleCloudDiscoveryengineV1betaCustomAttribute": {
|
|
2495
3763
|
"description": "A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.",
|
|
2496
3764
|
"id": "GoogleCloudDiscoveryengineV1betaCustomAttribute",
|
|
@@ -2513,10 +3781,40 @@
|
|
|
2513
3781
|
},
|
|
2514
3782
|
"type": "object"
|
|
2515
3783
|
},
|
|
3784
|
+
"GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": {
|
|
3785
|
+
"description": "Metadata for DeleteSchema LRO.",
|
|
3786
|
+
"id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata",
|
|
3787
|
+
"properties": {
|
|
3788
|
+
"createTime": {
|
|
3789
|
+
"description": "Operation create time.",
|
|
3790
|
+
"format": "google-datetime",
|
|
3791
|
+
"type": "string"
|
|
3792
|
+
},
|
|
3793
|
+
"updateTime": {
|
|
3794
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
3795
|
+
"format": "google-datetime",
|
|
3796
|
+
"type": "string"
|
|
3797
|
+
}
|
|
3798
|
+
},
|
|
3799
|
+
"type": "object"
|
|
3800
|
+
},
|
|
2516
3801
|
"GoogleCloudDiscoveryengineV1betaDocument": {
|
|
2517
3802
|
"description": "Document captures all raw metadata information of items to be recommended or searched.",
|
|
2518
3803
|
"id": "GoogleCloudDiscoveryengineV1betaDocument",
|
|
2519
3804
|
"properties": {
|
|
3805
|
+
"content": {
|
|
3806
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentContent",
|
|
3807
|
+
"description": "The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store."
|
|
3808
|
+
},
|
|
3809
|
+
"derivedStructData": {
|
|
3810
|
+
"additionalProperties": {
|
|
3811
|
+
"description": "Properties of the object.",
|
|
3812
|
+
"type": "any"
|
|
3813
|
+
},
|
|
3814
|
+
"description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.",
|
|
3815
|
+
"readOnly": true,
|
|
3816
|
+
"type": "object"
|
|
3817
|
+
},
|
|
2520
3818
|
"id": {
|
|
2521
3819
|
"description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.",
|
|
2522
3820
|
"type": "string"
|
|
@@ -2548,6 +3846,26 @@
|
|
|
2548
3846
|
},
|
|
2549
3847
|
"type": "object"
|
|
2550
3848
|
},
|
|
3849
|
+
"GoogleCloudDiscoveryengineV1betaDocumentContent": {
|
|
3850
|
+
"description": "Unstructured data linked to this document.",
|
|
3851
|
+
"id": "GoogleCloudDiscoveryengineV1betaDocumentContent",
|
|
3852
|
+
"properties": {
|
|
3853
|
+
"mimeType": {
|
|
3854
|
+
"description": "The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.",
|
|
3855
|
+
"type": "string"
|
|
3856
|
+
},
|
|
3857
|
+
"rawBytes": {
|
|
3858
|
+
"description": "The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.",
|
|
3859
|
+
"format": "byte",
|
|
3860
|
+
"type": "string"
|
|
3861
|
+
},
|
|
3862
|
+
"uri": {
|
|
3863
|
+
"description": "The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 100 MB.",
|
|
3864
|
+
"type": "string"
|
|
3865
|
+
}
|
|
3866
|
+
},
|
|
3867
|
+
"type": "object"
|
|
3868
|
+
},
|
|
2551
3869
|
"GoogleCloudDiscoveryengineV1betaDocumentInfo": {
|
|
2552
3870
|
"description": "Detailed document information associated with a user event.",
|
|
2553
3871
|
"id": "GoogleCloudDiscoveryengineV1betaDocumentInfo",
|
|
@@ -2579,13 +3897,28 @@
|
|
|
2579
3897
|
},
|
|
2580
3898
|
"type": "object"
|
|
2581
3899
|
},
|
|
2582
|
-
"
|
|
2583
|
-
"description": "
|
|
2584
|
-
"id": "
|
|
3900
|
+
"GoogleCloudDiscoveryengineV1betaDoubleList": {
|
|
3901
|
+
"description": "Double list.",
|
|
3902
|
+
"id": "GoogleCloudDiscoveryengineV1betaDoubleList",
|
|
2585
3903
|
"properties": {
|
|
2586
|
-
"
|
|
2587
|
-
"description": "
|
|
2588
|
-
"
|
|
3904
|
+
"values": {
|
|
3905
|
+
"description": "Double values.",
|
|
3906
|
+
"items": {
|
|
3907
|
+
"format": "double",
|
|
3908
|
+
"type": "number"
|
|
3909
|
+
},
|
|
3910
|
+
"type": "array"
|
|
3911
|
+
}
|
|
3912
|
+
},
|
|
3913
|
+
"type": "object"
|
|
3914
|
+
},
|
|
3915
|
+
"GoogleCloudDiscoveryengineV1betaGcsSource": {
|
|
3916
|
+
"description": "Cloud Storage location for input content.",
|
|
3917
|
+
"id": "GoogleCloudDiscoveryengineV1betaGcsSource",
|
|
3918
|
+
"properties": {
|
|
3919
|
+
"dataSchema": {
|
|
3920
|
+
"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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.",
|
|
3921
|
+
"type": "string"
|
|
2589
3922
|
},
|
|
2590
3923
|
"inputUris": {
|
|
2591
3924
|
"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`).",
|
|
@@ -2804,6 +4137,51 @@
|
|
|
2804
4137
|
},
|
|
2805
4138
|
"type": "object"
|
|
2806
4139
|
},
|
|
4140
|
+
"GoogleCloudDiscoveryengineV1betaInterval": {
|
|
4141
|
+
"description": "A floating point interval.",
|
|
4142
|
+
"id": "GoogleCloudDiscoveryengineV1betaInterval",
|
|
4143
|
+
"properties": {
|
|
4144
|
+
"exclusiveMaximum": {
|
|
4145
|
+
"description": "Exclusive upper bound.",
|
|
4146
|
+
"format": "double",
|
|
4147
|
+
"type": "number"
|
|
4148
|
+
},
|
|
4149
|
+
"exclusiveMinimum": {
|
|
4150
|
+
"description": "Exclusive lower bound.",
|
|
4151
|
+
"format": "double",
|
|
4152
|
+
"type": "number"
|
|
4153
|
+
},
|
|
4154
|
+
"maximum": {
|
|
4155
|
+
"description": "Inclusive upper bound.",
|
|
4156
|
+
"format": "double",
|
|
4157
|
+
"type": "number"
|
|
4158
|
+
},
|
|
4159
|
+
"minimum": {
|
|
4160
|
+
"description": "Inclusive lower bound.",
|
|
4161
|
+
"format": "double",
|
|
4162
|
+
"type": "number"
|
|
4163
|
+
}
|
|
4164
|
+
},
|
|
4165
|
+
"type": "object"
|
|
4166
|
+
},
|
|
4167
|
+
"GoogleCloudDiscoveryengineV1betaListConversationsResponse": {
|
|
4168
|
+
"description": "Response for ListConversations method.",
|
|
4169
|
+
"id": "GoogleCloudDiscoveryengineV1betaListConversationsResponse",
|
|
4170
|
+
"properties": {
|
|
4171
|
+
"conversations": {
|
|
4172
|
+
"description": "All the Conversations for a given data store.",
|
|
4173
|
+
"items": {
|
|
4174
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversation"
|
|
4175
|
+
},
|
|
4176
|
+
"type": "array"
|
|
4177
|
+
},
|
|
4178
|
+
"nextPageToken": {
|
|
4179
|
+
"description": "Pagination token, if not returned indicates the last page.",
|
|
4180
|
+
"type": "string"
|
|
4181
|
+
}
|
|
4182
|
+
},
|
|
4183
|
+
"type": "object"
|
|
4184
|
+
},
|
|
2807
4185
|
"GoogleCloudDiscoveryengineV1betaListDocumentsResponse": {
|
|
2808
4186
|
"description": "Response message for DocumentService.ListDocuments method.",
|
|
2809
4187
|
"id": "GoogleCloudDiscoveryengineV1betaListDocumentsResponse",
|
|
@@ -2822,6 +4200,24 @@
|
|
|
2822
4200
|
},
|
|
2823
4201
|
"type": "object"
|
|
2824
4202
|
},
|
|
4203
|
+
"GoogleCloudDiscoveryengineV1betaListSchemasResponse": {
|
|
4204
|
+
"description": "Response message for SchemaService.ListSchemas method.",
|
|
4205
|
+
"id": "GoogleCloudDiscoveryengineV1betaListSchemasResponse",
|
|
4206
|
+
"properties": {
|
|
4207
|
+
"nextPageToken": {
|
|
4208
|
+
"description": "A token that can be sent as ListSchemasRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
|
|
4209
|
+
"type": "string"
|
|
4210
|
+
},
|
|
4211
|
+
"schemas": {
|
|
4212
|
+
"description": "The Schemas.",
|
|
4213
|
+
"items": {
|
|
4214
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSchema"
|
|
4215
|
+
},
|
|
4216
|
+
"type": "array"
|
|
4217
|
+
}
|
|
4218
|
+
},
|
|
4219
|
+
"type": "object"
|
|
4220
|
+
},
|
|
2825
4221
|
"GoogleCloudDiscoveryengineV1betaMediaInfo": {
|
|
2826
4222
|
"description": "Media-specific user event information.",
|
|
2827
4223
|
"id": "GoogleCloudDiscoveryengineV1betaMediaInfo",
|
|
@@ -3037,6 +4433,56 @@
|
|
|
3037
4433
|
},
|
|
3038
4434
|
"type": "object"
|
|
3039
4435
|
},
|
|
4436
|
+
"GoogleCloudDiscoveryengineV1betaReply": {
|
|
4437
|
+
"description": "Defines a reply message to user.",
|
|
4438
|
+
"id": "GoogleCloudDiscoveryengineV1betaReply",
|
|
4439
|
+
"properties": {
|
|
4440
|
+
"references": {
|
|
4441
|
+
"deprecated": true,
|
|
4442
|
+
"description": "References in the reply.",
|
|
4443
|
+
"items": {
|
|
4444
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaReplyReference"
|
|
4445
|
+
},
|
|
4446
|
+
"type": "array"
|
|
4447
|
+
},
|
|
4448
|
+
"reply": {
|
|
4449
|
+
"deprecated": true,
|
|
4450
|
+
"description": "DEPRECATED: use `summary` instead. Text reply.",
|
|
4451
|
+
"type": "string"
|
|
4452
|
+
},
|
|
4453
|
+
"summary": {
|
|
4454
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary",
|
|
4455
|
+
"description": "Summary based on search results."
|
|
4456
|
+
}
|
|
4457
|
+
},
|
|
4458
|
+
"type": "object"
|
|
4459
|
+
},
|
|
4460
|
+
"GoogleCloudDiscoveryengineV1betaReplyReference": {
|
|
4461
|
+
"deprecated": true,
|
|
4462
|
+
"description": "Defines reference in reply.",
|
|
4463
|
+
"id": "GoogleCloudDiscoveryengineV1betaReplyReference",
|
|
4464
|
+
"properties": {
|
|
4465
|
+
"anchorText": {
|
|
4466
|
+
"description": "Anchor text.",
|
|
4467
|
+
"type": "string"
|
|
4468
|
+
},
|
|
4469
|
+
"end": {
|
|
4470
|
+
"description": "Anchor text end index.",
|
|
4471
|
+
"format": "int32",
|
|
4472
|
+
"type": "integer"
|
|
4473
|
+
},
|
|
4474
|
+
"start": {
|
|
4475
|
+
"description": "Anchor text start index.",
|
|
4476
|
+
"format": "int32",
|
|
4477
|
+
"type": "integer"
|
|
4478
|
+
},
|
|
4479
|
+
"uri": {
|
|
4480
|
+
"description": "URI link reference.",
|
|
4481
|
+
"type": "string"
|
|
4482
|
+
}
|
|
4483
|
+
},
|
|
4484
|
+
"type": "object"
|
|
4485
|
+
},
|
|
3040
4486
|
"GoogleCloudDiscoveryengineV1betaSchema": {
|
|
3041
4487
|
"description": "Defines the structure and layout of a type of document data.",
|
|
3042
4488
|
"id": "GoogleCloudDiscoveryengineV1betaSchema",
|
|
@@ -3080,6 +4526,650 @@
|
|
|
3080
4526
|
},
|
|
3081
4527
|
"type": "object"
|
|
3082
4528
|
},
|
|
4529
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequest": {
|
|
4530
|
+
"description": "Request message for SearchService.Search method.",
|
|
4531
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequest",
|
|
4532
|
+
"properties": {
|
|
4533
|
+
"boostSpec": {
|
|
4534
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
|
|
4535
|
+
"description": "Boost specification to boost certain documents."
|
|
4536
|
+
},
|
|
4537
|
+
"branch": {
|
|
4538
|
+
"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.",
|
|
4539
|
+
"type": "string"
|
|
4540
|
+
},
|
|
4541
|
+
"contentSearchSpec": {
|
|
4542
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec",
|
|
4543
|
+
"description": "A specification for configuring the behavior of content search."
|
|
4544
|
+
},
|
|
4545
|
+
"embeddingSpec": {
|
|
4546
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",
|
|
4547
|
+
"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.embedding_spec.embedding_vectors.vector and the document embedding that is provided in SearchRequest.embedding_spec.embedding_vectors.field_path. If SearchRequest.embedding_spec.embedding_vectors.field_path is not provided, it will use ServingConfig.embedding_config.field_paths."
|
|
4548
|
+
},
|
|
4549
|
+
"facetSpecs": {
|
|
4550
|
+
"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
4551
|
+
"items": {
|
|
4552
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec"
|
|
4553
|
+
},
|
|
4554
|
+
"type": "array"
|
|
4555
|
+
},
|
|
4556
|
+
"filter": {
|
|
4557
|
+
"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. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.",
|
|
4558
|
+
"type": "string"
|
|
4559
|
+
},
|
|
4560
|
+
"imageQuery": {
|
|
4561
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery",
|
|
4562
|
+
"description": "Raw image query."
|
|
4563
|
+
},
|
|
4564
|
+
"offset": {
|
|
4565
|
+
"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.",
|
|
4566
|
+
"format": "int32",
|
|
4567
|
+
"type": "integer"
|
|
4568
|
+
},
|
|
4569
|
+
"orderBy": {
|
|
4570
|
+
"description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.",
|
|
4571
|
+
"type": "string"
|
|
4572
|
+
},
|
|
4573
|
+
"pageSize": {
|
|
4574
|
+
"description": "Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned.",
|
|
4575
|
+
"format": "int32",
|
|
4576
|
+
"type": "integer"
|
|
4577
|
+
},
|
|
4578
|
+
"pageToken": {
|
|
4579
|
+
"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
4580
|
+
"type": "string"
|
|
4581
|
+
},
|
|
4582
|
+
"params": {
|
|
4583
|
+
"additionalProperties": {
|
|
4584
|
+
"type": "any"
|
|
4585
|
+
},
|
|
4586
|
+
"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. * `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.",
|
|
4587
|
+
"type": "object"
|
|
4588
|
+
},
|
|
4589
|
+
"query": {
|
|
4590
|
+
"description": "Raw search query.",
|
|
4591
|
+
"type": "string"
|
|
4592
|
+
},
|
|
4593
|
+
"queryExpansionSpec": {
|
|
4594
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec",
|
|
4595
|
+
"description": "The query expansion specification that specifies the conditions under which query expansion occurs."
|
|
4596
|
+
},
|
|
4597
|
+
"rankingExpression": {
|
|
4598
|
+
"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joint by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: `relevance_score`: pre-defined keywords, used for measure relevance between query and document. `embedding_field_path`: the document embedding field used with query embedding vector. `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.",
|
|
4599
|
+
"type": "string"
|
|
4600
|
+
},
|
|
4601
|
+
"safeSearch": {
|
|
4602
|
+
"description": "Whether to turn on safe search. This is only supported for website search.",
|
|
4603
|
+
"type": "boolean"
|
|
4604
|
+
},
|
|
4605
|
+
"spellCorrectionSpec": {
|
|
4606
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec",
|
|
4607
|
+
"description": "The spell correction specification that specifies the mode under which spell correction takes effect."
|
|
4608
|
+
},
|
|
4609
|
+
"userInfo": {
|
|
4610
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo",
|
|
4611
|
+
"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics."
|
|
4612
|
+
},
|
|
4613
|
+
"userLabels": {
|
|
4614
|
+
"additionalProperties": {
|
|
4615
|
+
"type": "string"
|
|
4616
|
+
},
|
|
4617
|
+
"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.",
|
|
4618
|
+
"type": "object"
|
|
4619
|
+
},
|
|
4620
|
+
"userPseudoId": {
|
|
4621
|
+
"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
4622
|
+
"type": "string"
|
|
4623
|
+
}
|
|
4624
|
+
},
|
|
4625
|
+
"type": "object"
|
|
4626
|
+
},
|
|
4627
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": {
|
|
4628
|
+
"description": "Boost specification to boost certain documents.",
|
|
4629
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
|
|
4630
|
+
"properties": {
|
|
4631
|
+
"conditionBoostSpecs": {
|
|
4632
|
+
"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.",
|
|
4633
|
+
"items": {
|
|
4634
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec"
|
|
4635
|
+
},
|
|
4636
|
+
"type": "array"
|
|
4637
|
+
}
|
|
4638
|
+
},
|
|
4639
|
+
"type": "object"
|
|
4640
|
+
},
|
|
4641
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": {
|
|
4642
|
+
"description": "Boost applies to documents which match a condition.",
|
|
4643
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec",
|
|
4644
|
+
"properties": {
|
|
4645
|
+
"boost": {
|
|
4646
|
+
"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.",
|
|
4647
|
+
"format": "float",
|
|
4648
|
+
"type": "number"
|
|
4649
|
+
},
|
|
4650
|
+
"condition": {
|
|
4651
|
+
"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": * (id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\",\"Blue\"))",
|
|
4652
|
+
"type": "string"
|
|
4653
|
+
}
|
|
4654
|
+
},
|
|
4655
|
+
"type": "object"
|
|
4656
|
+
},
|
|
4657
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": {
|
|
4658
|
+
"description": "A specification for configuring the behavior of content search.",
|
|
4659
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec",
|
|
4660
|
+
"properties": {
|
|
4661
|
+
"extractiveContentSpec": {
|
|
4662
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec",
|
|
4663
|
+
"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response."
|
|
4664
|
+
},
|
|
4665
|
+
"snippetSpec": {
|
|
4666
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec",
|
|
4667
|
+
"description": "If `snippetSpec` is not specified, snippets are not included in the search response."
|
|
4668
|
+
},
|
|
4669
|
+
"summarySpec": {
|
|
4670
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec",
|
|
4671
|
+
"description": "If `summarySpec` is not specified, summaries are not included in the search response."
|
|
4672
|
+
}
|
|
4673
|
+
},
|
|
4674
|
+
"type": "object"
|
|
4675
|
+
},
|
|
4676
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": {
|
|
4677
|
+
"description": "A specification for configuring the extractive content in a search response.",
|
|
4678
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec",
|
|
4679
|
+
"properties": {
|
|
4680
|
+
"maxExtractiveAnswerCount": {
|
|
4681
|
+
"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most one answer is returned for each SearchResult.",
|
|
4682
|
+
"format": "int32",
|
|
4683
|
+
"type": "integer"
|
|
4684
|
+
},
|
|
4685
|
+
"maxExtractiveSegmentCount": {
|
|
4686
|
+
"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.",
|
|
4687
|
+
"format": "int32",
|
|
4688
|
+
"type": "integer"
|
|
4689
|
+
},
|
|
4690
|
+
"numNextSegments": {
|
|
4691
|
+
"description": "Return at most `num_next_segments` segments after each selected segments.",
|
|
4692
|
+
"format": "int32",
|
|
4693
|
+
"type": "integer"
|
|
4694
|
+
},
|
|
4695
|
+
"numPreviousSegments": {
|
|
4696
|
+
"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.",
|
|
4697
|
+
"format": "int32",
|
|
4698
|
+
"type": "integer"
|
|
4699
|
+
},
|
|
4700
|
+
"returnExtractiveSegmentScore": {
|
|
4701
|
+
"description": "Specifies whether to return the confidence score from the extractive segments in each search result. The default value is `false`.",
|
|
4702
|
+
"type": "boolean"
|
|
4703
|
+
}
|
|
4704
|
+
},
|
|
4705
|
+
"type": "object"
|
|
4706
|
+
},
|
|
4707
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": {
|
|
4708
|
+
"description": "A specification for configuring snippets in a search response.",
|
|
4709
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec",
|
|
4710
|
+
"properties": {
|
|
4711
|
+
"maxSnippetCount": {
|
|
4712
|
+
"deprecated": true,
|
|
4713
|
+
"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.",
|
|
4714
|
+
"format": "int32",
|
|
4715
|
+
"type": "integer"
|
|
4716
|
+
},
|
|
4717
|
+
"referenceOnly": {
|
|
4718
|
+
"deprecated": true,
|
|
4719
|
+
"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.",
|
|
4720
|
+
"type": "boolean"
|
|
4721
|
+
},
|
|
4722
|
+
"returnSnippet": {
|
|
4723
|
+
"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.",
|
|
4724
|
+
"type": "boolean"
|
|
4725
|
+
}
|
|
4726
|
+
},
|
|
4727
|
+
"type": "object"
|
|
4728
|
+
},
|
|
4729
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": {
|
|
4730
|
+
"description": "A specification for configuring a summary returned in a search response.",
|
|
4731
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec",
|
|
4732
|
+
"properties": {
|
|
4733
|
+
"ignoreAdversarialQuery": {
|
|
4734
|
+
"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary 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 summaries for adversarial queries and return fallback messages instead.",
|
|
4735
|
+
"type": "boolean"
|
|
4736
|
+
},
|
|
4737
|
+
"ignoreNonSummarySeekingQuery": {
|
|
4738
|
+
"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.",
|
|
4739
|
+
"type": "boolean"
|
|
4740
|
+
},
|
|
4741
|
+
"includeCitations": {
|
|
4742
|
+
"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.",
|
|
4743
|
+
"type": "boolean"
|
|
4744
|
+
},
|
|
4745
|
+
"languageCode": {
|
|
4746
|
+
"description": "Language code for Summary. Use language tags defined by BCP47.",
|
|
4747
|
+
"type": "string"
|
|
4748
|
+
},
|
|
4749
|
+
"summaryResultCount": {
|
|
4750
|
+
"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary.",
|
|
4751
|
+
"format": "int32",
|
|
4752
|
+
"type": "integer"
|
|
4753
|
+
}
|
|
4754
|
+
},
|
|
4755
|
+
"type": "object"
|
|
4756
|
+
},
|
|
4757
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": {
|
|
4758
|
+
"description": "The specification that uses customized query embedding vector to do semantic document retrieval.",
|
|
4759
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",
|
|
4760
|
+
"properties": {
|
|
4761
|
+
"embeddingVectors": {
|
|
4762
|
+
"description": "The embedding vector used for retrieval. Limit to 1.",
|
|
4763
|
+
"items": {
|
|
4764
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector"
|
|
4765
|
+
},
|
|
4766
|
+
"type": "array"
|
|
4767
|
+
}
|
|
4768
|
+
},
|
|
4769
|
+
"type": "object"
|
|
4770
|
+
},
|
|
4771
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": {
|
|
4772
|
+
"description": "Embedding vector.",
|
|
4773
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector",
|
|
4774
|
+
"properties": {
|
|
4775
|
+
"fieldPath": {
|
|
4776
|
+
"description": "Embedding field path in schema.",
|
|
4777
|
+
"type": "string"
|
|
4778
|
+
},
|
|
4779
|
+
"vector": {
|
|
4780
|
+
"description": "Query embedding vector.",
|
|
4781
|
+
"items": {
|
|
4782
|
+
"format": "float",
|
|
4783
|
+
"type": "number"
|
|
4784
|
+
},
|
|
4785
|
+
"type": "array"
|
|
4786
|
+
}
|
|
4787
|
+
},
|
|
4788
|
+
"type": "object"
|
|
4789
|
+
},
|
|
4790
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": {
|
|
4791
|
+
"description": "A facet specification to perform faceted search.",
|
|
4792
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec",
|
|
4793
|
+
"properties": {
|
|
4794
|
+
"enableDynamicPosition": {
|
|
4795
|
+
"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.",
|
|
4796
|
+
"type": "boolean"
|
|
4797
|
+
},
|
|
4798
|
+
"excludedFilterKeys": {
|
|
4799
|
+
"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
4800
|
+
"items": {
|
|
4801
|
+
"type": "string"
|
|
4802
|
+
},
|
|
4803
|
+
"type": "array"
|
|
4804
|
+
},
|
|
4805
|
+
"facetKey": {
|
|
4806
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey",
|
|
4807
|
+
"description": "Required. The facet key specification."
|
|
4808
|
+
},
|
|
4809
|
+
"limit": {
|
|
4810
|
+
"description": "Maximum of facet values that should be 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.",
|
|
4811
|
+
"format": "int32",
|
|
4812
|
+
"type": "integer"
|
|
4813
|
+
}
|
|
4814
|
+
},
|
|
4815
|
+
"type": "object"
|
|
4816
|
+
},
|
|
4817
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": {
|
|
4818
|
+
"description": "Specifies how a facet is computed.",
|
|
4819
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey",
|
|
4820
|
+
"properties": {
|
|
4821
|
+
"caseInsensitive": {
|
|
4822
|
+
"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.",
|
|
4823
|
+
"type": "boolean"
|
|
4824
|
+
},
|
|
4825
|
+
"contains": {
|
|
4826
|
+
"description": "Only get facet values that contains 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.",
|
|
4827
|
+
"items": {
|
|
4828
|
+
"type": "string"
|
|
4829
|
+
},
|
|
4830
|
+
"type": "array"
|
|
4831
|
+
},
|
|
4832
|
+
"intervals": {
|
|
4833
|
+
"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.",
|
|
4834
|
+
"items": {
|
|
4835
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaInterval"
|
|
4836
|
+
},
|
|
4837
|
+
"type": "array"
|
|
4838
|
+
},
|
|
4839
|
+
"key": {
|
|
4840
|
+
"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.",
|
|
4841
|
+
"type": "string"
|
|
4842
|
+
},
|
|
4843
|
+
"orderBy": {
|
|
4844
|
+
"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.",
|
|
4845
|
+
"type": "string"
|
|
4846
|
+
},
|
|
4847
|
+
"prefixes": {
|
|
4848
|
+
"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.",
|
|
4849
|
+
"items": {
|
|
4850
|
+
"type": "string"
|
|
4851
|
+
},
|
|
4852
|
+
"type": "array"
|
|
4853
|
+
},
|
|
4854
|
+
"restrictedValues": {
|
|
4855
|
+
"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.",
|
|
4856
|
+
"items": {
|
|
4857
|
+
"type": "string"
|
|
4858
|
+
},
|
|
4859
|
+
"type": "array"
|
|
4860
|
+
}
|
|
4861
|
+
},
|
|
4862
|
+
"type": "object"
|
|
4863
|
+
},
|
|
4864
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": {
|
|
4865
|
+
"description": "Specifies the image query input.",
|
|
4866
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery",
|
|
4867
|
+
"properties": {
|
|
4868
|
+
"imageBytes": {
|
|
4869
|
+
"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.",
|
|
4870
|
+
"type": "string"
|
|
4871
|
+
}
|
|
4872
|
+
},
|
|
4873
|
+
"type": "object"
|
|
4874
|
+
},
|
|
4875
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": {
|
|
4876
|
+
"description": "Specification to determine under which conditions query expansion should occur.",
|
|
4877
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec",
|
|
4878
|
+
"properties": {
|
|
4879
|
+
"condition": {
|
|
4880
|
+
"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.",
|
|
4881
|
+
"enum": [
|
|
4882
|
+
"CONDITION_UNSPECIFIED",
|
|
4883
|
+
"DISABLED",
|
|
4884
|
+
"AUTO"
|
|
4885
|
+
],
|
|
4886
|
+
"enumDescriptions": [
|
|
4887
|
+
"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.",
|
|
4888
|
+
"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.",
|
|
4889
|
+
"Automatic query expansion built by the Search API."
|
|
4890
|
+
],
|
|
4891
|
+
"type": "string"
|
|
4892
|
+
},
|
|
4893
|
+
"pinUnexpandedResults": {
|
|
4894
|
+
"description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.",
|
|
4895
|
+
"type": "boolean"
|
|
4896
|
+
}
|
|
4897
|
+
},
|
|
4898
|
+
"type": "object"
|
|
4899
|
+
},
|
|
4900
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": {
|
|
4901
|
+
"description": "The specification for query spell correction.",
|
|
4902
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec",
|
|
4903
|
+
"properties": {
|
|
4904
|
+
"mode": {
|
|
4905
|
+
"description": "The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO.",
|
|
4906
|
+
"enum": [
|
|
4907
|
+
"MODE_UNSPECIFIED",
|
|
4908
|
+
"SUGGESTION_ONLY",
|
|
4909
|
+
"AUTO"
|
|
4910
|
+
],
|
|
4911
|
+
"enumDescriptions": [
|
|
4912
|
+
"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.",
|
|
4913
|
+
"Search API will try to find a spell suggestion if there is any and put in the SearchResponse.corrected_query. The spell suggestion will not be used as the search query.",
|
|
4914
|
+
"Automatic spell correction built by the Search API. Search will be based on the corrected query if found."
|
|
4915
|
+
],
|
|
4916
|
+
"type": "string"
|
|
4917
|
+
}
|
|
4918
|
+
},
|
|
4919
|
+
"type": "object"
|
|
4920
|
+
},
|
|
4921
|
+
"GoogleCloudDiscoveryengineV1betaSearchResponse": {
|
|
4922
|
+
"description": "Response message for SearchService.Search method.",
|
|
4923
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchResponse",
|
|
4924
|
+
"properties": {
|
|
4925
|
+
"appliedControls": {
|
|
4926
|
+
"description": "Controls applied as part of the Control service.",
|
|
4927
|
+
"items": {
|
|
4928
|
+
"type": "string"
|
|
4929
|
+
},
|
|
4930
|
+
"type": "array"
|
|
4931
|
+
},
|
|
4932
|
+
"attributionToken": {
|
|
4933
|
+
"description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.",
|
|
4934
|
+
"type": "string"
|
|
4935
|
+
},
|
|
4936
|
+
"correctedQuery": {
|
|
4937
|
+
"description": "Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.",
|
|
4938
|
+
"type": "string"
|
|
4939
|
+
},
|
|
4940
|
+
"facets": {
|
|
4941
|
+
"description": "Results of facets requested by user.",
|
|
4942
|
+
"items": {
|
|
4943
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseFacet"
|
|
4944
|
+
},
|
|
4945
|
+
"type": "array"
|
|
4946
|
+
},
|
|
4947
|
+
"guidedSearchResult": {
|
|
4948
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult",
|
|
4949
|
+
"description": "Guided search result."
|
|
4950
|
+
},
|
|
4951
|
+
"nextPageToken": {
|
|
4952
|
+
"description": "A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
|
|
4953
|
+
"type": "string"
|
|
4954
|
+
},
|
|
4955
|
+
"queryExpansionInfo": {
|
|
4956
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo",
|
|
4957
|
+
"description": "Query expansion information for the returned results."
|
|
4958
|
+
},
|
|
4959
|
+
"redirectUri": {
|
|
4960
|
+
"description": "The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.",
|
|
4961
|
+
"type": "string"
|
|
4962
|
+
},
|
|
4963
|
+
"results": {
|
|
4964
|
+
"description": "A list of matched documents. The order represents the ranking.",
|
|
4965
|
+
"items": {
|
|
4966
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult"
|
|
4967
|
+
},
|
|
4968
|
+
"type": "array"
|
|
4969
|
+
},
|
|
4970
|
+
"summary": {
|
|
4971
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary",
|
|
4972
|
+
"description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set."
|
|
4973
|
+
},
|
|
4974
|
+
"totalSize": {
|
|
4975
|
+
"description": "The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.",
|
|
4976
|
+
"format": "int32",
|
|
4977
|
+
"type": "integer"
|
|
4978
|
+
}
|
|
4979
|
+
},
|
|
4980
|
+
"type": "object"
|
|
4981
|
+
},
|
|
4982
|
+
"GoogleCloudDiscoveryengineV1betaSearchResponseFacet": {
|
|
4983
|
+
"description": "A facet result.",
|
|
4984
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseFacet",
|
|
4985
|
+
"properties": {
|
|
4986
|
+
"dynamicFacet": {
|
|
4987
|
+
"description": "Whether the facet is dynamically generated.",
|
|
4988
|
+
"type": "boolean"
|
|
4989
|
+
},
|
|
4990
|
+
"key": {
|
|
4991
|
+
"description": "The key for this facet. E.g., \"colors\" or \"price\". It matches SearchRequest.FacetSpec.FacetKey.key.",
|
|
4992
|
+
"type": "string"
|
|
4993
|
+
},
|
|
4994
|
+
"values": {
|
|
4995
|
+
"description": "The facet values for this field.",
|
|
4996
|
+
"items": {
|
|
4997
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue"
|
|
4998
|
+
},
|
|
4999
|
+
"type": "array"
|
|
5000
|
+
}
|
|
5001
|
+
},
|
|
5002
|
+
"type": "object"
|
|
5003
|
+
},
|
|
5004
|
+
"GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue": {
|
|
5005
|
+
"description": "A facet value which contains value names and their count.",
|
|
5006
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue",
|
|
5007
|
+
"properties": {
|
|
5008
|
+
"count": {
|
|
5009
|
+
"description": "Number of items that have this facet value.",
|
|
5010
|
+
"format": "int64",
|
|
5011
|
+
"type": "string"
|
|
5012
|
+
},
|
|
5013
|
+
"interval": {
|
|
5014
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaInterval",
|
|
5015
|
+
"description": "Interval value for a facet, such as 10, 20) for facet \"price\". It matches [SearchRequest.FacetSpec.FacetKey.intervals."
|
|
5016
|
+
},
|
|
5017
|
+
"value": {
|
|
5018
|
+
"description": "Text value of a facet, such as \"Black\" for facet \"colors\".",
|
|
5019
|
+
"type": "string"
|
|
5020
|
+
}
|
|
5021
|
+
},
|
|
5022
|
+
"type": "object"
|
|
5023
|
+
},
|
|
5024
|
+
"GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult": {
|
|
5025
|
+
"description": "Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.",
|
|
5026
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult",
|
|
5027
|
+
"properties": {
|
|
5028
|
+
"followUpQuestions": {
|
|
5029
|
+
"description": "Suggested follow-up questions.",
|
|
5030
|
+
"items": {
|
|
5031
|
+
"type": "string"
|
|
5032
|
+
},
|
|
5033
|
+
"type": "array"
|
|
5034
|
+
},
|
|
5035
|
+
"refinementAttributes": {
|
|
5036
|
+
"description": "A list of ranked refinement attributes.",
|
|
5037
|
+
"items": {
|
|
5038
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute"
|
|
5039
|
+
},
|
|
5040
|
+
"type": "array"
|
|
5041
|
+
}
|
|
5042
|
+
},
|
|
5043
|
+
"type": "object"
|
|
5044
|
+
},
|
|
5045
|
+
"GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute": {
|
|
5046
|
+
"description": "Useful attribute for search result refinements.",
|
|
5047
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute",
|
|
5048
|
+
"properties": {
|
|
5049
|
+
"attributeKey": {
|
|
5050
|
+
"description": "Attribute key used to refine the results e.g. 'movie_type'.",
|
|
5051
|
+
"type": "string"
|
|
5052
|
+
},
|
|
5053
|
+
"attributeValue": {
|
|
5054
|
+
"description": "Attribute value used to refine the results e.g. 'drama'.",
|
|
5055
|
+
"type": "string"
|
|
5056
|
+
}
|
|
5057
|
+
},
|
|
5058
|
+
"type": "object"
|
|
5059
|
+
},
|
|
5060
|
+
"GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo": {
|
|
5061
|
+
"description": "Information describing query expansion including whether expansion has occurred.",
|
|
5062
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo",
|
|
5063
|
+
"properties": {
|
|
5064
|
+
"expandedQuery": {
|
|
5065
|
+
"description": "Bool describing whether query expansion has occurred.",
|
|
5066
|
+
"type": "boolean"
|
|
5067
|
+
},
|
|
5068
|
+
"pinnedResultCount": {
|
|
5069
|
+
"description": "Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.",
|
|
5070
|
+
"format": "int64",
|
|
5071
|
+
"type": "string"
|
|
5072
|
+
}
|
|
5073
|
+
},
|
|
5074
|
+
"type": "object"
|
|
5075
|
+
},
|
|
5076
|
+
"GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult": {
|
|
5077
|
+
"description": "Represents the search results.",
|
|
5078
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult",
|
|
5079
|
+
"properties": {
|
|
5080
|
+
"document": {
|
|
5081
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaDocument",
|
|
5082
|
+
"description": "The document data snippet in the search response. Only fields that are marked as retrievable are populated."
|
|
5083
|
+
},
|
|
5084
|
+
"id": {
|
|
5085
|
+
"description": "Document.id of the searched Document.",
|
|
5086
|
+
"type": "string"
|
|
5087
|
+
},
|
|
5088
|
+
"modelScores": {
|
|
5089
|
+
"additionalProperties": {
|
|
5090
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaDoubleList"
|
|
5091
|
+
},
|
|
5092
|
+
"description": "Google provided available scores.",
|
|
5093
|
+
"type": "object"
|
|
5094
|
+
}
|
|
5095
|
+
},
|
|
5096
|
+
"type": "object"
|
|
5097
|
+
},
|
|
5098
|
+
"GoogleCloudDiscoveryengineV1betaSearchResponseSummary": {
|
|
5099
|
+
"description": "Summary of the top N search result specified by the summary spec.",
|
|
5100
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary",
|
|
5101
|
+
"properties": {
|
|
5102
|
+
"safetyAttributes": {
|
|
5103
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes",
|
|
5104
|
+
"description": "A collection of Safety Attribute categories and their associated confidence scores."
|
|
5105
|
+
},
|
|
5106
|
+
"summarySkippedReasons": {
|
|
5107
|
+
"description": "Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.",
|
|
5108
|
+
"items": {
|
|
5109
|
+
"enum": [
|
|
5110
|
+
"SUMMARY_SKIPPED_REASON_UNSPECIFIED",
|
|
5111
|
+
"ADVERSARIAL_QUERY_IGNORED",
|
|
5112
|
+
"NON_SUMMARY_SEEKING_QUERY_IGNORED",
|
|
5113
|
+
"OUT_OF_DOMAIN_QUERY_IGNORED",
|
|
5114
|
+
"POTENTIAL_POLICY_VIOLATION",
|
|
5115
|
+
"LLM_ADDON_NOT_ENABLED"
|
|
5116
|
+
],
|
|
5117
|
+
"enumDescriptions": [
|
|
5118
|
+
"Default value. The summary skipped reason is not specified.",
|
|
5119
|
+
"The adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to `true`.",
|
|
5120
|
+
"The non-summary seeking query ignored case. Only populated when SummarySpec.ignore_non_summary_seeking_query is set to `true`.",
|
|
5121
|
+
"The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.",
|
|
5122
|
+
"The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.",
|
|
5123
|
+
"The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled."
|
|
5124
|
+
],
|
|
5125
|
+
"type": "string"
|
|
5126
|
+
},
|
|
5127
|
+
"type": "array"
|
|
5128
|
+
},
|
|
5129
|
+
"summaryText": {
|
|
5130
|
+
"description": "The summary content.",
|
|
5131
|
+
"type": "string"
|
|
5132
|
+
}
|
|
5133
|
+
},
|
|
5134
|
+
"type": "object"
|
|
5135
|
+
},
|
|
5136
|
+
"GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes": {
|
|
5137
|
+
"description": "Safety Attribute categories and their associated confidence scores.",
|
|
5138
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes",
|
|
5139
|
+
"properties": {
|
|
5140
|
+
"categories": {
|
|
5141
|
+
"description": "The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.",
|
|
5142
|
+
"items": {
|
|
5143
|
+
"type": "string"
|
|
5144
|
+
},
|
|
5145
|
+
"type": "array"
|
|
5146
|
+
},
|
|
5147
|
+
"scores": {
|
|
5148
|
+
"description": "The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.",
|
|
5149
|
+
"items": {
|
|
5150
|
+
"format": "float",
|
|
5151
|
+
"type": "number"
|
|
5152
|
+
},
|
|
5153
|
+
"type": "array"
|
|
5154
|
+
}
|
|
5155
|
+
},
|
|
5156
|
+
"type": "object"
|
|
5157
|
+
},
|
|
5158
|
+
"GoogleCloudDiscoveryengineV1betaTextInput": {
|
|
5159
|
+
"description": "Defines text input.",
|
|
5160
|
+
"id": "GoogleCloudDiscoveryengineV1betaTextInput",
|
|
5161
|
+
"properties": {
|
|
5162
|
+
"context": {
|
|
5163
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaConversationContext",
|
|
5164
|
+
"description": "Conversation context of the input."
|
|
5165
|
+
},
|
|
5166
|
+
"input": {
|
|
5167
|
+
"description": "Text input.",
|
|
5168
|
+
"type": "string"
|
|
5169
|
+
}
|
|
5170
|
+
},
|
|
5171
|
+
"type": "object"
|
|
5172
|
+
},
|
|
3083
5173
|
"GoogleCloudDiscoveryengineV1betaTransactionInfo": {
|
|
3084
5174
|
"description": "A transaction represents the entire purchase transaction.",
|
|
3085
5175
|
"id": "GoogleCloudDiscoveryengineV1betaTransactionInfo",
|
|
@@ -3115,6 +5205,23 @@
|
|
|
3115
5205
|
},
|
|
3116
5206
|
"type": "object"
|
|
3117
5207
|
},
|
|
5208
|
+
"GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata": {
|
|
5209
|
+
"description": "Metadata for UpdateSchema LRO.",
|
|
5210
|
+
"id": "GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata",
|
|
5211
|
+
"properties": {
|
|
5212
|
+
"createTime": {
|
|
5213
|
+
"description": "Operation create time.",
|
|
5214
|
+
"format": "google-datetime",
|
|
5215
|
+
"type": "string"
|
|
5216
|
+
},
|
|
5217
|
+
"updateTime": {
|
|
5218
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
5219
|
+
"format": "google-datetime",
|
|
5220
|
+
"type": "string"
|
|
5221
|
+
}
|
|
5222
|
+
},
|
|
5223
|
+
"type": "object"
|
|
5224
|
+
},
|
|
3118
5225
|
"GoogleCloudDiscoveryengineV1betaUserEvent": {
|
|
3119
5226
|
"description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.",
|
|
3120
5227
|
"id": "GoogleCloudDiscoveryengineV1betaUserEvent",
|