google-api-python-client 2.124.0__py2.py3-none-any.whl → 2.126.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.124.0.dist-info → google_api_python_client-2.126.0.dist-info}/METADATA +3 -3
- {google_api_python_client-2.124.0.dist-info → google_api_python_client-2.126.0.dist-info}/RECORD +381 -375
- googleapiclient/discovery_cache/documents/abusiveexperiencereport.v1.json +1 -1
- googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json +1 -1
- googleapiclient/discovery_cache/documents/accessapproval.v1.json +1 -1
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +1 -1
- googleapiclient/discovery_cache/documents/acmedns.v1.json +1 -1
- googleapiclient/discovery_cache/documents/addressvalidation.v1.json +834 -0
- googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +1 -1
- googleapiclient/discovery_cache/documents/adexperiencereport.v1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.datatransferv1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.directory_v1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.reports_v1.json +1 -1
- googleapiclient/discovery_cache/documents/admin.reportsv1.json +1 -1
- googleapiclient/discovery_cache/documents/admob.v1.json +1 -1
- googleapiclient/discovery_cache/documents/admob.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/adsense.v2.json +1 -1
- googleapiclient/discovery_cache/documents/advisorynotifications.v1.json +61 -6
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +870 -82
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +2588 -176
- googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +13 -1
- googleapiclient/discovery_cache/documents/alloydb.v1.json +1 -1
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +19 -44
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +19 -44
- googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +250 -1
- googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +250 -1
- googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +1 -1
- googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +1 -1
- googleapiclient/discovery_cache/documents/androidenterprise.v1.json +2 -2
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +9 -8
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +32 -6
- googleapiclient/discovery_cache/documents/apigee.v1.json +1 -1
- googleapiclient/discovery_cache/documents/apikeys.v2.json +1 -1
- googleapiclient/discovery_cache/documents/appengine.v1.json +1 -1
- googleapiclient/discovery_cache/documents/appengine.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/appengine.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/apphub.v1.json +1 -1
- googleapiclient/discovery_cache/documents/apphub.v1alpha.json +7 -4
- googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/artifactregistry.v1.json +5 -3
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +9 -5
- googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +9 -5
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +1 -1
- googleapiclient/discovery_cache/documents/backupdr.v1.json +1 -1
- googleapiclient/discovery_cache/documents/batch.v1.json +4 -4
- googleapiclient/discovery_cache/documents/beyondcorp.v1.json +1 -1
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +188 -192
- googleapiclient/discovery_cache/documents/biglake.v1.json +1 -1
- googleapiclient/discovery_cache/documents/bigquery.v2.json +263 -2
- googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json +27 -1
- googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json +1 -1
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +1 -1
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +97 -1
- googleapiclient/discovery_cache/documents/billingbudgets.v1.json +1 -1
- googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +1 -1
- googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/blockchainnodeengine.v1.json +9 -2
- googleapiclient/discovery_cache/documents/blogger.v2.json +1 -1
- googleapiclient/discovery_cache/documents/blogger.v3.json +1 -1
- googleapiclient/discovery_cache/documents/books.v1.json +1 -1
- googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +1 -1
- googleapiclient/discovery_cache/documents/calendar.v3.json +3 -3
- googleapiclient/discovery_cache/documents/certificatemanager.v1.json +1 -1
- googleapiclient/discovery_cache/documents/chat.v1.json +577 -131
- googleapiclient/discovery_cache/documents/checks.v1alpha.json +11 -3
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +1 -1
- googleapiclient/discovery_cache/documents/chromepolicy.v1.json +1 -1
- googleapiclient/discovery_cache/documents/chromeuxreport.v1.json +1 -1
- googleapiclient/discovery_cache/documents/civicinfo.v2.json +1 -1
- googleapiclient/discovery_cache/documents/classroom.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudbilling.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/cloudchannel.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json +1284 -0
- googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json +1284 -0
- googleapiclient/discovery_cache/documents/clouddeploy.v1.json +1 -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 +3 -3
- googleapiclient/discovery_cache/documents/cloudprofiler.v2.json +3 -3
- googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudshell.v1.json +1 -1
- googleapiclient/discovery_cache/documents/cloudsupport.v2.json +8 -7
- googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +8 -7
- 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 +474 -8
- googleapiclient/discovery_cache/documents/compute.beta.json +36 -8
- googleapiclient/discovery_cache/documents/compute.v1.json +133 -12
- googleapiclient/discovery_cache/documents/connectors.v1.json +2 -2
- googleapiclient/discovery_cache/documents/connectors.v2.json +1 -1
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +1 -1
- googleapiclient/discovery_cache/documents/container.v1.json +112 -4
- googleapiclient/discovery_cache/documents/container.v1beta1.json +160 -4
- googleapiclient/discovery_cache/documents/containeranalysis.v1.json +1 -1
- googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/content.v2.1.json +446 -16
- googleapiclient/discovery_cache/documents/contentwarehouse.v1.json +5517 -3919
- googleapiclient/discovery_cache/documents/customsearch.v1.json +1 -13
- googleapiclient/discovery_cache/documents/datacatalog.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/dataflow.v1b3.json +1 -1
- googleapiclient/discovery_cache/documents/dataform.v1beta1.json +3 -4
- googleapiclient/discovery_cache/documents/datalineage.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datamigration.v1.json +21 -2
- 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 +23 -2
- googleapiclient/discovery_cache/documents/dataportability.v1.json +1 -15
- googleapiclient/discovery_cache/documents/dataportability.v1beta.json +1 -15
- googleapiclient/discovery_cache/documents/dataproc.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datastore.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datastore.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/datastore.v1beta3.json +1 -1
- googleapiclient/discovery_cache/documents/datastream.v1.json +1 -1
- googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +1 -1
- googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +1 -1
- googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +1 -1
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +1 -1
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +1 -1
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +27 -1
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +27 -1
- googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +1 -1
- googleapiclient/discovery_cache/documents/discovery.v1.json +4 -0
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +10732 -0
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +2880 -227
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +4054 -1086
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +13 -1
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +15 -1
- googleapiclient/discovery_cache/documents/dlp.v2.json +676 -2
- googleapiclient/discovery_cache/documents/dns.v1.json +1 -1
- googleapiclient/discovery_cache/documents/dns.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/docs.v1.json +1 -1
- googleapiclient/discovery_cache/documents/documentai.v1.json +4 -3
- googleapiclient/discovery_cache/documents/documentai.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +4 -3
- googleapiclient/discovery_cache/documents/domains.v1.json +2 -2
- googleapiclient/discovery_cache/documents/domains.v1alpha2.json +17 -2
- googleapiclient/discovery_cache/documents/domains.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/domainsrdap.v1.json +1 -1
- googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json +1 -1
- googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json +1 -1
- googleapiclient/discovery_cache/documents/drive.v2.json +1 -1
- googleapiclient/discovery_cache/documents/drive.v3.json +2 -2
- 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 +70 -1
- googleapiclient/discovery_cache/documents/fcm.v1.json +1 -1
- googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/firebase.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebasehosting.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseml.v1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +1156 -0
- googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/firestore.v1.json +41 -1
- googleapiclient/discovery_cache/documents/firestore.v1beta1.json +41 -1
- googleapiclient/discovery_cache/documents/firestore.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/fitness.v1.json +1 -1
- googleapiclient/discovery_cache/documents/forms.v1.json +1 -1
- googleapiclient/discovery_cache/documents/games.v1.json +1 -1
- googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json +1 -1
- googleapiclient/discovery_cache/documents/gamesManagement.v1management.json +1 -1
- googleapiclient/discovery_cache/documents/gkebackup.v1.json +187 -1
- googleapiclient/discovery_cache/documents/gkehub.v1.json +64 -1
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +81 -1
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +64 -1
- googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +1 -1
- googleapiclient/discovery_cache/documents/gmail.v1.json +1 -1
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +1 -1
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/groupsmigration.v1.json +1 -1
- googleapiclient/discovery_cache/documents/healthcare.v1.json +1 -1
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +1 -1
- 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 +1 -1
- googleapiclient/discovery_cache/documents/iap.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +1 -1
- googleapiclient/discovery_cache/documents/identitytoolkit.v2.json +1 -1
- googleapiclient/discovery_cache/documents/indexing.v3.json +1 -1
- googleapiclient/discovery_cache/documents/integrations.v1alpha.json +50 -6
- googleapiclient/discovery_cache/documents/keep.v1.json +1 -1
- googleapiclient/discovery_cache/documents/kgsearch.v1.json +1 -1
- googleapiclient/discovery_cache/documents/kmsinventory.v1.json +1 -1
- googleapiclient/discovery_cache/documents/language.v1.json +1 -1
- googleapiclient/discovery_cache/documents/language.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/language.v2.json +1 -1
- googleapiclient/discovery_cache/documents/libraryagent.v1.json +1 -1
- googleapiclient/discovery_cache/documents/licensing.v1.json +1 -1
- googleapiclient/discovery_cache/documents/lifesciences.v2beta.json +1 -1
- googleapiclient/discovery_cache/documents/localservices.v1.json +1 -1
- googleapiclient/discovery_cache/documents/logging.v2.json +1 -1
- googleapiclient/discovery_cache/documents/looker.v1.json +1 -1
- googleapiclient/discovery_cache/documents/manufacturers.v1.json +1 -1
- googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json +44 -1
- googleapiclient/discovery_cache/documents/metastore.v1.json +2 -2
- googleapiclient/discovery_cache/documents/metastore.v1alpha.json +430 -2
- googleapiclient/discovery_cache/documents/metastore.v1beta.json +430 -2
- googleapiclient/discovery_cache/documents/migrationcenter.v1.json +378 -3
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +387 -12
- googleapiclient/discovery_cache/documents/monitoring.v1.json +1 -1
- googleapiclient/discovery_cache/documents/monitoring.v3.json +26 -3
- 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/networkmanagement.v1.json +2 -2
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +1 -1
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/networkservices.v1.json +1 -1
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/notebooks.v1.json +1 -1
- googleapiclient/discovery_cache/documents/notebooks.v2.json +1 -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 +56 -1
- googleapiclient/discovery_cache/documents/osconfig.v1.json +10 -10
- googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/osconfig.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/oslogin.v1.json +1 -1
- googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/oslogin.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/pagespeedonline.v5.json +1 -1
- googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +7 -2
- googleapiclient/discovery_cache/documents/people.v1.json +1 -1
- googleapiclient/discovery_cache/documents/places.v1.json +4 -4
- googleapiclient/discovery_cache/documents/playcustomapp.v1.json +1 -1
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/playintegrity.v1.json +1 -1
- googleapiclient/discovery_cache/documents/policyanalyzer.v1.json +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 +1 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json +1 -1
- googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/privateca.v1.json +1 -1
- googleapiclient/discovery_cache/documents/privateca.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json +1 -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 +5 -1
- googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +1 -1
- googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/pubsublite.v1.json +1 -1
- googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json +1 -1
- googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json +1 -1
- googleapiclient/discovery_cache/documents/realtimebidding.v1.json +1 -1
- googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +15 -1
- googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/recommender.v1.json +3 -3
- googleapiclient/discovery_cache/documents/recommender.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/redis.v1.json +25 -1
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +25 -1
- 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 +6 -2
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +6 -2
- googleapiclient/discovery_cache/documents/retail.v2beta.json +6 -2
- googleapiclient/discovery_cache/documents/run.v1.json +2 -2
- googleapiclient/discovery_cache/documents/run.v2.json +290 -5
- googleapiclient/discovery_cache/documents/safebrowsing.v4.json +1 -1
- googleapiclient/discovery_cache/documents/safebrowsing.v5.json +6 -6
- googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/script.v1.json +1 -1
- googleapiclient/discovery_cache/documents/searchads360.v0.json +273 -26
- googleapiclient/discovery_cache/documents/searchconsole.v1.json +1 -1
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +821 -6
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +765 -6
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +765 -6
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +1 -1
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/servicecontrol.v1.json +1 -1
- googleapiclient/discovery_cache/documents/servicecontrol.v2.json +11 -2
- googleapiclient/discovery_cache/documents/servicemanagement.v1.json +1 -1
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +3 -3
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +1 -1
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/sheets.v4.json +5 -3
- googleapiclient/discovery_cache/documents/slides.v1.json +1 -1
- googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json +1 -1
- googleapiclient/discovery_cache/documents/solar.v1.json +926 -0
- googleapiclient/discovery_cache/documents/sourcerepo.v1.json +1 -1
- googleapiclient/discovery_cache/documents/spanner.v1.json +41 -1
- googleapiclient/discovery_cache/documents/speech.v1.json +1 -1
- googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +18 -3
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +19 -4
- googleapiclient/discovery_cache/documents/storage.v1.json +2 -2
- googleapiclient/discovery_cache/documents/storagetransfer.v1.json +5 -5
- googleapiclient/discovery_cache/documents/streetviewpublish.v1.json +1 -1
- googleapiclient/discovery_cache/documents/sts.v1.json +1 -1
- googleapiclient/discovery_cache/documents/sts.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/tagmanager.v1.json +1 -1
- googleapiclient/discovery_cache/documents/tagmanager.v2.json +1 -1
- googleapiclient/discovery_cache/documents/tasks.v1.json +1 -1
- googleapiclient/discovery_cache/documents/testing.v1.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 +5 -3
- googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/trafficdirector.v2.json +1 -1
- googleapiclient/discovery_cache/documents/trafficdirector.v3.json +25 -2
- googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +1 -1
- googleapiclient/discovery_cache/documents/vault.v1.json +1 -1
- googleapiclient/discovery_cache/documents/verifiedaccess.v1.json +1 -1
- googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +5 -1
- googleapiclient/discovery_cache/documents/versionhistory.v1.json +23 -21
- googleapiclient/discovery_cache/documents/videointelligence.v1.json +1 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json +1 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json +1 -1
- googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.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 +1 -1
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +1 -1
- googleapiclient/discovery_cache/documents/vpcaccess.v1.json +1 -1
- googleapiclient/discovery_cache/documents/walletobjects.v1.json +1 -1
- googleapiclient/discovery_cache/documents/webfonts.v1.json +1 -1
- googleapiclient/discovery_cache/documents/webrisk.v1.json +1 -1
- googleapiclient/discovery_cache/documents/websecurityscanner.v1.json +1 -1
- googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json +1 -1
- googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +1 -1
- googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/workflows.v1.json +1 -1
- googleapiclient/discovery_cache/documents/workflows.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/workspaceevents.v1.json +2 -2
- googleapiclient/discovery_cache/documents/workstations.v1.json +1 -1
- googleapiclient/discovery_cache/documents/workstations.v1beta.json +8 -1
- googleapiclient/discovery_cache/documents/youtube.v3.json +3 -1
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.124.0.dist-info → google_api_python_client-2.126.0.dist-info}/LICENSE +0 -0
- {google_api_python_client-2.124.0.dist-info → google_api_python_client-2.126.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.124.0.dist-info → google_api_python_client-2.126.0.dist-info}/top_level.txt +0 -0
|
@@ -222,6 +222,89 @@
|
|
|
222
222
|
}
|
|
223
223
|
},
|
|
224
224
|
"projects": {
|
|
225
|
+
"methods": {
|
|
226
|
+
"get": {
|
|
227
|
+
"description": "Gets a Project. Returns NOT_FOUND when the project is not yet created.",
|
|
228
|
+
"flatPath": "v1alpha/projects/{projectsId}",
|
|
229
|
+
"httpMethod": "GET",
|
|
230
|
+
"id": "discoveryengine.projects.get",
|
|
231
|
+
"parameterOrder": [
|
|
232
|
+
"name"
|
|
233
|
+
],
|
|
234
|
+
"parameters": {
|
|
235
|
+
"name": {
|
|
236
|
+
"description": "Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.",
|
|
237
|
+
"location": "path",
|
|
238
|
+
"pattern": "^projects/[^/]+$",
|
|
239
|
+
"required": true,
|
|
240
|
+
"type": "string"
|
|
241
|
+
}
|
|
242
|
+
},
|
|
243
|
+
"path": "v1alpha/{+name}",
|
|
244
|
+
"response": {
|
|
245
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaProject"
|
|
246
|
+
},
|
|
247
|
+
"scopes": [
|
|
248
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
249
|
+
]
|
|
250
|
+
},
|
|
251
|
+
"provision": {
|
|
252
|
+
"description": "Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.",
|
|
253
|
+
"flatPath": "v1alpha/projects/{projectsId}:provision",
|
|
254
|
+
"httpMethod": "POST",
|
|
255
|
+
"id": "discoveryengine.projects.provision",
|
|
256
|
+
"parameterOrder": [
|
|
257
|
+
"name"
|
|
258
|
+
],
|
|
259
|
+
"parameters": {
|
|
260
|
+
"name": {
|
|
261
|
+
"description": "Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.",
|
|
262
|
+
"location": "path",
|
|
263
|
+
"pattern": "^projects/[^/]+$",
|
|
264
|
+
"required": true,
|
|
265
|
+
"type": "string"
|
|
266
|
+
}
|
|
267
|
+
},
|
|
268
|
+
"path": "v1alpha/{+name}:provision",
|
|
269
|
+
"request": {
|
|
270
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest"
|
|
271
|
+
},
|
|
272
|
+
"response": {
|
|
273
|
+
"$ref": "GoogleLongrunningOperation"
|
|
274
|
+
},
|
|
275
|
+
"scopes": [
|
|
276
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
277
|
+
]
|
|
278
|
+
},
|
|
279
|
+
"reportConsentChange": {
|
|
280
|
+
"description": "Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms)",
|
|
281
|
+
"flatPath": "v1alpha/projects/{projectsId}:reportConsentChange",
|
|
282
|
+
"httpMethod": "POST",
|
|
283
|
+
"id": "discoveryengine.projects.reportConsentChange",
|
|
284
|
+
"parameterOrder": [
|
|
285
|
+
"project"
|
|
286
|
+
],
|
|
287
|
+
"parameters": {
|
|
288
|
+
"project": {
|
|
289
|
+
"description": "Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.",
|
|
290
|
+
"location": "path",
|
|
291
|
+
"pattern": "^projects/[^/]+$",
|
|
292
|
+
"required": true,
|
|
293
|
+
"type": "string"
|
|
294
|
+
}
|
|
295
|
+
},
|
|
296
|
+
"path": "v1alpha/{+project}:reportConsentChange",
|
|
297
|
+
"request": {
|
|
298
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest"
|
|
299
|
+
},
|
|
300
|
+
"response": {
|
|
301
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaProject"
|
|
302
|
+
},
|
|
303
|
+
"scopes": [
|
|
304
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
305
|
+
]
|
|
306
|
+
}
|
|
307
|
+
},
|
|
225
308
|
"resources": {
|
|
226
309
|
"locations": {
|
|
227
310
|
"methods": {
|
|
@@ -1284,7 +1367,7 @@
|
|
|
1284
1367
|
],
|
|
1285
1368
|
"parameters": {
|
|
1286
1369
|
"name": {
|
|
1287
|
-
"description": "Immutable. Fully qualified name `project
|
|
1370
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.",
|
|
1288
1371
|
"location": "path",
|
|
1289
1372
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
|
|
1290
1373
|
"required": true,
|
|
@@ -1684,6 +1767,34 @@
|
|
|
1684
1767
|
},
|
|
1685
1768
|
"servingConfigs": {
|
|
1686
1769
|
"methods": {
|
|
1770
|
+
"answer": {
|
|
1771
|
+
"description": "Answer query method.",
|
|
1772
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer",
|
|
1773
|
+
"httpMethod": "POST",
|
|
1774
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.answer",
|
|
1775
|
+
"parameterOrder": [
|
|
1776
|
+
"servingConfig"
|
|
1777
|
+
],
|
|
1778
|
+
"parameters": {
|
|
1779
|
+
"servingConfig": {
|
|
1780
|
+
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
|
|
1781
|
+
"location": "path",
|
|
1782
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
1783
|
+
"required": true,
|
|
1784
|
+
"type": "string"
|
|
1785
|
+
}
|
|
1786
|
+
},
|
|
1787
|
+
"path": "v1alpha/{+servingConfig}:answer",
|
|
1788
|
+
"request": {
|
|
1789
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest"
|
|
1790
|
+
},
|
|
1791
|
+
"response": {
|
|
1792
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse"
|
|
1793
|
+
},
|
|
1794
|
+
"scopes": [
|
|
1795
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1796
|
+
]
|
|
1797
|
+
},
|
|
1687
1798
|
"get": {
|
|
1688
1799
|
"description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.",
|
|
1689
1800
|
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
|
|
@@ -1837,6 +1948,199 @@
|
|
|
1837
1948
|
}
|
|
1838
1949
|
}
|
|
1839
1950
|
},
|
|
1951
|
+
"sessions": {
|
|
1952
|
+
"methods": {
|
|
1953
|
+
"create": {
|
|
1954
|
+
"description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.",
|
|
1955
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions",
|
|
1956
|
+
"httpMethod": "POST",
|
|
1957
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.sessions.create",
|
|
1958
|
+
"parameterOrder": [
|
|
1959
|
+
"parent"
|
|
1960
|
+
],
|
|
1961
|
+
"parameters": {
|
|
1962
|
+
"parent": {
|
|
1963
|
+
"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`",
|
|
1964
|
+
"location": "path",
|
|
1965
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
1966
|
+
"required": true,
|
|
1967
|
+
"type": "string"
|
|
1968
|
+
}
|
|
1969
|
+
},
|
|
1970
|
+
"path": "v1alpha/{+parent}/sessions",
|
|
1971
|
+
"request": {
|
|
1972
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
1973
|
+
},
|
|
1974
|
+
"response": {
|
|
1975
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
1976
|
+
},
|
|
1977
|
+
"scopes": [
|
|
1978
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1979
|
+
]
|
|
1980
|
+
},
|
|
1981
|
+
"delete": {
|
|
1982
|
+
"description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.",
|
|
1983
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}",
|
|
1984
|
+
"httpMethod": "DELETE",
|
|
1985
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.sessions.delete",
|
|
1986
|
+
"parameterOrder": [
|
|
1987
|
+
"name"
|
|
1988
|
+
],
|
|
1989
|
+
"parameters": {
|
|
1990
|
+
"name": {
|
|
1991
|
+
"description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
1992
|
+
"location": "path",
|
|
1993
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$",
|
|
1994
|
+
"required": true,
|
|
1995
|
+
"type": "string"
|
|
1996
|
+
}
|
|
1997
|
+
},
|
|
1998
|
+
"path": "v1alpha/{+name}",
|
|
1999
|
+
"response": {
|
|
2000
|
+
"$ref": "GoogleProtobufEmpty"
|
|
2001
|
+
},
|
|
2002
|
+
"scopes": [
|
|
2003
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2004
|
+
]
|
|
2005
|
+
},
|
|
2006
|
+
"get": {
|
|
2007
|
+
"description": "Gets a Session.",
|
|
2008
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}",
|
|
2009
|
+
"httpMethod": "GET",
|
|
2010
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.sessions.get",
|
|
2011
|
+
"parameterOrder": [
|
|
2012
|
+
"name"
|
|
2013
|
+
],
|
|
2014
|
+
"parameters": {
|
|
2015
|
+
"name": {
|
|
2016
|
+
"description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
2017
|
+
"location": "path",
|
|
2018
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$",
|
|
2019
|
+
"required": true,
|
|
2020
|
+
"type": "string"
|
|
2021
|
+
}
|
|
2022
|
+
},
|
|
2023
|
+
"path": "v1alpha/{+name}",
|
|
2024
|
+
"response": {
|
|
2025
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
2026
|
+
},
|
|
2027
|
+
"scopes": [
|
|
2028
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2029
|
+
]
|
|
2030
|
+
},
|
|
2031
|
+
"list": {
|
|
2032
|
+
"description": "Lists all Sessions by their parent DataStore.",
|
|
2033
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions",
|
|
2034
|
+
"httpMethod": "GET",
|
|
2035
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.sessions.list",
|
|
2036
|
+
"parameterOrder": [
|
|
2037
|
+
"parent"
|
|
2038
|
+
],
|
|
2039
|
+
"parameters": {
|
|
2040
|
+
"filter": {
|
|
2041
|
+
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
|
|
2042
|
+
"location": "query",
|
|
2043
|
+
"type": "string"
|
|
2044
|
+
},
|
|
2045
|
+
"orderBy": {
|
|
2046
|
+
"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` * `session_name` Example: \"update_time desc\" \"create_time\"",
|
|
2047
|
+
"location": "query",
|
|
2048
|
+
"type": "string"
|
|
2049
|
+
},
|
|
2050
|
+
"pageSize": {
|
|
2051
|
+
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
2052
|
+
"format": "int32",
|
|
2053
|
+
"location": "query",
|
|
2054
|
+
"type": "integer"
|
|
2055
|
+
},
|
|
2056
|
+
"pageToken": {
|
|
2057
|
+
"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.",
|
|
2058
|
+
"location": "query",
|
|
2059
|
+
"type": "string"
|
|
2060
|
+
},
|
|
2061
|
+
"parent": {
|
|
2062
|
+
"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`",
|
|
2063
|
+
"location": "path",
|
|
2064
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
2065
|
+
"required": true,
|
|
2066
|
+
"type": "string"
|
|
2067
|
+
}
|
|
2068
|
+
},
|
|
2069
|
+
"path": "v1alpha/{+parent}/sessions",
|
|
2070
|
+
"response": {
|
|
2071
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse"
|
|
2072
|
+
},
|
|
2073
|
+
"scopes": [
|
|
2074
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2075
|
+
]
|
|
2076
|
+
},
|
|
2077
|
+
"patch": {
|
|
2078
|
+
"description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.",
|
|
2079
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}",
|
|
2080
|
+
"httpMethod": "PATCH",
|
|
2081
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.sessions.patch",
|
|
2082
|
+
"parameterOrder": [
|
|
2083
|
+
"name"
|
|
2084
|
+
],
|
|
2085
|
+
"parameters": {
|
|
2086
|
+
"name": {
|
|
2087
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
|
|
2088
|
+
"location": "path",
|
|
2089
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$",
|
|
2090
|
+
"required": true,
|
|
2091
|
+
"type": "string"
|
|
2092
|
+
},
|
|
2093
|
+
"updateMask": {
|
|
2094
|
+
"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.",
|
|
2095
|
+
"format": "google-fieldmask",
|
|
2096
|
+
"location": "query",
|
|
2097
|
+
"type": "string"
|
|
2098
|
+
}
|
|
2099
|
+
},
|
|
2100
|
+
"path": "v1alpha/{+name}",
|
|
2101
|
+
"request": {
|
|
2102
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
2103
|
+
},
|
|
2104
|
+
"response": {
|
|
2105
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
2106
|
+
},
|
|
2107
|
+
"scopes": [
|
|
2108
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2109
|
+
]
|
|
2110
|
+
}
|
|
2111
|
+
},
|
|
2112
|
+
"resources": {
|
|
2113
|
+
"answers": {
|
|
2114
|
+
"methods": {
|
|
2115
|
+
"get": {
|
|
2116
|
+
"description": "Gets a Answer.",
|
|
2117
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}",
|
|
2118
|
+
"httpMethod": "GET",
|
|
2119
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.sessions.answers.get",
|
|
2120
|
+
"parameterOrder": [
|
|
2121
|
+
"name"
|
|
2122
|
+
],
|
|
2123
|
+
"parameters": {
|
|
2124
|
+
"name": {
|
|
2125
|
+
"description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`",
|
|
2126
|
+
"location": "path",
|
|
2127
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$",
|
|
2128
|
+
"required": true,
|
|
2129
|
+
"type": "string"
|
|
2130
|
+
}
|
|
2131
|
+
},
|
|
2132
|
+
"path": "v1alpha/{+name}",
|
|
2133
|
+
"response": {
|
|
2134
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswer"
|
|
2135
|
+
},
|
|
2136
|
+
"scopes": [
|
|
2137
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2138
|
+
]
|
|
2139
|
+
}
|
|
2140
|
+
}
|
|
2141
|
+
}
|
|
2142
|
+
}
|
|
2143
|
+
},
|
|
1840
2144
|
"siteSearchEngine": {
|
|
1841
2145
|
"methods": {
|
|
1842
2146
|
"batchVerifyTargetSites": {
|
|
@@ -2476,7 +2780,7 @@
|
|
|
2476
2780
|
],
|
|
2477
2781
|
"parameters": {
|
|
2478
2782
|
"parent": {
|
|
2479
|
-
"description": "Required. The parent
|
|
2783
|
+
"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
|
|
2480
2784
|
"location": "path",
|
|
2481
2785
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
2482
2786
|
"required": true,
|
|
@@ -2908,7 +3212,7 @@
|
|
|
2908
3212
|
],
|
|
2909
3213
|
"parameters": {
|
|
2910
3214
|
"name": {
|
|
2911
|
-
"description": "Immutable. Fully qualified name `project
|
|
3215
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.",
|
|
2912
3216
|
"location": "path",
|
|
2913
3217
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$",
|
|
2914
3218
|
"required": true,
|
|
@@ -3006,6 +3310,34 @@
|
|
|
3006
3310
|
},
|
|
3007
3311
|
"servingConfigs": {
|
|
3008
3312
|
"methods": {
|
|
3313
|
+
"answer": {
|
|
3314
|
+
"description": "Answer query method.",
|
|
3315
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:answer",
|
|
3316
|
+
"httpMethod": "POST",
|
|
3317
|
+
"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.answer",
|
|
3318
|
+
"parameterOrder": [
|
|
3319
|
+
"servingConfig"
|
|
3320
|
+
],
|
|
3321
|
+
"parameters": {
|
|
3322
|
+
"servingConfig": {
|
|
3323
|
+
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
|
|
3324
|
+
"location": "path",
|
|
3325
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
|
|
3326
|
+
"required": true,
|
|
3327
|
+
"type": "string"
|
|
3328
|
+
}
|
|
3329
|
+
},
|
|
3330
|
+
"path": "v1alpha/{+servingConfig}:answer",
|
|
3331
|
+
"request": {
|
|
3332
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest"
|
|
3333
|
+
},
|
|
3334
|
+
"response": {
|
|
3335
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse"
|
|
3336
|
+
},
|
|
3337
|
+
"scopes": [
|
|
3338
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3339
|
+
]
|
|
3340
|
+
},
|
|
3009
3341
|
"get": {
|
|
3010
3342
|
"description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.",
|
|
3011
3343
|
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}",
|
|
@@ -3158,8 +3490,201 @@
|
|
|
3158
3490
|
]
|
|
3159
3491
|
}
|
|
3160
3492
|
}
|
|
3493
|
+
},
|
|
3494
|
+
"sessions": {
|
|
3495
|
+
"methods": {
|
|
3496
|
+
"create": {
|
|
3497
|
+
"description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.",
|
|
3498
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions",
|
|
3499
|
+
"httpMethod": "POST",
|
|
3500
|
+
"id": "discoveryengine.projects.locations.collections.engines.sessions.create",
|
|
3501
|
+
"parameterOrder": [
|
|
3502
|
+
"parent"
|
|
3503
|
+
],
|
|
3504
|
+
"parameters": {
|
|
3505
|
+
"parent": {
|
|
3506
|
+
"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`",
|
|
3507
|
+
"location": "path",
|
|
3508
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
|
|
3509
|
+
"required": true,
|
|
3510
|
+
"type": "string"
|
|
3511
|
+
}
|
|
3512
|
+
},
|
|
3513
|
+
"path": "v1alpha/{+parent}/sessions",
|
|
3514
|
+
"request": {
|
|
3515
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
3516
|
+
},
|
|
3517
|
+
"response": {
|
|
3518
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
3519
|
+
},
|
|
3520
|
+
"scopes": [
|
|
3521
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3522
|
+
]
|
|
3523
|
+
},
|
|
3524
|
+
"delete": {
|
|
3525
|
+
"description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.",
|
|
3526
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}",
|
|
3527
|
+
"httpMethod": "DELETE",
|
|
3528
|
+
"id": "discoveryengine.projects.locations.collections.engines.sessions.delete",
|
|
3529
|
+
"parameterOrder": [
|
|
3530
|
+
"name"
|
|
3531
|
+
],
|
|
3532
|
+
"parameters": {
|
|
3533
|
+
"name": {
|
|
3534
|
+
"description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
3535
|
+
"location": "path",
|
|
3536
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$",
|
|
3537
|
+
"required": true,
|
|
3538
|
+
"type": "string"
|
|
3539
|
+
}
|
|
3540
|
+
},
|
|
3541
|
+
"path": "v1alpha/{+name}",
|
|
3542
|
+
"response": {
|
|
3543
|
+
"$ref": "GoogleProtobufEmpty"
|
|
3544
|
+
},
|
|
3545
|
+
"scopes": [
|
|
3546
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3547
|
+
]
|
|
3548
|
+
},
|
|
3549
|
+
"get": {
|
|
3550
|
+
"description": "Gets a Session.",
|
|
3551
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}",
|
|
3552
|
+
"httpMethod": "GET",
|
|
3553
|
+
"id": "discoveryengine.projects.locations.collections.engines.sessions.get",
|
|
3554
|
+
"parameterOrder": [
|
|
3555
|
+
"name"
|
|
3556
|
+
],
|
|
3557
|
+
"parameters": {
|
|
3558
|
+
"name": {
|
|
3559
|
+
"description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
3560
|
+
"location": "path",
|
|
3561
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$",
|
|
3562
|
+
"required": true,
|
|
3563
|
+
"type": "string"
|
|
3564
|
+
}
|
|
3565
|
+
},
|
|
3566
|
+
"path": "v1alpha/{+name}",
|
|
3567
|
+
"response": {
|
|
3568
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
3569
|
+
},
|
|
3570
|
+
"scopes": [
|
|
3571
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3572
|
+
]
|
|
3573
|
+
},
|
|
3574
|
+
"list": {
|
|
3575
|
+
"description": "Lists all Sessions by their parent DataStore.",
|
|
3576
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions",
|
|
3577
|
+
"httpMethod": "GET",
|
|
3578
|
+
"id": "discoveryengine.projects.locations.collections.engines.sessions.list",
|
|
3579
|
+
"parameterOrder": [
|
|
3580
|
+
"parent"
|
|
3581
|
+
],
|
|
3582
|
+
"parameters": {
|
|
3583
|
+
"filter": {
|
|
3584
|
+
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
|
|
3585
|
+
"location": "query",
|
|
3586
|
+
"type": "string"
|
|
3587
|
+
},
|
|
3588
|
+
"orderBy": {
|
|
3589
|
+
"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` * `session_name` Example: \"update_time desc\" \"create_time\"",
|
|
3590
|
+
"location": "query",
|
|
3591
|
+
"type": "string"
|
|
3592
|
+
},
|
|
3593
|
+
"pageSize": {
|
|
3594
|
+
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
3595
|
+
"format": "int32",
|
|
3596
|
+
"location": "query",
|
|
3597
|
+
"type": "integer"
|
|
3598
|
+
},
|
|
3599
|
+
"pageToken": {
|
|
3600
|
+
"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.",
|
|
3601
|
+
"location": "query",
|
|
3602
|
+
"type": "string"
|
|
3603
|
+
},
|
|
3604
|
+
"parent": {
|
|
3605
|
+
"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`",
|
|
3606
|
+
"location": "path",
|
|
3607
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
|
|
3608
|
+
"required": true,
|
|
3609
|
+
"type": "string"
|
|
3610
|
+
}
|
|
3611
|
+
},
|
|
3612
|
+
"path": "v1alpha/{+parent}/sessions",
|
|
3613
|
+
"response": {
|
|
3614
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse"
|
|
3615
|
+
},
|
|
3616
|
+
"scopes": [
|
|
3617
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3618
|
+
]
|
|
3619
|
+
},
|
|
3620
|
+
"patch": {
|
|
3621
|
+
"description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.",
|
|
3622
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}",
|
|
3623
|
+
"httpMethod": "PATCH",
|
|
3624
|
+
"id": "discoveryengine.projects.locations.collections.engines.sessions.patch",
|
|
3625
|
+
"parameterOrder": [
|
|
3626
|
+
"name"
|
|
3627
|
+
],
|
|
3628
|
+
"parameters": {
|
|
3629
|
+
"name": {
|
|
3630
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
|
|
3631
|
+
"location": "path",
|
|
3632
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$",
|
|
3633
|
+
"required": true,
|
|
3634
|
+
"type": "string"
|
|
3635
|
+
},
|
|
3636
|
+
"updateMask": {
|
|
3637
|
+
"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.",
|
|
3638
|
+
"format": "google-fieldmask",
|
|
3639
|
+
"location": "query",
|
|
3640
|
+
"type": "string"
|
|
3641
|
+
}
|
|
3642
|
+
},
|
|
3643
|
+
"path": "v1alpha/{+name}",
|
|
3644
|
+
"request": {
|
|
3645
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
3646
|
+
},
|
|
3647
|
+
"response": {
|
|
3648
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
3649
|
+
},
|
|
3650
|
+
"scopes": [
|
|
3651
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3652
|
+
]
|
|
3653
|
+
}
|
|
3654
|
+
},
|
|
3655
|
+
"resources": {
|
|
3656
|
+
"answers": {
|
|
3657
|
+
"methods": {
|
|
3658
|
+
"get": {
|
|
3659
|
+
"description": "Gets a Answer.",
|
|
3660
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}",
|
|
3661
|
+
"httpMethod": "GET",
|
|
3662
|
+
"id": "discoveryengine.projects.locations.collections.engines.sessions.answers.get",
|
|
3663
|
+
"parameterOrder": [
|
|
3664
|
+
"name"
|
|
3665
|
+
],
|
|
3666
|
+
"parameters": {
|
|
3667
|
+
"name": {
|
|
3668
|
+
"description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`",
|
|
3669
|
+
"location": "path",
|
|
3670
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/answers/[^/]+$",
|
|
3671
|
+
"required": true,
|
|
3672
|
+
"type": "string"
|
|
3673
|
+
}
|
|
3674
|
+
},
|
|
3675
|
+
"path": "v1alpha/{+name}",
|
|
3676
|
+
"response": {
|
|
3677
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswer"
|
|
3678
|
+
},
|
|
3679
|
+
"scopes": [
|
|
3680
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3681
|
+
]
|
|
3682
|
+
}
|
|
3683
|
+
}
|
|
3684
|
+
}
|
|
3685
|
+
}
|
|
3686
|
+
}
|
|
3161
3687
|
}
|
|
3162
|
-
}
|
|
3163
3688
|
},
|
|
3164
3689
|
"operations": {
|
|
3165
3690
|
"methods": {
|
|
@@ -4105,7 +4630,7 @@
|
|
|
4105
4630
|
],
|
|
4106
4631
|
"parameters": {
|
|
4107
4632
|
"name": {
|
|
4108
|
-
"description": "Immutable. Fully qualified name `project
|
|
4633
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.",
|
|
4109
4634
|
"location": "path",
|
|
4110
4635
|
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$",
|
|
4111
4636
|
"required": true,
|
|
@@ -4433,6 +4958,34 @@
|
|
|
4433
4958
|
},
|
|
4434
4959
|
"servingConfigs": {
|
|
4435
4960
|
"methods": {
|
|
4961
|
+
"answer": {
|
|
4962
|
+
"description": "Answer query method.",
|
|
4963
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer",
|
|
4964
|
+
"httpMethod": "POST",
|
|
4965
|
+
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.answer",
|
|
4966
|
+
"parameterOrder": [
|
|
4967
|
+
"servingConfig"
|
|
4968
|
+
],
|
|
4969
|
+
"parameters": {
|
|
4970
|
+
"servingConfig": {
|
|
4971
|
+
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
|
|
4972
|
+
"location": "path",
|
|
4973
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
4974
|
+
"required": true,
|
|
4975
|
+
"type": "string"
|
|
4976
|
+
}
|
|
4977
|
+
},
|
|
4978
|
+
"path": "v1alpha/{+servingConfig}:answer",
|
|
4979
|
+
"request": {
|
|
4980
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest"
|
|
4981
|
+
},
|
|
4982
|
+
"response": {
|
|
4983
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse"
|
|
4984
|
+
},
|
|
4985
|
+
"scopes": [
|
|
4986
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
4987
|
+
]
|
|
4988
|
+
},
|
|
4436
4989
|
"get": {
|
|
4437
4990
|
"description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.",
|
|
4438
4991
|
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
|
|
@@ -4586,116 +5139,309 @@
|
|
|
4586
5139
|
}
|
|
4587
5140
|
}
|
|
4588
5141
|
},
|
|
4589
|
-
"
|
|
5142
|
+
"sessions": {
|
|
4590
5143
|
"methods": {
|
|
4591
|
-
"
|
|
4592
|
-
"description": "
|
|
4593
|
-
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/
|
|
5144
|
+
"create": {
|
|
5145
|
+
"description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.",
|
|
5146
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions",
|
|
4594
5147
|
"httpMethod": "POST",
|
|
4595
|
-
"id": "discoveryengine.projects.locations.dataStores.
|
|
5148
|
+
"id": "discoveryengine.projects.locations.dataStores.sessions.create",
|
|
4596
5149
|
"parameterOrder": [
|
|
4597
|
-
"
|
|
5150
|
+
"parent"
|
|
4598
5151
|
],
|
|
4599
5152
|
"parameters": {
|
|
4600
|
-
"
|
|
4601
|
-
"description": "Required. Full resource name of
|
|
5153
|
+
"parent": {
|
|
5154
|
+
"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`",
|
|
4602
5155
|
"location": "path",
|
|
4603
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]
|
|
5156
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
4604
5157
|
"required": true,
|
|
4605
5158
|
"type": "string"
|
|
4606
5159
|
}
|
|
4607
5160
|
},
|
|
4608
|
-
"path": "v1alpha/{+
|
|
5161
|
+
"path": "v1alpha/{+parent}/sessions",
|
|
4609
5162
|
"request": {
|
|
4610
|
-
"$ref": "
|
|
5163
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
4611
5164
|
},
|
|
4612
5165
|
"response": {
|
|
4613
|
-
"$ref": "
|
|
5166
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
4614
5167
|
},
|
|
4615
5168
|
"scopes": [
|
|
4616
5169
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
4617
5170
|
]
|
|
4618
5171
|
},
|
|
4619
|
-
"
|
|
4620
|
-
"description": "
|
|
4621
|
-
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/
|
|
4622
|
-
"httpMethod": "
|
|
4623
|
-
"id": "discoveryengine.projects.locations.dataStores.
|
|
5172
|
+
"delete": {
|
|
5173
|
+
"description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.",
|
|
5174
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}",
|
|
5175
|
+
"httpMethod": "DELETE",
|
|
5176
|
+
"id": "discoveryengine.projects.locations.dataStores.sessions.delete",
|
|
4624
5177
|
"parameterOrder": [
|
|
4625
|
-
"
|
|
5178
|
+
"name"
|
|
4626
5179
|
],
|
|
4627
5180
|
"parameters": {
|
|
4628
|
-
"
|
|
4629
|
-
"description": "Required.
|
|
5181
|
+
"name": {
|
|
5182
|
+
"description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
4630
5183
|
"location": "path",
|
|
4631
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/
|
|
5184
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$",
|
|
4632
5185
|
"required": true,
|
|
4633
5186
|
"type": "string"
|
|
4634
5187
|
}
|
|
4635
5188
|
},
|
|
4636
|
-
"path": "v1alpha/{+
|
|
4637
|
-
"request": {
|
|
4638
|
-
"$ref": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest"
|
|
4639
|
-
},
|
|
5189
|
+
"path": "v1alpha/{+name}",
|
|
4640
5190
|
"response": {
|
|
4641
|
-
"$ref": "
|
|
5191
|
+
"$ref": "GoogleProtobufEmpty"
|
|
4642
5192
|
},
|
|
4643
5193
|
"scopes": [
|
|
4644
5194
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
4645
5195
|
]
|
|
4646
5196
|
},
|
|
4647
|
-
"
|
|
4648
|
-
"description": "
|
|
4649
|
-
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/
|
|
4650
|
-
"httpMethod": "
|
|
4651
|
-
"id": "discoveryengine.projects.locations.dataStores.
|
|
5197
|
+
"get": {
|
|
5198
|
+
"description": "Gets a Session.",
|
|
5199
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}",
|
|
5200
|
+
"httpMethod": "GET",
|
|
5201
|
+
"id": "discoveryengine.projects.locations.dataStores.sessions.get",
|
|
4652
5202
|
"parameterOrder": [
|
|
4653
|
-
"
|
|
5203
|
+
"name"
|
|
4654
5204
|
],
|
|
4655
5205
|
"parameters": {
|
|
4656
|
-
"
|
|
4657
|
-
"description": "Required.
|
|
5206
|
+
"name": {
|
|
5207
|
+
"description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
4658
5208
|
"location": "path",
|
|
4659
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/
|
|
5209
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$",
|
|
4660
5210
|
"required": true,
|
|
4661
5211
|
"type": "string"
|
|
4662
5212
|
}
|
|
4663
5213
|
},
|
|
4664
|
-
"path": "v1alpha/{+
|
|
4665
|
-
"request": {
|
|
4666
|
-
"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest"
|
|
4667
|
-
},
|
|
5214
|
+
"path": "v1alpha/{+name}",
|
|
4668
5215
|
"response": {
|
|
4669
|
-
"$ref": "
|
|
5216
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
4670
5217
|
},
|
|
4671
5218
|
"scopes": [
|
|
4672
5219
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
4673
5220
|
]
|
|
4674
|
-
}
|
|
4675
5221
|
},
|
|
4676
|
-
"
|
|
4677
|
-
"
|
|
4678
|
-
"
|
|
4679
|
-
"
|
|
4680
|
-
"
|
|
4681
|
-
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate",
|
|
4682
|
-
"httpMethod": "POST",
|
|
4683
|
-
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate",
|
|
5222
|
+
"list": {
|
|
5223
|
+
"description": "Lists all Sessions by their parent DataStore.",
|
|
5224
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions",
|
|
5225
|
+
"httpMethod": "GET",
|
|
5226
|
+
"id": "discoveryengine.projects.locations.dataStores.sessions.list",
|
|
4684
5227
|
"parameterOrder": [
|
|
4685
5228
|
"parent"
|
|
4686
5229
|
],
|
|
4687
5230
|
"parameters": {
|
|
4688
|
-
"
|
|
4689
|
-
"description": "
|
|
4690
|
-
"location": "
|
|
4691
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
|
|
4692
|
-
"required": true,
|
|
5231
|
+
"filter": {
|
|
5232
|
+
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
|
|
5233
|
+
"location": "query",
|
|
4693
5234
|
"type": "string"
|
|
4694
|
-
}
|
|
4695
5235
|
},
|
|
4696
|
-
"
|
|
4697
|
-
"
|
|
4698
|
-
"
|
|
5236
|
+
"orderBy": {
|
|
5237
|
+
"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` * `session_name` Example: \"update_time desc\" \"create_time\"",
|
|
5238
|
+
"location": "query",
|
|
5239
|
+
"type": "string"
|
|
5240
|
+
},
|
|
5241
|
+
"pageSize": {
|
|
5242
|
+
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
5243
|
+
"format": "int32",
|
|
5244
|
+
"location": "query",
|
|
5245
|
+
"type": "integer"
|
|
5246
|
+
},
|
|
5247
|
+
"pageToken": {
|
|
5248
|
+
"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.",
|
|
5249
|
+
"location": "query",
|
|
5250
|
+
"type": "string"
|
|
5251
|
+
},
|
|
5252
|
+
"parent": {
|
|
5253
|
+
"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`",
|
|
5254
|
+
"location": "path",
|
|
5255
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
5256
|
+
"required": true,
|
|
5257
|
+
"type": "string"
|
|
5258
|
+
}
|
|
5259
|
+
},
|
|
5260
|
+
"path": "v1alpha/{+parent}/sessions",
|
|
5261
|
+
"response": {
|
|
5262
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse"
|
|
5263
|
+
},
|
|
5264
|
+
"scopes": [
|
|
5265
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5266
|
+
]
|
|
5267
|
+
},
|
|
5268
|
+
"patch": {
|
|
5269
|
+
"description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.",
|
|
5270
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}",
|
|
5271
|
+
"httpMethod": "PATCH",
|
|
5272
|
+
"id": "discoveryengine.projects.locations.dataStores.sessions.patch",
|
|
5273
|
+
"parameterOrder": [
|
|
5274
|
+
"name"
|
|
5275
|
+
],
|
|
5276
|
+
"parameters": {
|
|
5277
|
+
"name": {
|
|
5278
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
|
|
5279
|
+
"location": "path",
|
|
5280
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$",
|
|
5281
|
+
"required": true,
|
|
5282
|
+
"type": "string"
|
|
5283
|
+
},
|
|
5284
|
+
"updateMask": {
|
|
5285
|
+
"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.",
|
|
5286
|
+
"format": "google-fieldmask",
|
|
5287
|
+
"location": "query",
|
|
5288
|
+
"type": "string"
|
|
5289
|
+
}
|
|
5290
|
+
},
|
|
5291
|
+
"path": "v1alpha/{+name}",
|
|
5292
|
+
"request": {
|
|
5293
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
5294
|
+
},
|
|
5295
|
+
"response": {
|
|
5296
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
5297
|
+
},
|
|
5298
|
+
"scopes": [
|
|
5299
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5300
|
+
]
|
|
5301
|
+
}
|
|
5302
|
+
},
|
|
5303
|
+
"resources": {
|
|
5304
|
+
"answers": {
|
|
5305
|
+
"methods": {
|
|
5306
|
+
"get": {
|
|
5307
|
+
"description": "Gets a Answer.",
|
|
5308
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}",
|
|
5309
|
+
"httpMethod": "GET",
|
|
5310
|
+
"id": "discoveryengine.projects.locations.dataStores.sessions.answers.get",
|
|
5311
|
+
"parameterOrder": [
|
|
5312
|
+
"name"
|
|
5313
|
+
],
|
|
5314
|
+
"parameters": {
|
|
5315
|
+
"name": {
|
|
5316
|
+
"description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`",
|
|
5317
|
+
"location": "path",
|
|
5318
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$",
|
|
5319
|
+
"required": true,
|
|
5320
|
+
"type": "string"
|
|
5321
|
+
}
|
|
5322
|
+
},
|
|
5323
|
+
"path": "v1alpha/{+name}",
|
|
5324
|
+
"response": {
|
|
5325
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswer"
|
|
5326
|
+
},
|
|
5327
|
+
"scopes": [
|
|
5328
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5329
|
+
]
|
|
5330
|
+
}
|
|
5331
|
+
}
|
|
5332
|
+
}
|
|
5333
|
+
}
|
|
5334
|
+
},
|
|
5335
|
+
"siteSearchEngine": {
|
|
5336
|
+
"methods": {
|
|
5337
|
+
"disableAdvancedSiteSearch": {
|
|
5338
|
+
"description": "Downgrade from advanced site search to basic site search.",
|
|
5339
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch",
|
|
5340
|
+
"httpMethod": "POST",
|
|
5341
|
+
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch",
|
|
5342
|
+
"parameterOrder": [
|
|
5343
|
+
"siteSearchEngine"
|
|
5344
|
+
],
|
|
5345
|
+
"parameters": {
|
|
5346
|
+
"siteSearchEngine": {
|
|
5347
|
+
"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.",
|
|
5348
|
+
"location": "path",
|
|
5349
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
|
|
5350
|
+
"required": true,
|
|
5351
|
+
"type": "string"
|
|
5352
|
+
}
|
|
5353
|
+
},
|
|
5354
|
+
"path": "v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch",
|
|
5355
|
+
"request": {
|
|
5356
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest"
|
|
5357
|
+
},
|
|
5358
|
+
"response": {
|
|
5359
|
+
"$ref": "GoogleLongrunningOperation"
|
|
5360
|
+
},
|
|
5361
|
+
"scopes": [
|
|
5362
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5363
|
+
]
|
|
5364
|
+
},
|
|
5365
|
+
"enableAdvancedSiteSearch": {
|
|
5366
|
+
"description": "Upgrade from basic site search to advanced site search.",
|
|
5367
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch",
|
|
5368
|
+
"httpMethod": "POST",
|
|
5369
|
+
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch",
|
|
5370
|
+
"parameterOrder": [
|
|
5371
|
+
"siteSearchEngine"
|
|
5372
|
+
],
|
|
5373
|
+
"parameters": {
|
|
5374
|
+
"siteSearchEngine": {
|
|
5375
|
+
"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.",
|
|
5376
|
+
"location": "path",
|
|
5377
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
|
|
5378
|
+
"required": true,
|
|
5379
|
+
"type": "string"
|
|
5380
|
+
}
|
|
5381
|
+
},
|
|
5382
|
+
"path": "v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch",
|
|
5383
|
+
"request": {
|
|
5384
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest"
|
|
5385
|
+
},
|
|
5386
|
+
"response": {
|
|
5387
|
+
"$ref": "GoogleLongrunningOperation"
|
|
5388
|
+
},
|
|
5389
|
+
"scopes": [
|
|
5390
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5391
|
+
]
|
|
5392
|
+
},
|
|
5393
|
+
"recrawlUris": {
|
|
5394
|
+
"description": "Request on-demand recrawl for a list of URIs.",
|
|
5395
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris",
|
|
5396
|
+
"httpMethod": "POST",
|
|
5397
|
+
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris",
|
|
5398
|
+
"parameterOrder": [
|
|
5399
|
+
"siteSearchEngine"
|
|
5400
|
+
],
|
|
5401
|
+
"parameters": {
|
|
5402
|
+
"siteSearchEngine": {
|
|
5403
|
+
"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
|
|
5404
|
+
"location": "path",
|
|
5405
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
|
|
5406
|
+
"required": true,
|
|
5407
|
+
"type": "string"
|
|
5408
|
+
}
|
|
5409
|
+
},
|
|
5410
|
+
"path": "v1alpha/{+siteSearchEngine}:recrawlUris",
|
|
5411
|
+
"request": {
|
|
5412
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest"
|
|
5413
|
+
},
|
|
5414
|
+
"response": {
|
|
5415
|
+
"$ref": "GoogleLongrunningOperation"
|
|
5416
|
+
},
|
|
5417
|
+
"scopes": [
|
|
5418
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5419
|
+
]
|
|
5420
|
+
}
|
|
5421
|
+
},
|
|
5422
|
+
"resources": {
|
|
5423
|
+
"targetSites": {
|
|
5424
|
+
"methods": {
|
|
5425
|
+
"batchCreate": {
|
|
5426
|
+
"description": "Creates TargetSite in a batch.",
|
|
5427
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate",
|
|
5428
|
+
"httpMethod": "POST",
|
|
5429
|
+
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate",
|
|
5430
|
+
"parameterOrder": [
|
|
5431
|
+
"parent"
|
|
5432
|
+
],
|
|
5433
|
+
"parameters": {
|
|
5434
|
+
"parent": {
|
|
5435
|
+
"description": "Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field.",
|
|
5436
|
+
"location": "path",
|
|
5437
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
|
|
5438
|
+
"required": true,
|
|
5439
|
+
"type": "string"
|
|
5440
|
+
}
|
|
5441
|
+
},
|
|
5442
|
+
"path": "v1alpha/{+parent}/targetSites:batchCreate",
|
|
5443
|
+
"request": {
|
|
5444
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest"
|
|
4699
5445
|
},
|
|
4700
5446
|
"response": {
|
|
4701
5447
|
"$ref": "GoogleLongrunningOperation"
|
|
@@ -5019,7 +5765,7 @@
|
|
|
5019
5765
|
],
|
|
5020
5766
|
"parameters": {
|
|
5021
5767
|
"parent": {
|
|
5022
|
-
"description": "Required. The parent
|
|
5768
|
+
"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
|
|
5023
5769
|
"location": "path",
|
|
5024
5770
|
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
5025
5771
|
"required": true,
|
|
@@ -5041,13 +5787,15 @@
|
|
|
5041
5787
|
}
|
|
5042
5788
|
}
|
|
5043
5789
|
},
|
|
5790
|
+
"evaluations": {
|
|
5791
|
+
"resources": {
|
|
5044
5792
|
"operations": {
|
|
5045
5793
|
"methods": {
|
|
5046
5794
|
"get": {
|
|
5047
5795
|
"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.",
|
|
5048
|
-
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
|
|
5796
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/operations/{operationsId}",
|
|
5049
5797
|
"httpMethod": "GET",
|
|
5050
|
-
"id": "discoveryengine.projects.locations.operations.get",
|
|
5798
|
+
"id": "discoveryengine.projects.locations.evaluations.operations.get",
|
|
5051
5799
|
"parameterOrder": [
|
|
5052
5800
|
"name"
|
|
5053
5801
|
],
|
|
@@ -5055,7 +5803,7 @@
|
|
|
5055
5803
|
"name": {
|
|
5056
5804
|
"description": "The name of the operation resource.",
|
|
5057
5805
|
"location": "path",
|
|
5058
|
-
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
|
|
5806
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/operations/[^/]+$",
|
|
5059
5807
|
"required": true,
|
|
5060
5808
|
"type": "string"
|
|
5061
5809
|
}
|
|
@@ -5067,59 +5815,50 @@
|
|
|
5067
5815
|
"scopes": [
|
|
5068
5816
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
5069
5817
|
]
|
|
5818
|
+
}
|
|
5819
|
+
}
|
|
5820
|
+
}
|
|
5821
|
+
}
|
|
5070
5822
|
},
|
|
5071
|
-
"
|
|
5072
|
-
"
|
|
5073
|
-
"
|
|
5074
|
-
"
|
|
5075
|
-
"
|
|
5823
|
+
"groundingConfigs": {
|
|
5824
|
+
"methods": {
|
|
5825
|
+
"check": {
|
|
5826
|
+
"description": "Performs a grounding check.",
|
|
5827
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/groundingConfigs/{groundingConfigsId}:check",
|
|
5828
|
+
"httpMethod": "POST",
|
|
5829
|
+
"id": "discoveryengine.projects.locations.groundingConfigs.check",
|
|
5076
5830
|
"parameterOrder": [
|
|
5077
|
-
"
|
|
5831
|
+
"groundingConfig"
|
|
5078
5832
|
],
|
|
5079
5833
|
"parameters": {
|
|
5080
|
-
"
|
|
5081
|
-
"description": "The
|
|
5082
|
-
"location": "query",
|
|
5083
|
-
"type": "string"
|
|
5084
|
-
},
|
|
5085
|
-
"name": {
|
|
5086
|
-
"description": "The name of the operation's parent resource.",
|
|
5834
|
+
"groundingConfig": {
|
|
5835
|
+
"description": "Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`.",
|
|
5087
5836
|
"location": "path",
|
|
5088
|
-
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
5837
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/groundingConfigs/[^/]+$",
|
|
5089
5838
|
"required": true,
|
|
5090
5839
|
"type": "string"
|
|
5091
|
-
},
|
|
5092
|
-
"pageSize": {
|
|
5093
|
-
"description": "The standard list page size.",
|
|
5094
|
-
"format": "int32",
|
|
5095
|
-
"location": "query",
|
|
5096
|
-
"type": "integer"
|
|
5097
|
-
},
|
|
5098
|
-
"pageToken": {
|
|
5099
|
-
"description": "The standard list page token.",
|
|
5100
|
-
"location": "query",
|
|
5101
|
-
"type": "string"
|
|
5102
5840
|
}
|
|
5103
5841
|
},
|
|
5104
|
-
"path": "v1alpha/{+
|
|
5842
|
+
"path": "v1alpha/{+groundingConfig}:check",
|
|
5843
|
+
"request": {
|
|
5844
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest"
|
|
5845
|
+
},
|
|
5105
5846
|
"response": {
|
|
5106
|
-
"$ref": "
|
|
5847
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse"
|
|
5107
5848
|
},
|
|
5108
5849
|
"scopes": [
|
|
5109
5850
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
5110
5851
|
]
|
|
5111
5852
|
}
|
|
5112
5853
|
}
|
|
5113
|
-
}
|
|
5114
|
-
}
|
|
5115
5854
|
},
|
|
5116
5855
|
"operations": {
|
|
5117
5856
|
"methods": {
|
|
5118
5857
|
"get": {
|
|
5119
5858
|
"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.",
|
|
5120
|
-
"flatPath": "v1alpha/projects/{projectsId}/operations/{operationsId}",
|
|
5859
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
|
|
5121
5860
|
"httpMethod": "GET",
|
|
5122
|
-
"id": "discoveryengine.projects.operations.get",
|
|
5861
|
+
"id": "discoveryengine.projects.locations.operations.get",
|
|
5123
5862
|
"parameterOrder": [
|
|
5124
5863
|
"name"
|
|
5125
5864
|
],
|
|
@@ -5127,7 +5866,7 @@
|
|
|
5127
5866
|
"name": {
|
|
5128
5867
|
"description": "The name of the operation resource.",
|
|
5129
5868
|
"location": "path",
|
|
5130
|
-
"pattern": "^projects/[^/]+/operations/[^/]+$",
|
|
5869
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
|
|
5131
5870
|
"required": true,
|
|
5132
5871
|
"type": "string"
|
|
5133
5872
|
}
|
|
@@ -5142,9 +5881,9 @@
|
|
|
5142
5881
|
},
|
|
5143
5882
|
"list": {
|
|
5144
5883
|
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
|
|
5145
|
-
"flatPath": "v1alpha/projects/{projectsId}/operations",
|
|
5884
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations",
|
|
5146
5885
|
"httpMethod": "GET",
|
|
5147
|
-
"id": "discoveryengine.projects.operations.list",
|
|
5886
|
+
"id": "discoveryengine.projects.locations.operations.list",
|
|
5148
5887
|
"parameterOrder": [
|
|
5149
5888
|
"name"
|
|
5150
5889
|
],
|
|
@@ -5157,7 +5896,7 @@
|
|
|
5157
5896
|
"name": {
|
|
5158
5897
|
"description": "The name of the operation's parent resource.",
|
|
5159
5898
|
"location": "path",
|
|
5160
|
-
"pattern": "^projects/[^/]+$",
|
|
5899
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
5161
5900
|
"required": true,
|
|
5162
5901
|
"type": "string"
|
|
5163
5902
|
},
|
|
@@ -5182,15 +5921,184 @@
|
|
|
5182
5921
|
]
|
|
5183
5922
|
}
|
|
5184
5923
|
}
|
|
5185
|
-
}
|
|
5186
|
-
|
|
5924
|
+
},
|
|
5925
|
+
"rankingConfigs": {
|
|
5926
|
+
"methods": {
|
|
5927
|
+
"rank": {
|
|
5928
|
+
"description": "Ranks a list of text records based on the given input query.",
|
|
5929
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/rankingConfigs/{rankingConfigsId}:rank",
|
|
5930
|
+
"httpMethod": "POST",
|
|
5931
|
+
"id": "discoveryengine.projects.locations.rankingConfigs.rank",
|
|
5932
|
+
"parameterOrder": [
|
|
5933
|
+
"rankingConfig"
|
|
5934
|
+
],
|
|
5935
|
+
"parameters": {
|
|
5936
|
+
"rankingConfig": {
|
|
5937
|
+
"description": "Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.",
|
|
5938
|
+
"location": "path",
|
|
5939
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/rankingConfigs/[^/]+$",
|
|
5940
|
+
"required": true,
|
|
5941
|
+
"type": "string"
|
|
5187
5942
|
}
|
|
5188
5943
|
},
|
|
5189
|
-
"
|
|
5190
|
-
"
|
|
5191
|
-
"
|
|
5192
|
-
|
|
5193
|
-
"
|
|
5944
|
+
"path": "v1alpha/{+rankingConfig}:rank",
|
|
5945
|
+
"request": {
|
|
5946
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaRankRequest"
|
|
5947
|
+
},
|
|
5948
|
+
"response": {
|
|
5949
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaRankResponse"
|
|
5950
|
+
},
|
|
5951
|
+
"scopes": [
|
|
5952
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5953
|
+
]
|
|
5954
|
+
}
|
|
5955
|
+
}
|
|
5956
|
+
},
|
|
5957
|
+
"sampleQuerySets": {
|
|
5958
|
+
"resources": {
|
|
5959
|
+
"operations": {
|
|
5960
|
+
"methods": {
|
|
5961
|
+
"get": {
|
|
5962
|
+
"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.",
|
|
5963
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}",
|
|
5964
|
+
"httpMethod": "GET",
|
|
5965
|
+
"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get",
|
|
5966
|
+
"parameterOrder": [
|
|
5967
|
+
"name"
|
|
5968
|
+
],
|
|
5969
|
+
"parameters": {
|
|
5970
|
+
"name": {
|
|
5971
|
+
"description": "The name of the operation resource.",
|
|
5972
|
+
"location": "path",
|
|
5973
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$",
|
|
5974
|
+
"required": true,
|
|
5975
|
+
"type": "string"
|
|
5976
|
+
}
|
|
5977
|
+
},
|
|
5978
|
+
"path": "v1alpha/{+name}",
|
|
5979
|
+
"response": {
|
|
5980
|
+
"$ref": "GoogleLongrunningOperation"
|
|
5981
|
+
},
|
|
5982
|
+
"scopes": [
|
|
5983
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5984
|
+
]
|
|
5985
|
+
}
|
|
5986
|
+
}
|
|
5987
|
+
}
|
|
5988
|
+
}
|
|
5989
|
+
},
|
|
5990
|
+
"userEvents": {
|
|
5991
|
+
"methods": {
|
|
5992
|
+
"write": {
|
|
5993
|
+
"description": "Writes a single user event.",
|
|
5994
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write",
|
|
5995
|
+
"httpMethod": "POST",
|
|
5996
|
+
"id": "discoveryengine.projects.locations.userEvents.write",
|
|
5997
|
+
"parameterOrder": [
|
|
5998
|
+
"parent"
|
|
5999
|
+
],
|
|
6000
|
+
"parameters": {
|
|
6001
|
+
"parent": {
|
|
6002
|
+
"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
|
|
6003
|
+
"location": "path",
|
|
6004
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
6005
|
+
"required": true,
|
|
6006
|
+
"type": "string"
|
|
6007
|
+
}
|
|
6008
|
+
},
|
|
6009
|
+
"path": "v1alpha/{+parent}/userEvents:write",
|
|
6010
|
+
"request": {
|
|
6011
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent"
|
|
6012
|
+
},
|
|
6013
|
+
"response": {
|
|
6014
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent"
|
|
6015
|
+
},
|
|
6016
|
+
"scopes": [
|
|
6017
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6018
|
+
]
|
|
6019
|
+
}
|
|
6020
|
+
}
|
|
6021
|
+
}
|
|
6022
|
+
}
|
|
6023
|
+
},
|
|
6024
|
+
"operations": {
|
|
6025
|
+
"methods": {
|
|
6026
|
+
"get": {
|
|
6027
|
+
"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.",
|
|
6028
|
+
"flatPath": "v1alpha/projects/{projectsId}/operations/{operationsId}",
|
|
6029
|
+
"httpMethod": "GET",
|
|
6030
|
+
"id": "discoveryengine.projects.operations.get",
|
|
6031
|
+
"parameterOrder": [
|
|
6032
|
+
"name"
|
|
6033
|
+
],
|
|
6034
|
+
"parameters": {
|
|
6035
|
+
"name": {
|
|
6036
|
+
"description": "The name of the operation resource.",
|
|
6037
|
+
"location": "path",
|
|
6038
|
+
"pattern": "^projects/[^/]+/operations/[^/]+$",
|
|
6039
|
+
"required": true,
|
|
6040
|
+
"type": "string"
|
|
6041
|
+
}
|
|
6042
|
+
},
|
|
6043
|
+
"path": "v1alpha/{+name}",
|
|
6044
|
+
"response": {
|
|
6045
|
+
"$ref": "GoogleLongrunningOperation"
|
|
6046
|
+
},
|
|
6047
|
+
"scopes": [
|
|
6048
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6049
|
+
]
|
|
6050
|
+
},
|
|
6051
|
+
"list": {
|
|
6052
|
+
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
|
|
6053
|
+
"flatPath": "v1alpha/projects/{projectsId}/operations",
|
|
6054
|
+
"httpMethod": "GET",
|
|
6055
|
+
"id": "discoveryengine.projects.operations.list",
|
|
6056
|
+
"parameterOrder": [
|
|
6057
|
+
"name"
|
|
6058
|
+
],
|
|
6059
|
+
"parameters": {
|
|
6060
|
+
"filter": {
|
|
6061
|
+
"description": "The standard list filter.",
|
|
6062
|
+
"location": "query",
|
|
6063
|
+
"type": "string"
|
|
6064
|
+
},
|
|
6065
|
+
"name": {
|
|
6066
|
+
"description": "The name of the operation's parent resource.",
|
|
6067
|
+
"location": "path",
|
|
6068
|
+
"pattern": "^projects/[^/]+$",
|
|
6069
|
+
"required": true,
|
|
6070
|
+
"type": "string"
|
|
6071
|
+
},
|
|
6072
|
+
"pageSize": {
|
|
6073
|
+
"description": "The standard list page size.",
|
|
6074
|
+
"format": "int32",
|
|
6075
|
+
"location": "query",
|
|
6076
|
+
"type": "integer"
|
|
6077
|
+
},
|
|
6078
|
+
"pageToken": {
|
|
6079
|
+
"description": "The standard list page token.",
|
|
6080
|
+
"location": "query",
|
|
6081
|
+
"type": "string"
|
|
6082
|
+
}
|
|
6083
|
+
},
|
|
6084
|
+
"path": "v1alpha/{+name}/operations",
|
|
6085
|
+
"response": {
|
|
6086
|
+
"$ref": "GoogleLongrunningListOperationsResponse"
|
|
6087
|
+
},
|
|
6088
|
+
"scopes": [
|
|
6089
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6090
|
+
]
|
|
6091
|
+
}
|
|
6092
|
+
}
|
|
6093
|
+
}
|
|
6094
|
+
}
|
|
6095
|
+
}
|
|
6096
|
+
},
|
|
6097
|
+
"revision": "20240415",
|
|
6098
|
+
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
6099
|
+
"schemas": {
|
|
6100
|
+
"GoogleApiHttpBody": {
|
|
6101
|
+
"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.",
|
|
5194
6102
|
"id": "GoogleApiHttpBody",
|
|
5195
6103
|
"properties": {
|
|
5196
6104
|
"contentType": {
|
|
@@ -5478,12 +6386,14 @@
|
|
|
5478
6386
|
"enum": [
|
|
5479
6387
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
5480
6388
|
"GENERIC",
|
|
5481
|
-
"MEDIA"
|
|
6389
|
+
"MEDIA",
|
|
6390
|
+
"HEALTHCARE_FHIR"
|
|
5482
6391
|
],
|
|
5483
6392
|
"enumDescriptions": [
|
|
5484
6393
|
"Value used when unset.",
|
|
5485
6394
|
"The generic vertical for documents that are not specific to any industry vertical.",
|
|
5486
|
-
"The media industry vertical."
|
|
6395
|
+
"The media industry vertical.",
|
|
6396
|
+
"The healthcare FHIR vertical."
|
|
5487
6397
|
],
|
|
5488
6398
|
"type": "string"
|
|
5489
6399
|
},
|
|
@@ -5498,13 +6408,15 @@
|
|
|
5498
6408
|
"SOLUTION_TYPE_UNSPECIFIED",
|
|
5499
6409
|
"SOLUTION_TYPE_RECOMMENDATION",
|
|
5500
6410
|
"SOLUTION_TYPE_SEARCH",
|
|
5501
|
-
"SOLUTION_TYPE_CHAT"
|
|
6411
|
+
"SOLUTION_TYPE_CHAT",
|
|
6412
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
5502
6413
|
],
|
|
5503
6414
|
"enumDescriptions": [
|
|
5504
6415
|
"Default value.",
|
|
5505
6416
|
"Used for Recommendations AI.",
|
|
5506
6417
|
"Used for Discovery Search.",
|
|
5507
|
-
"Used for use cases related to the Generative AI agent."
|
|
6418
|
+
"Used for use cases related to the Generative AI agent.",
|
|
6419
|
+
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
|
|
5508
6420
|
],
|
|
5509
6421
|
"type": "string"
|
|
5510
6422
|
},
|
|
@@ -5656,7 +6568,8 @@
|
|
|
5656
6568
|
"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig",
|
|
5657
6569
|
"properties": {
|
|
5658
6570
|
"enhancedDocumentElements": {
|
|
5659
|
-
"
|
|
6571
|
+
"deprecated": true,
|
|
6572
|
+
"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.",
|
|
5660
6573
|
"items": {
|
|
5661
6574
|
"type": "string"
|
|
5662
6575
|
},
|
|
@@ -5731,12 +6644,14 @@
|
|
|
5731
6644
|
"enum": [
|
|
5732
6645
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
5733
6646
|
"GENERIC",
|
|
5734
|
-
"MEDIA"
|
|
6647
|
+
"MEDIA",
|
|
6648
|
+
"HEALTHCARE_FHIR"
|
|
5735
6649
|
],
|
|
5736
6650
|
"enumDescriptions": [
|
|
5737
6651
|
"Value used when unset.",
|
|
5738
6652
|
"The generic vertical for documents that are not specific to any industry vertical.",
|
|
5739
|
-
"The media industry vertical."
|
|
6653
|
+
"The media industry vertical.",
|
|
6654
|
+
"The healthcare FHIR vertical."
|
|
5740
6655
|
],
|
|
5741
6656
|
"type": "string"
|
|
5742
6657
|
},
|
|
@@ -5754,13 +6669,15 @@
|
|
|
5754
6669
|
"SOLUTION_TYPE_UNSPECIFIED",
|
|
5755
6670
|
"SOLUTION_TYPE_RECOMMENDATION",
|
|
5756
6671
|
"SOLUTION_TYPE_SEARCH",
|
|
5757
|
-
"SOLUTION_TYPE_CHAT"
|
|
6672
|
+
"SOLUTION_TYPE_CHAT",
|
|
6673
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
5758
6674
|
],
|
|
5759
6675
|
"enumDescriptions": [
|
|
5760
6676
|
"Default value.",
|
|
5761
6677
|
"Used for Recommendations AI.",
|
|
5762
6678
|
"Used for Discovery Search.",
|
|
5763
|
-
"Used for use cases related to the Generative AI agent."
|
|
6679
|
+
"Used for use cases related to the Generative AI agent.",
|
|
6680
|
+
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
|
|
5764
6681
|
],
|
|
5765
6682
|
"type": "string"
|
|
5766
6683
|
},
|
|
@@ -5782,7 +6699,7 @@
|
|
|
5782
6699
|
"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
|
|
5783
6700
|
},
|
|
5784
6701
|
"dialogflowAgentToLink": {
|
|
5785
|
-
"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
6702
|
+
"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
|
|
5786
6703
|
"type": "string"
|
|
5787
6704
|
}
|
|
5788
6705
|
},
|
|
@@ -5853,7 +6770,7 @@
|
|
|
5853
6770
|
"type": "array"
|
|
5854
6771
|
},
|
|
5855
6772
|
"searchTier": {
|
|
5856
|
-
"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
6773
|
+
"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.",
|
|
5857
6774
|
"enum": [
|
|
5858
6775
|
"SEARCH_TIER_UNSPECIFIED",
|
|
5859
6776
|
"SEARCH_TIER_STANDARD",
|
|
@@ -5888,6 +6805,11 @@
|
|
|
5888
6805
|
"format": "int64",
|
|
5889
6806
|
"type": "string"
|
|
5890
6807
|
},
|
|
6808
|
+
"totalCount": {
|
|
6809
|
+
"description": "Total count of entries that were processed.",
|
|
6810
|
+
"format": "int64",
|
|
6811
|
+
"type": "string"
|
|
6812
|
+
},
|
|
5891
6813
|
"updateTime": {
|
|
5892
6814
|
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
5893
6815
|
"format": "google-datetime",
|
|
@@ -6316,84 +7238,1120 @@
|
|
|
6316
7238
|
},
|
|
6317
7239
|
"type": "object"
|
|
6318
7240
|
},
|
|
6319
|
-
"
|
|
6320
|
-
"description": "
|
|
6321
|
-
"id": "
|
|
7241
|
+
"GoogleCloudDiscoveryengineV1alphaAnswer": {
|
|
7242
|
+
"description": "Defines an answer.",
|
|
7243
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswer",
|
|
6322
7244
|
"properties": {
|
|
7245
|
+
"answerSkippedReasons": {
|
|
7246
|
+
"description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.",
|
|
7247
|
+
"items": {
|
|
7248
|
+
"enum": [
|
|
7249
|
+
"ANSWER_SKIPPED_REASON_UNSPECIFIED",
|
|
7250
|
+
"ADVERSARIAL_QUERY_IGNORED",
|
|
7251
|
+
"NON_ANSWER_SEEKING_QUERY_IGNORED",
|
|
7252
|
+
"OUT_OF_DOMAIN_QUERY_IGNORED",
|
|
7253
|
+
"POTENTIAL_POLICY_VIOLATION"
|
|
7254
|
+
],
|
|
7255
|
+
"enumDescriptions": [
|
|
7256
|
+
"Default value. The answer skipped reason is not specified.",
|
|
7257
|
+
"The adversarial query ignored case.",
|
|
7258
|
+
"The non-answer seeking query ignored case.",
|
|
7259
|
+
"The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.",
|
|
7260
|
+
"The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic."
|
|
7261
|
+
],
|
|
7262
|
+
"type": "string"
|
|
7263
|
+
},
|
|
7264
|
+
"type": "array"
|
|
7265
|
+
},
|
|
7266
|
+
"answerText": {
|
|
7267
|
+
"description": "The textual answer.",
|
|
7268
|
+
"type": "string"
|
|
7269
|
+
},
|
|
7270
|
+
"citations": {
|
|
7271
|
+
"description": "Citations.",
|
|
7272
|
+
"items": {
|
|
7273
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation"
|
|
7274
|
+
},
|
|
7275
|
+
"type": "array"
|
|
7276
|
+
},
|
|
7277
|
+
"completeTime": {
|
|
7278
|
+
"description": "Output only. Answer completed timestamp.",
|
|
7279
|
+
"format": "google-datetime",
|
|
7280
|
+
"readOnly": true,
|
|
7281
|
+
"type": "string"
|
|
7282
|
+
},
|
|
6323
7283
|
"createTime": {
|
|
6324
|
-
"description": "
|
|
7284
|
+
"description": "Output only. Answer creation timestamp.",
|
|
6325
7285
|
"format": "google-datetime",
|
|
7286
|
+
"readOnly": true,
|
|
7287
|
+
"type": "string"
|
|
7288
|
+
},
|
|
7289
|
+
"name": {
|
|
7290
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`",
|
|
7291
|
+
"type": "string"
|
|
7292
|
+
},
|
|
7293
|
+
"queryUnderstandingInfo": {
|
|
7294
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo",
|
|
7295
|
+
"description": "Query understanding information."
|
|
7296
|
+
},
|
|
7297
|
+
"references": {
|
|
7298
|
+
"description": "References.",
|
|
7299
|
+
"items": {
|
|
7300
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference"
|
|
7301
|
+
},
|
|
7302
|
+
"type": "array"
|
|
7303
|
+
},
|
|
7304
|
+
"relatedQuestions": {
|
|
7305
|
+
"description": "Suggested related questions.",
|
|
7306
|
+
"items": {
|
|
7307
|
+
"type": "string"
|
|
7308
|
+
},
|
|
7309
|
+
"type": "array"
|
|
7310
|
+
},
|
|
7311
|
+
"state": {
|
|
7312
|
+
"description": "The state of the answer generation.",
|
|
7313
|
+
"enum": [
|
|
7314
|
+
"STATE_UNSPECIFIED",
|
|
7315
|
+
"IN_PROGRESS",
|
|
7316
|
+
"FAILED",
|
|
7317
|
+
"SUCCEEDED"
|
|
7318
|
+
],
|
|
7319
|
+
"enumDescriptions": [
|
|
7320
|
+
"Unknown.",
|
|
7321
|
+
"Answer generation is currently in progress.",
|
|
7322
|
+
"Answer generation currently failed.",
|
|
7323
|
+
"Answer generation has succeeded."
|
|
7324
|
+
],
|
|
7325
|
+
"type": "string"
|
|
7326
|
+
},
|
|
7327
|
+
"steps": {
|
|
7328
|
+
"description": "Answer generation steps.",
|
|
7329
|
+
"items": {
|
|
7330
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep"
|
|
7331
|
+
},
|
|
7332
|
+
"type": "array"
|
|
7333
|
+
}
|
|
7334
|
+
},
|
|
7335
|
+
"type": "object"
|
|
7336
|
+
},
|
|
7337
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerCitation": {
|
|
7338
|
+
"description": "Citation info for a segment.",
|
|
7339
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation",
|
|
7340
|
+
"properties": {
|
|
7341
|
+
"endIndex": {
|
|
7342
|
+
"description": "End of the attributed segment, exclusive.",
|
|
7343
|
+
"format": "int64",
|
|
7344
|
+
"type": "string"
|
|
7345
|
+
},
|
|
7346
|
+
"sources": {
|
|
7347
|
+
"description": "Citation sources for the attributed segment.",
|
|
7348
|
+
"items": {
|
|
7349
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource"
|
|
7350
|
+
},
|
|
7351
|
+
"type": "array"
|
|
7352
|
+
},
|
|
7353
|
+
"startIndex": {
|
|
7354
|
+
"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).",
|
|
7355
|
+
"format": "int64",
|
|
7356
|
+
"type": "string"
|
|
7357
|
+
}
|
|
7358
|
+
},
|
|
7359
|
+
"type": "object"
|
|
7360
|
+
},
|
|
7361
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": {
|
|
7362
|
+
"description": "Citation source.",
|
|
7363
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource",
|
|
7364
|
+
"properties": {
|
|
7365
|
+
"referenceId": {
|
|
7366
|
+
"description": "ID of the citation source.",
|
|
7367
|
+
"type": "string"
|
|
7368
|
+
}
|
|
7369
|
+
},
|
|
7370
|
+
"type": "object"
|
|
7371
|
+
},
|
|
7372
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest": {
|
|
7373
|
+
"description": "Request message for ConversationalSearchService.AnswerQuery method.",
|
|
7374
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest",
|
|
7375
|
+
"properties": {
|
|
7376
|
+
"answerGenerationSpec": {
|
|
7377
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec",
|
|
7378
|
+
"description": "Answer generation specification."
|
|
7379
|
+
},
|
|
7380
|
+
"asynchronousMode": {
|
|
7381
|
+
"description": "Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.",
|
|
7382
|
+
"type": "boolean"
|
|
7383
|
+
},
|
|
7384
|
+
"query": {
|
|
7385
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
|
|
7386
|
+
"description": "Required. Current user query."
|
|
7387
|
+
},
|
|
7388
|
+
"queryUnderstandingSpec": {
|
|
7389
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec",
|
|
7390
|
+
"description": "Query understanding specification."
|
|
7391
|
+
},
|
|
7392
|
+
"relatedQuestionsSpec": {
|
|
7393
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec",
|
|
7394
|
+
"description": "Related questions specification."
|
|
7395
|
+
},
|
|
7396
|
+
"safetySpec": {
|
|
7397
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec",
|
|
7398
|
+
"description": "Model specification."
|
|
7399
|
+
},
|
|
7400
|
+
"searchSpec": {
|
|
7401
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec",
|
|
7402
|
+
"description": "Search specification."
|
|
7403
|
+
},
|
|
7404
|
+
"session": {
|
|
7405
|
+
"description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol \u201c-\u201d as session id. A new id will be automatically generated and assigned.",
|
|
7406
|
+
"type": "string"
|
|
7407
|
+
},
|
|
7408
|
+
"userPseudoId": {
|
|
7409
|
+
"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`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
7410
|
+
"type": "string"
|
|
7411
|
+
}
|
|
7412
|
+
},
|
|
7413
|
+
"type": "object"
|
|
7414
|
+
},
|
|
7415
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec": {
|
|
7416
|
+
"description": "Answer generation specification.",
|
|
7417
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec",
|
|
7418
|
+
"properties": {
|
|
7419
|
+
"answerLanguageCode": {
|
|
7420
|
+
"description": "Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.",
|
|
7421
|
+
"type": "string"
|
|
7422
|
+
},
|
|
7423
|
+
"ignoreAdversarialQuery": {
|
|
7424
|
+
"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.",
|
|
7425
|
+
"type": "boolean"
|
|
7426
|
+
},
|
|
7427
|
+
"ignoreNonAnswerSeekingQuery": {
|
|
7428
|
+
"description": "Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.",
|
|
7429
|
+
"type": "boolean"
|
|
7430
|
+
},
|
|
7431
|
+
"includeCitations": {
|
|
7432
|
+
"description": "Specifies whether to include citation metadata in the answer. The default value is `false`.",
|
|
7433
|
+
"type": "boolean"
|
|
7434
|
+
},
|
|
7435
|
+
"modelSpec": {
|
|
7436
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec",
|
|
7437
|
+
"description": "Answer generation model specification."
|
|
7438
|
+
},
|
|
7439
|
+
"promptSpec": {
|
|
7440
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec",
|
|
7441
|
+
"description": "Answer generation prompt specification."
|
|
7442
|
+
}
|
|
7443
|
+
},
|
|
7444
|
+
"type": "object"
|
|
7445
|
+
},
|
|
7446
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec": {
|
|
7447
|
+
"description": "Answer Generation Model specification.",
|
|
7448
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec",
|
|
7449
|
+
"properties": {
|
|
7450
|
+
"modelVersion": {
|
|
7451
|
+
"description": "Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.",
|
|
7452
|
+
"type": "string"
|
|
7453
|
+
}
|
|
7454
|
+
},
|
|
7455
|
+
"type": "object"
|
|
7456
|
+
},
|
|
7457
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec": {
|
|
7458
|
+
"description": "Answer generation prompt specification.",
|
|
7459
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec",
|
|
7460
|
+
"properties": {
|
|
7461
|
+
"preamble": {
|
|
7462
|
+
"description": "Customized preamble.",
|
|
7463
|
+
"type": "string"
|
|
7464
|
+
}
|
|
7465
|
+
},
|
|
7466
|
+
"type": "object"
|
|
7467
|
+
},
|
|
7468
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec": {
|
|
7469
|
+
"description": "Query understanding specification.",
|
|
7470
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec",
|
|
7471
|
+
"properties": {
|
|
7472
|
+
"queryClassificationSpec": {
|
|
7473
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec",
|
|
7474
|
+
"description": "Query classification specification."
|
|
7475
|
+
},
|
|
7476
|
+
"queryRephraserSpec": {
|
|
7477
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec",
|
|
7478
|
+
"description": "Query rephraser specification."
|
|
7479
|
+
}
|
|
7480
|
+
},
|
|
7481
|
+
"type": "object"
|
|
7482
|
+
},
|
|
7483
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec": {
|
|
7484
|
+
"description": "Query classification specification.",
|
|
7485
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec",
|
|
7486
|
+
"properties": {
|
|
7487
|
+
"types": {
|
|
7488
|
+
"description": "Enabled query classification types.",
|
|
7489
|
+
"items": {
|
|
7490
|
+
"enum": [
|
|
7491
|
+
"TYPE_UNSPECIFIED",
|
|
7492
|
+
"ADVERSARIAL_QUERY",
|
|
7493
|
+
"NON_ANSWER_SEEKING_QUERY"
|
|
7494
|
+
],
|
|
7495
|
+
"enumDescriptions": [
|
|
7496
|
+
"Unspecified query classification type.",
|
|
7497
|
+
"Adversarial query classification type.",
|
|
7498
|
+
"Non-answer-seeking query classification type."
|
|
7499
|
+
],
|
|
7500
|
+
"type": "string"
|
|
7501
|
+
},
|
|
7502
|
+
"type": "array"
|
|
7503
|
+
}
|
|
7504
|
+
},
|
|
7505
|
+
"type": "object"
|
|
7506
|
+
},
|
|
7507
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec": {
|
|
7508
|
+
"description": "Query rephraser specification.",
|
|
7509
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec",
|
|
7510
|
+
"properties": {
|
|
7511
|
+
"disable": {
|
|
7512
|
+
"description": "Disable query rephraser.",
|
|
7513
|
+
"type": "boolean"
|
|
7514
|
+
},
|
|
7515
|
+
"maxRephraseSteps": {
|
|
7516
|
+
"description": "Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.",
|
|
7517
|
+
"format": "int32",
|
|
7518
|
+
"type": "integer"
|
|
7519
|
+
}
|
|
7520
|
+
},
|
|
7521
|
+
"type": "object"
|
|
7522
|
+
},
|
|
7523
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec": {
|
|
7524
|
+
"description": "Related questions specification.",
|
|
7525
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec",
|
|
7526
|
+
"properties": {
|
|
7527
|
+
"enable": {
|
|
7528
|
+
"description": "Enable related questions feature if true.",
|
|
7529
|
+
"type": "boolean"
|
|
7530
|
+
}
|
|
7531
|
+
},
|
|
7532
|
+
"type": "object"
|
|
7533
|
+
},
|
|
7534
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec": {
|
|
7535
|
+
"description": "Safety specification.",
|
|
7536
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec",
|
|
7537
|
+
"properties": {
|
|
7538
|
+
"enable": {
|
|
7539
|
+
"description": "Enable the safety filtering on the answer response. It is false by default.",
|
|
7540
|
+
"type": "boolean"
|
|
7541
|
+
}
|
|
7542
|
+
},
|
|
7543
|
+
"type": "object"
|
|
7544
|
+
},
|
|
7545
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec": {
|
|
7546
|
+
"description": "Search specification.",
|
|
7547
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec",
|
|
7548
|
+
"properties": {
|
|
7549
|
+
"searchParams": {
|
|
7550
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams",
|
|
7551
|
+
"description": "Search parameters."
|
|
7552
|
+
},
|
|
7553
|
+
"searchResultList": {
|
|
7554
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList",
|
|
7555
|
+
"description": "Search result list."
|
|
7556
|
+
}
|
|
7557
|
+
},
|
|
7558
|
+
"type": "object"
|
|
7559
|
+
},
|
|
7560
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams": {
|
|
7561
|
+
"description": "Search parameters.",
|
|
7562
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams",
|
|
7563
|
+
"properties": {
|
|
7564
|
+
"boostSpec": {
|
|
7565
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
|
|
7566
|
+
"description": "Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)"
|
|
7567
|
+
},
|
|
7568
|
+
"customFineTuningSpec": {
|
|
7569
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec",
|
|
7570
|
+
"description": "Custom fine tuning configs."
|
|
7571
|
+
},
|
|
7572
|
+
"filter": {
|
|
7573
|
+
"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
|
|
7574
|
+
"type": "string"
|
|
7575
|
+
},
|
|
7576
|
+
"maxReturnResults": {
|
|
7577
|
+
"description": "Number of search results to return. The default value is 10.",
|
|
7578
|
+
"format": "int32",
|
|
7579
|
+
"type": "integer"
|
|
7580
|
+
},
|
|
7581
|
+
"orderBy": {
|
|
7582
|
+
"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. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.",
|
|
7583
|
+
"type": "string"
|
|
7584
|
+
},
|
|
7585
|
+
"searchResultMode": {
|
|
7586
|
+
"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)",
|
|
7587
|
+
"enum": [
|
|
7588
|
+
"SEARCH_RESULT_MODE_UNSPECIFIED",
|
|
7589
|
+
"DOCUMENTS",
|
|
7590
|
+
"CHUNKS"
|
|
7591
|
+
],
|
|
7592
|
+
"enumDescriptions": [
|
|
7593
|
+
"Default value.",
|
|
7594
|
+
"Returns documents in the search result.",
|
|
7595
|
+
"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
|
|
7596
|
+
],
|
|
7597
|
+
"type": "string"
|
|
7598
|
+
}
|
|
7599
|
+
},
|
|
7600
|
+
"type": "object"
|
|
7601
|
+
},
|
|
7602
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList": {
|
|
7603
|
+
"description": "Search result list.",
|
|
7604
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList",
|
|
7605
|
+
"properties": {
|
|
7606
|
+
"searchResults": {
|
|
7607
|
+
"description": "Search results.",
|
|
7608
|
+
"items": {
|
|
7609
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult"
|
|
7610
|
+
},
|
|
7611
|
+
"type": "array"
|
|
7612
|
+
}
|
|
7613
|
+
},
|
|
7614
|
+
"type": "object"
|
|
7615
|
+
},
|
|
7616
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult": {
|
|
7617
|
+
"description": "Search result.",
|
|
7618
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult",
|
|
7619
|
+
"properties": {
|
|
7620
|
+
"chunkInfo": {
|
|
7621
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo",
|
|
7622
|
+
"description": "Chunk information."
|
|
7623
|
+
},
|
|
7624
|
+
"unstructuredDocumentInfo": {
|
|
7625
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo",
|
|
7626
|
+
"description": "Unstructured document information."
|
|
7627
|
+
}
|
|
7628
|
+
},
|
|
7629
|
+
"type": "object"
|
|
7630
|
+
},
|
|
7631
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo": {
|
|
7632
|
+
"description": "Chunk information.",
|
|
7633
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo",
|
|
7634
|
+
"properties": {
|
|
7635
|
+
"chunk": {
|
|
7636
|
+
"description": "Chunk resource name.",
|
|
7637
|
+
"type": "string"
|
|
7638
|
+
},
|
|
7639
|
+
"content": {
|
|
7640
|
+
"description": "Chunk textual content.",
|
|
7641
|
+
"type": "string"
|
|
7642
|
+
}
|
|
7643
|
+
},
|
|
7644
|
+
"type": "object"
|
|
7645
|
+
},
|
|
7646
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo": {
|
|
7647
|
+
"description": "Unstructured document information.",
|
|
7648
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo",
|
|
7649
|
+
"properties": {
|
|
7650
|
+
"document": {
|
|
7651
|
+
"description": "Document resource name.",
|
|
7652
|
+
"type": "string"
|
|
7653
|
+
},
|
|
7654
|
+
"documentContexts": {
|
|
7655
|
+
"description": "List of document contexts.",
|
|
7656
|
+
"items": {
|
|
7657
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext"
|
|
7658
|
+
},
|
|
7659
|
+
"type": "array"
|
|
7660
|
+
},
|
|
7661
|
+
"extractiveAnswers": {
|
|
7662
|
+
"description": "List of extractive answers.",
|
|
7663
|
+
"items": {
|
|
7664
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer"
|
|
7665
|
+
},
|
|
7666
|
+
"type": "array"
|
|
7667
|
+
},
|
|
7668
|
+
"extractiveSegments": {
|
|
7669
|
+
"description": "List of extractive segments.",
|
|
7670
|
+
"items": {
|
|
7671
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment"
|
|
7672
|
+
},
|
|
7673
|
+
"type": "array"
|
|
7674
|
+
},
|
|
7675
|
+
"title": {
|
|
7676
|
+
"description": "Title.",
|
|
7677
|
+
"type": "string"
|
|
7678
|
+
},
|
|
7679
|
+
"uri": {
|
|
7680
|
+
"description": "URI for the document.",
|
|
7681
|
+
"type": "string"
|
|
7682
|
+
}
|
|
7683
|
+
},
|
|
7684
|
+
"type": "object"
|
|
7685
|
+
},
|
|
7686
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext": {
|
|
7687
|
+
"description": "Document context.",
|
|
7688
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext",
|
|
7689
|
+
"properties": {
|
|
7690
|
+
"content": {
|
|
7691
|
+
"description": "Document content.",
|
|
7692
|
+
"type": "string"
|
|
7693
|
+
},
|
|
7694
|
+
"pageIdentifier": {
|
|
7695
|
+
"description": "Page identifier.",
|
|
7696
|
+
"type": "string"
|
|
7697
|
+
}
|
|
7698
|
+
},
|
|
7699
|
+
"type": "object"
|
|
7700
|
+
},
|
|
7701
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer": {
|
|
7702
|
+
"description": "Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)",
|
|
7703
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer",
|
|
7704
|
+
"properties": {
|
|
7705
|
+
"content": {
|
|
7706
|
+
"description": "Extractive answer content.",
|
|
7707
|
+
"type": "string"
|
|
7708
|
+
},
|
|
7709
|
+
"pageIdentifier": {
|
|
7710
|
+
"description": "Page identifier.",
|
|
7711
|
+
"type": "string"
|
|
7712
|
+
}
|
|
7713
|
+
},
|
|
7714
|
+
"type": "object"
|
|
7715
|
+
},
|
|
7716
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": {
|
|
7717
|
+
"description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)",
|
|
7718
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment",
|
|
7719
|
+
"properties": {
|
|
7720
|
+
"content": {
|
|
7721
|
+
"description": "Extractive segment content.",
|
|
7722
|
+
"type": "string"
|
|
7723
|
+
},
|
|
7724
|
+
"pageIdentifier": {
|
|
7725
|
+
"description": "Page identifier.",
|
|
7726
|
+
"type": "string"
|
|
7727
|
+
}
|
|
7728
|
+
},
|
|
7729
|
+
"type": "object"
|
|
7730
|
+
},
|
|
7731
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse": {
|
|
7732
|
+
"description": "Response message for ConversationalSearchService.AnswerQuery method.",
|
|
7733
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse",
|
|
7734
|
+
"properties": {
|
|
7735
|
+
"answer": {
|
|
7736
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswer",
|
|
7737
|
+
"description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API."
|
|
7738
|
+
},
|
|
7739
|
+
"answerQueryToken": {
|
|
7740
|
+
"description": "A global unique ID used for logging.",
|
|
7741
|
+
"type": "string"
|
|
7742
|
+
},
|
|
7743
|
+
"session": {
|
|
7744
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession",
|
|
7745
|
+
"description": "Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request."
|
|
7746
|
+
}
|
|
7747
|
+
},
|
|
7748
|
+
"type": "object"
|
|
7749
|
+
},
|
|
7750
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": {
|
|
7751
|
+
"description": "Query understanding information.",
|
|
7752
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo",
|
|
7753
|
+
"properties": {
|
|
7754
|
+
"queryClassificationInfo": {
|
|
7755
|
+
"description": "Query classification information.",
|
|
7756
|
+
"items": {
|
|
7757
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo"
|
|
7758
|
+
},
|
|
7759
|
+
"type": "array"
|
|
7760
|
+
}
|
|
7761
|
+
},
|
|
7762
|
+
"type": "object"
|
|
7763
|
+
},
|
|
7764
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": {
|
|
7765
|
+
"description": "Query classification information.",
|
|
7766
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo",
|
|
7767
|
+
"properties": {
|
|
7768
|
+
"positive": {
|
|
7769
|
+
"description": "Classification output.",
|
|
7770
|
+
"type": "boolean"
|
|
7771
|
+
},
|
|
7772
|
+
"type": {
|
|
7773
|
+
"description": "Query classification type.",
|
|
7774
|
+
"enum": [
|
|
7775
|
+
"TYPE_UNSPECIFIED",
|
|
7776
|
+
"ADVERSARIAL_QUERY",
|
|
7777
|
+
"NON_ANSWER_SEEKING_QUERY"
|
|
7778
|
+
],
|
|
7779
|
+
"enumDescriptions": [
|
|
7780
|
+
"Unspecified query classification type.",
|
|
7781
|
+
"Adversarial query classification type.",
|
|
7782
|
+
"Non-answer-seeking query classification type."
|
|
7783
|
+
],
|
|
7784
|
+
"type": "string"
|
|
7785
|
+
}
|
|
7786
|
+
},
|
|
7787
|
+
"type": "object"
|
|
7788
|
+
},
|
|
7789
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerReference": {
|
|
7790
|
+
"description": "Reference.",
|
|
7791
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerReference",
|
|
7792
|
+
"properties": {
|
|
7793
|
+
"chunkInfo": {
|
|
7794
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo",
|
|
7795
|
+
"description": "Chunk information."
|
|
7796
|
+
},
|
|
7797
|
+
"unstructuredDocumentInfo": {
|
|
7798
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo",
|
|
7799
|
+
"description": "Unstructured document information."
|
|
7800
|
+
}
|
|
7801
|
+
},
|
|
7802
|
+
"type": "object"
|
|
7803
|
+
},
|
|
7804
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": {
|
|
7805
|
+
"description": "Chunk information.",
|
|
7806
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo",
|
|
7807
|
+
"properties": {
|
|
7808
|
+
"chunk": {
|
|
7809
|
+
"description": "Chunk resource name.",
|
|
7810
|
+
"type": "string"
|
|
7811
|
+
},
|
|
7812
|
+
"content": {
|
|
7813
|
+
"description": "Chunk textual content.",
|
|
7814
|
+
"type": "string"
|
|
7815
|
+
},
|
|
7816
|
+
"documentMetadata": {
|
|
7817
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata",
|
|
7818
|
+
"description": "Document metadata."
|
|
7819
|
+
},
|
|
7820
|
+
"relevanceScore": {
|
|
7821
|
+
"description": "Relevance score.",
|
|
7822
|
+
"format": "float",
|
|
7823
|
+
"type": "number"
|
|
7824
|
+
}
|
|
7825
|
+
},
|
|
7826
|
+
"type": "object"
|
|
7827
|
+
},
|
|
7828
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": {
|
|
7829
|
+
"description": "Document metadata.",
|
|
7830
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata",
|
|
7831
|
+
"properties": {
|
|
7832
|
+
"document": {
|
|
7833
|
+
"description": "Document resource name.",
|
|
7834
|
+
"type": "string"
|
|
7835
|
+
},
|
|
7836
|
+
"pageIdentifier": {
|
|
7837
|
+
"description": "Page identifier.",
|
|
7838
|
+
"type": "string"
|
|
7839
|
+
},
|
|
7840
|
+
"title": {
|
|
7841
|
+
"description": "Title.",
|
|
7842
|
+
"type": "string"
|
|
7843
|
+
},
|
|
7844
|
+
"uri": {
|
|
7845
|
+
"description": "URI for the document.",
|
|
7846
|
+
"type": "string"
|
|
7847
|
+
}
|
|
7848
|
+
},
|
|
7849
|
+
"type": "object"
|
|
7850
|
+
},
|
|
7851
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": {
|
|
7852
|
+
"description": "Unstructured document information.",
|
|
7853
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo",
|
|
7854
|
+
"properties": {
|
|
7855
|
+
"chunkContents": {
|
|
7856
|
+
"description": "List of cited chunk contents derived from document content.",
|
|
7857
|
+
"items": {
|
|
7858
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent"
|
|
7859
|
+
},
|
|
7860
|
+
"type": "array"
|
|
7861
|
+
},
|
|
7862
|
+
"document": {
|
|
7863
|
+
"description": "Document resource name.",
|
|
7864
|
+
"type": "string"
|
|
7865
|
+
},
|
|
7866
|
+
"title": {
|
|
7867
|
+
"description": "Title.",
|
|
7868
|
+
"type": "string"
|
|
7869
|
+
},
|
|
7870
|
+
"uri": {
|
|
7871
|
+
"description": "URI for the document.",
|
|
7872
|
+
"type": "string"
|
|
7873
|
+
}
|
|
7874
|
+
},
|
|
7875
|
+
"type": "object"
|
|
7876
|
+
},
|
|
7877
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": {
|
|
7878
|
+
"description": "Chunk content.",
|
|
7879
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent",
|
|
7880
|
+
"properties": {
|
|
7881
|
+
"content": {
|
|
7882
|
+
"description": "Chunk textual content.",
|
|
7883
|
+
"type": "string"
|
|
7884
|
+
},
|
|
7885
|
+
"pageIdentifier": {
|
|
7886
|
+
"description": "Page identifier.",
|
|
7887
|
+
"type": "string"
|
|
7888
|
+
}
|
|
7889
|
+
},
|
|
7890
|
+
"type": "object"
|
|
7891
|
+
},
|
|
7892
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerStep": {
|
|
7893
|
+
"description": "Step information.",
|
|
7894
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStep",
|
|
7895
|
+
"properties": {
|
|
7896
|
+
"actions": {
|
|
7897
|
+
"description": "Actions.",
|
|
7898
|
+
"items": {
|
|
7899
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction"
|
|
7900
|
+
},
|
|
7901
|
+
"type": "array"
|
|
7902
|
+
},
|
|
7903
|
+
"description": {
|
|
7904
|
+
"description": "The description of the step.",
|
|
7905
|
+
"type": "string"
|
|
7906
|
+
},
|
|
7907
|
+
"state": {
|
|
7908
|
+
"description": "The state of the step.",
|
|
7909
|
+
"enum": [
|
|
7910
|
+
"STATE_UNSPECIFIED",
|
|
7911
|
+
"IN_PROGRESS",
|
|
7912
|
+
"FAILED",
|
|
7913
|
+
"SUCCEEDED"
|
|
7914
|
+
],
|
|
7915
|
+
"enumDescriptions": [
|
|
7916
|
+
"Unknown.",
|
|
7917
|
+
"Step is currently in progress.",
|
|
7918
|
+
"Step currently failed.",
|
|
7919
|
+
"Step has succeeded."
|
|
7920
|
+
],
|
|
7921
|
+
"type": "string"
|
|
7922
|
+
},
|
|
7923
|
+
"thought": {
|
|
7924
|
+
"description": "The thought of the step.",
|
|
7925
|
+
"type": "string"
|
|
7926
|
+
}
|
|
7927
|
+
},
|
|
7928
|
+
"type": "object"
|
|
7929
|
+
},
|
|
7930
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerStepAction": {
|
|
7931
|
+
"description": "Action.",
|
|
7932
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction",
|
|
7933
|
+
"properties": {
|
|
7934
|
+
"observation": {
|
|
7935
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation",
|
|
7936
|
+
"description": "Observation."
|
|
7937
|
+
},
|
|
7938
|
+
"searchAction": {
|
|
7939
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction",
|
|
7940
|
+
"description": "Search action."
|
|
7941
|
+
}
|
|
7942
|
+
},
|
|
7943
|
+
"type": "object"
|
|
7944
|
+
},
|
|
7945
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": {
|
|
7946
|
+
"description": "Observation.",
|
|
7947
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation",
|
|
7948
|
+
"properties": {
|
|
7949
|
+
"searchResults": {
|
|
7950
|
+
"description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.",
|
|
7951
|
+
"items": {
|
|
7952
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult"
|
|
7953
|
+
},
|
|
7954
|
+
"type": "array"
|
|
7955
|
+
}
|
|
7956
|
+
},
|
|
7957
|
+
"type": "object"
|
|
7958
|
+
},
|
|
7959
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": {
|
|
7960
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult",
|
|
7961
|
+
"properties": {
|
|
7962
|
+
"chunkInfo": {
|
|
7963
|
+
"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.",
|
|
7964
|
+
"items": {
|
|
7965
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo"
|
|
7966
|
+
},
|
|
7967
|
+
"type": "array"
|
|
7968
|
+
},
|
|
7969
|
+
"document": {
|
|
7970
|
+
"description": "Document resource name.",
|
|
7971
|
+
"type": "string"
|
|
7972
|
+
},
|
|
7973
|
+
"snippetInfo": {
|
|
7974
|
+
"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.",
|
|
7975
|
+
"items": {
|
|
7976
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo"
|
|
7977
|
+
},
|
|
7978
|
+
"type": "array"
|
|
7979
|
+
},
|
|
7980
|
+
"title": {
|
|
7981
|
+
"description": "Title.",
|
|
7982
|
+
"type": "string"
|
|
7983
|
+
},
|
|
7984
|
+
"uri": {
|
|
7985
|
+
"description": "URI for the document.",
|
|
7986
|
+
"type": "string"
|
|
7987
|
+
}
|
|
7988
|
+
},
|
|
7989
|
+
"type": "object"
|
|
7990
|
+
},
|
|
7991
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": {
|
|
7992
|
+
"description": "Chunk information.",
|
|
7993
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo",
|
|
7994
|
+
"properties": {
|
|
7995
|
+
"chunk": {
|
|
7996
|
+
"description": "Chunk resource name.",
|
|
7997
|
+
"type": "string"
|
|
7998
|
+
},
|
|
7999
|
+
"content": {
|
|
8000
|
+
"description": "Chunk textual content.",
|
|
8001
|
+
"type": "string"
|
|
8002
|
+
},
|
|
8003
|
+
"relevanceScore": {
|
|
8004
|
+
"description": "Relevance score.",
|
|
8005
|
+
"format": "float",
|
|
8006
|
+
"type": "number"
|
|
8007
|
+
}
|
|
8008
|
+
},
|
|
8009
|
+
"type": "object"
|
|
8010
|
+
},
|
|
8011
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": {
|
|
8012
|
+
"description": "Snippet information.",
|
|
8013
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo",
|
|
8014
|
+
"properties": {
|
|
8015
|
+
"snippet": {
|
|
8016
|
+
"description": "Snippet content.",
|
|
8017
|
+
"type": "string"
|
|
8018
|
+
},
|
|
8019
|
+
"snippetStatus": {
|
|
8020
|
+
"description": "Status of the snippet defined by the search team.",
|
|
8021
|
+
"type": "string"
|
|
8022
|
+
}
|
|
8023
|
+
},
|
|
8024
|
+
"type": "object"
|
|
8025
|
+
},
|
|
8026
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": {
|
|
8027
|
+
"description": "Search action.",
|
|
8028
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction",
|
|
8029
|
+
"properties": {
|
|
8030
|
+
"query": {
|
|
8031
|
+
"description": "The query to search.",
|
|
8032
|
+
"type": "string"
|
|
8033
|
+
}
|
|
8034
|
+
},
|
|
8035
|
+
"type": "object"
|
|
8036
|
+
},
|
|
8037
|
+
"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": {
|
|
8038
|
+
"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
8039
|
+
"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata",
|
|
8040
|
+
"properties": {
|
|
8041
|
+
"createTime": {
|
|
8042
|
+
"description": "Operation create time.",
|
|
8043
|
+
"format": "google-datetime",
|
|
8044
|
+
"type": "string"
|
|
8045
|
+
},
|
|
8046
|
+
"updateTime": {
|
|
8047
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
8048
|
+
"format": "google-datetime",
|
|
8049
|
+
"type": "string"
|
|
8050
|
+
}
|
|
8051
|
+
},
|
|
8052
|
+
"type": "object"
|
|
8053
|
+
},
|
|
8054
|
+
"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest": {
|
|
8055
|
+
"description": "Request message for SiteSearchEngineService.BatchCreateTargetSites method.",
|
|
8056
|
+
"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest",
|
|
8057
|
+
"properties": {
|
|
8058
|
+
"requests": {
|
|
8059
|
+
"description": "Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.",
|
|
8060
|
+
"items": {
|
|
8061
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest"
|
|
8062
|
+
},
|
|
8063
|
+
"type": "array"
|
|
8064
|
+
}
|
|
8065
|
+
},
|
|
8066
|
+
"type": "object"
|
|
8067
|
+
},
|
|
8068
|
+
"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": {
|
|
8069
|
+
"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.",
|
|
8070
|
+
"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse",
|
|
8071
|
+
"properties": {
|
|
8072
|
+
"targetSites": {
|
|
8073
|
+
"description": "TargetSites created.",
|
|
8074
|
+
"items": {
|
|
8075
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite"
|
|
8076
|
+
},
|
|
8077
|
+
"type": "array"
|
|
8078
|
+
}
|
|
8079
|
+
},
|
|
8080
|
+
"type": "object"
|
|
8081
|
+
},
|
|
8082
|
+
"GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest": {
|
|
8083
|
+
"description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.",
|
|
8084
|
+
"id": "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest",
|
|
8085
|
+
"properties": {},
|
|
8086
|
+
"type": "object"
|
|
8087
|
+
},
|
|
8088
|
+
"GoogleCloudDiscoveryengineV1alphaBigQuerySource": {
|
|
8089
|
+
"description": "BigQuery source import data from.",
|
|
8090
|
+
"id": "GoogleCloudDiscoveryengineV1alphaBigQuerySource",
|
|
8091
|
+
"properties": {
|
|
8092
|
+
"dataSchema": {
|
|
8093
|
+
"description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.",
|
|
8094
|
+
"type": "string"
|
|
8095
|
+
},
|
|
8096
|
+
"datasetId": {
|
|
8097
|
+
"description": "Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.",
|
|
8098
|
+
"type": "string"
|
|
8099
|
+
},
|
|
8100
|
+
"gcsStagingDir": {
|
|
8101
|
+
"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.",
|
|
8102
|
+
"type": "string"
|
|
8103
|
+
},
|
|
8104
|
+
"partitionDate": {
|
|
8105
|
+
"$ref": "GoogleTypeDate",
|
|
8106
|
+
"description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format."
|
|
8107
|
+
},
|
|
8108
|
+
"projectId": {
|
|
8109
|
+
"description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
|
|
8110
|
+
"type": "string"
|
|
8111
|
+
},
|
|
8112
|
+
"tableId": {
|
|
8113
|
+
"description": "Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.",
|
|
8114
|
+
"type": "string"
|
|
8115
|
+
}
|
|
8116
|
+
},
|
|
8117
|
+
"type": "object"
|
|
8118
|
+
},
|
|
8119
|
+
"GoogleCloudDiscoveryengineV1alphaBigtableOptions": {
|
|
8120
|
+
"description": "The Bigtable Options object that contains information to support the import.",
|
|
8121
|
+
"id": "GoogleCloudDiscoveryengineV1alphaBigtableOptions",
|
|
8122
|
+
"properties": {
|
|
8123
|
+
"families": {
|
|
8124
|
+
"additionalProperties": {
|
|
8125
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily"
|
|
8126
|
+
},
|
|
8127
|
+
"description": "The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.",
|
|
8128
|
+
"type": "object"
|
|
8129
|
+
},
|
|
8130
|
+
"keyFieldName": {
|
|
8131
|
+
"description": "The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`.",
|
|
8132
|
+
"type": "string"
|
|
8133
|
+
}
|
|
8134
|
+
},
|
|
8135
|
+
"type": "object"
|
|
8136
|
+
},
|
|
8137
|
+
"GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn": {
|
|
8138
|
+
"description": "The column of the Bigtable.",
|
|
8139
|
+
"id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn",
|
|
8140
|
+
"properties": {
|
|
8141
|
+
"encoding": {
|
|
8142
|
+
"description": "The encoding mode of the values when the type is not `STRING`. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.",
|
|
8143
|
+
"enum": [
|
|
8144
|
+
"ENCODING_UNSPECIFIED",
|
|
8145
|
+
"TEXT",
|
|
8146
|
+
"BINARY"
|
|
8147
|
+
],
|
|
8148
|
+
"enumDescriptions": [
|
|
8149
|
+
"The encoding is unspecified.",
|
|
8150
|
+
"Text encoding.",
|
|
8151
|
+
"Binary encoding."
|
|
8152
|
+
],
|
|
8153
|
+
"type": "string"
|
|
8154
|
+
},
|
|
8155
|
+
"fieldName": {
|
|
8156
|
+
"description": "The field name to use for this column in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.",
|
|
8157
|
+
"type": "string"
|
|
8158
|
+
},
|
|
8159
|
+
"qualifier": {
|
|
8160
|
+
"description": "Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.",
|
|
8161
|
+
"format": "byte",
|
|
8162
|
+
"type": "string"
|
|
8163
|
+
},
|
|
8164
|
+
"type": {
|
|
8165
|
+
"description": "The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.",
|
|
8166
|
+
"enum": [
|
|
8167
|
+
"TYPE_UNSPECIFIED",
|
|
8168
|
+
"STRING",
|
|
8169
|
+
"NUMBER",
|
|
8170
|
+
"INTEGER",
|
|
8171
|
+
"VAR_INTEGER",
|
|
8172
|
+
"BIG_NUMERIC",
|
|
8173
|
+
"BOOLEAN",
|
|
8174
|
+
"JSON"
|
|
8175
|
+
],
|
|
8176
|
+
"enumDescriptions": [
|
|
8177
|
+
"The type is unspecified.",
|
|
8178
|
+
"String type.",
|
|
8179
|
+
"Numerical type.",
|
|
8180
|
+
"Integer type.",
|
|
8181
|
+
"Variable length integer type.",
|
|
8182
|
+
"BigDecimal type.",
|
|
8183
|
+
"Boolean type.",
|
|
8184
|
+
"JSON type."
|
|
8185
|
+
],
|
|
8186
|
+
"type": "string"
|
|
8187
|
+
}
|
|
8188
|
+
},
|
|
8189
|
+
"type": "object"
|
|
8190
|
+
},
|
|
8191
|
+
"GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily": {
|
|
8192
|
+
"description": "The column family of the Bigtable.",
|
|
8193
|
+
"id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily",
|
|
8194
|
+
"properties": {
|
|
8195
|
+
"columns": {
|
|
8196
|
+
"description": "The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.",
|
|
8197
|
+
"items": {
|
|
8198
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn"
|
|
8199
|
+
},
|
|
8200
|
+
"type": "array"
|
|
8201
|
+
},
|
|
8202
|
+
"encoding": {
|
|
8203
|
+
"description": "The encoding mode of the values when the type is not STRING. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.",
|
|
8204
|
+
"enum": [
|
|
8205
|
+
"ENCODING_UNSPECIFIED",
|
|
8206
|
+
"TEXT",
|
|
8207
|
+
"BINARY"
|
|
8208
|
+
],
|
|
8209
|
+
"enumDescriptions": [
|
|
8210
|
+
"The encoding is unspecified.",
|
|
8211
|
+
"Text encoding.",
|
|
8212
|
+
"Binary encoding."
|
|
8213
|
+
],
|
|
8214
|
+
"type": "string"
|
|
8215
|
+
},
|
|
8216
|
+
"fieldName": {
|
|
8217
|
+
"description": "The field name to use for this column family in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.",
|
|
8218
|
+
"type": "string"
|
|
8219
|
+
},
|
|
8220
|
+
"type": {
|
|
8221
|
+
"description": "The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.",
|
|
8222
|
+
"enum": [
|
|
8223
|
+
"TYPE_UNSPECIFIED",
|
|
8224
|
+
"STRING",
|
|
8225
|
+
"NUMBER",
|
|
8226
|
+
"INTEGER",
|
|
8227
|
+
"VAR_INTEGER",
|
|
8228
|
+
"BIG_NUMERIC",
|
|
8229
|
+
"BOOLEAN",
|
|
8230
|
+
"JSON"
|
|
8231
|
+
],
|
|
8232
|
+
"enumDescriptions": [
|
|
8233
|
+
"The type is unspecified.",
|
|
8234
|
+
"String type.",
|
|
8235
|
+
"Numerical type.",
|
|
8236
|
+
"Integer type.",
|
|
8237
|
+
"Variable length integer type.",
|
|
8238
|
+
"BigDecimal type.",
|
|
8239
|
+
"Boolean type.",
|
|
8240
|
+
"JSON type."
|
|
8241
|
+
],
|
|
8242
|
+
"type": "string"
|
|
8243
|
+
}
|
|
8244
|
+
},
|
|
8245
|
+
"type": "object"
|
|
8246
|
+
},
|
|
8247
|
+
"GoogleCloudDiscoveryengineV1alphaBigtableSource": {
|
|
8248
|
+
"description": "The Cloud Bigtable source for importing data.",
|
|
8249
|
+
"id": "GoogleCloudDiscoveryengineV1alphaBigtableSource",
|
|
8250
|
+
"properties": {
|
|
8251
|
+
"bigtableOptions": {
|
|
8252
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptions",
|
|
8253
|
+
"description": "Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations."
|
|
8254
|
+
},
|
|
8255
|
+
"instanceId": {
|
|
8256
|
+
"description": "Required. The instance ID of the Cloud Bigtable that needs to be imported.",
|
|
6326
8257
|
"type": "string"
|
|
6327
8258
|
},
|
|
6328
|
-
"
|
|
6329
|
-
"description": "
|
|
6330
|
-
"
|
|
8259
|
+
"projectId": {
|
|
8260
|
+
"description": "The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
|
|
8261
|
+
"type": "string"
|
|
8262
|
+
},
|
|
8263
|
+
"tableId": {
|
|
8264
|
+
"description": "Required. The table ID of the Cloud Bigtable that needs to be imported.",
|
|
6331
8265
|
"type": "string"
|
|
6332
8266
|
}
|
|
6333
8267
|
},
|
|
6334
8268
|
"type": "object"
|
|
6335
8269
|
},
|
|
6336
|
-
"
|
|
6337
|
-
"description": "Request message for
|
|
6338
|
-
"id": "
|
|
8270
|
+
"GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest": {
|
|
8271
|
+
"description": "Request message for GroundedGenerationService.CheckGrounding method.",
|
|
8272
|
+
"id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest",
|
|
6339
8273
|
"properties": {
|
|
6340
|
-
"
|
|
6341
|
-
"description": "
|
|
8274
|
+
"answerCandidate": {
|
|
8275
|
+
"description": "Answer candidate to check.",
|
|
8276
|
+
"type": "string"
|
|
8277
|
+
},
|
|
8278
|
+
"facts": {
|
|
8279
|
+
"description": "List of facts for the grounding check. We support up to 200 facts.",
|
|
6342
8280
|
"items": {
|
|
6343
|
-
"$ref": "
|
|
8281
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGroundingFact"
|
|
6344
8282
|
},
|
|
6345
8283
|
"type": "array"
|
|
8284
|
+
},
|
|
8285
|
+
"groundingSpec": {
|
|
8286
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec",
|
|
8287
|
+
"description": "Configuration of the grounding check."
|
|
6346
8288
|
}
|
|
6347
8289
|
},
|
|
6348
8290
|
"type": "object"
|
|
6349
8291
|
},
|
|
6350
|
-
"
|
|
6351
|
-
"description": "Response message for
|
|
6352
|
-
"id": "
|
|
8292
|
+
"GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse": {
|
|
8293
|
+
"description": "Response message for the GroundedGenerationService.CheckGrounding method.",
|
|
8294
|
+
"id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse",
|
|
6353
8295
|
"properties": {
|
|
6354
|
-
"
|
|
6355
|
-
"description": "
|
|
8296
|
+
"citedChunks": {
|
|
8297
|
+
"description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.",
|
|
6356
8298
|
"items": {
|
|
6357
|
-
"$ref": "
|
|
8299
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaFactChunk"
|
|
6358
8300
|
},
|
|
6359
8301
|
"type": "array"
|
|
6360
|
-
}
|
|
6361
8302
|
},
|
|
6362
|
-
"
|
|
8303
|
+
"claims": {
|
|
8304
|
+
"description": "Claim texts and citation info across all claims in the answer candidate.",
|
|
8305
|
+
"items": {
|
|
8306
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim"
|
|
8307
|
+
},
|
|
8308
|
+
"type": "array"
|
|
8309
|
+
},
|
|
8310
|
+
"supportScore": {
|
|
8311
|
+
"description": "The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.",
|
|
8312
|
+
"format": "float",
|
|
8313
|
+
"type": "number"
|
|
8314
|
+
}
|
|
6363
8315
|
},
|
|
6364
|
-
"GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest": {
|
|
6365
|
-
"description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.",
|
|
6366
|
-
"id": "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest",
|
|
6367
|
-
"properties": {},
|
|
6368
8316
|
"type": "object"
|
|
6369
8317
|
},
|
|
6370
|
-
"
|
|
6371
|
-
"description": "
|
|
6372
|
-
"id": "
|
|
8318
|
+
"GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim": {
|
|
8319
|
+
"description": "Text and citation info for a claim in the answer candidate.",
|
|
8320
|
+
"id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim",
|
|
6373
8321
|
"properties": {
|
|
6374
|
-
"
|
|
6375
|
-
"description": "
|
|
6376
|
-
"
|
|
8322
|
+
"citationIndices": {
|
|
8323
|
+
"description": "A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact.",
|
|
8324
|
+
"items": {
|
|
8325
|
+
"format": "int32",
|
|
8326
|
+
"type": "integer"
|
|
6377
8327
|
},
|
|
6378
|
-
"
|
|
6379
|
-
"description": "Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.",
|
|
6380
|
-
"type": "string"
|
|
8328
|
+
"type": "array"
|
|
6381
8329
|
},
|
|
6382
|
-
"
|
|
6383
|
-
"description": "
|
|
8330
|
+
"claimText": {
|
|
8331
|
+
"description": "Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.",
|
|
6384
8332
|
"type": "string"
|
|
6385
8333
|
},
|
|
6386
|
-
"
|
|
6387
|
-
"
|
|
6388
|
-
"
|
|
8334
|
+
"endPos": {
|
|
8335
|
+
"description": "Position indicating the end of the claim in the answer candidate, exclusive.",
|
|
8336
|
+
"format": "int32",
|
|
8337
|
+
"type": "integer"
|
|
6389
8338
|
},
|
|
6390
|
-
"
|
|
6391
|
-
"description": "
|
|
6392
|
-
"
|
|
8339
|
+
"startPos": {
|
|
8340
|
+
"description": "Position indicating the start of the claim in the answer candidate, measured in bytes.",
|
|
8341
|
+
"format": "int32",
|
|
8342
|
+
"type": "integer"
|
|
8343
|
+
}
|
|
6393
8344
|
},
|
|
6394
|
-
"
|
|
6395
|
-
|
|
6396
|
-
"
|
|
8345
|
+
"type": "object"
|
|
8346
|
+
},
|
|
8347
|
+
"GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec": {
|
|
8348
|
+
"description": "Specification for the grounding check.",
|
|
8349
|
+
"id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec",
|
|
8350
|
+
"properties": {
|
|
8351
|
+
"citationThreshold": {
|
|
8352
|
+
"description": "The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.",
|
|
8353
|
+
"format": "double",
|
|
8354
|
+
"type": "number"
|
|
6397
8355
|
}
|
|
6398
8356
|
},
|
|
6399
8357
|
"type": "object"
|
|
@@ -6402,6 +8360,11 @@
|
|
|
6402
8360
|
"description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.",
|
|
6403
8361
|
"id": "GoogleCloudDiscoveryengineV1alphaChunk",
|
|
6404
8362
|
"properties": {
|
|
8363
|
+
"chunkMetadata": {
|
|
8364
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata",
|
|
8365
|
+
"description": "Output only. Metadata of the current chunk.",
|
|
8366
|
+
"readOnly": true
|
|
8367
|
+
},
|
|
6405
8368
|
"content": {
|
|
6406
8369
|
"description": "Content is a string from a document (parsed content).",
|
|
6407
8370
|
"type": "string"
|
|
@@ -6420,12 +8383,37 @@
|
|
|
6420
8383
|
"description": "Metadata of the document from the current chunk."
|
|
6421
8384
|
},
|
|
6422
8385
|
"id": {
|
|
6423
|
-
"description": "Unique chunk
|
|
8386
|
+
"description": "Unique chunk ID of the current chunk.",
|
|
6424
8387
|
"type": "string"
|
|
6425
8388
|
},
|
|
6426
8389
|
"name": {
|
|
6427
8390
|
"description": "The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
6428
8391
|
"type": "string"
|
|
8392
|
+
},
|
|
8393
|
+
"pageSpan": {
|
|
8394
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan",
|
|
8395
|
+
"description": "Page span of the chunk."
|
|
8396
|
+
}
|
|
8397
|
+
},
|
|
8398
|
+
"type": "object"
|
|
8399
|
+
},
|
|
8400
|
+
"GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata": {
|
|
8401
|
+
"description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.",
|
|
8402
|
+
"id": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata",
|
|
8403
|
+
"properties": {
|
|
8404
|
+
"nextChunks": {
|
|
8405
|
+
"description": "The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API.",
|
|
8406
|
+
"items": {
|
|
8407
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaChunk"
|
|
8408
|
+
},
|
|
8409
|
+
"type": "array"
|
|
8410
|
+
},
|
|
8411
|
+
"previousChunks": {
|
|
8412
|
+
"description": "The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API.",
|
|
8413
|
+
"items": {
|
|
8414
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaChunk"
|
|
8415
|
+
},
|
|
8416
|
+
"type": "array"
|
|
6429
8417
|
}
|
|
6430
8418
|
},
|
|
6431
8419
|
"type": "object"
|
|
@@ -6434,6 +8422,14 @@
|
|
|
6434
8422
|
"description": "Document metadata contains the information of the document of the current chunk.",
|
|
6435
8423
|
"id": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata",
|
|
6436
8424
|
"properties": {
|
|
8425
|
+
"structData": {
|
|
8426
|
+
"additionalProperties": {
|
|
8427
|
+
"description": "Properties of the object.",
|
|
8428
|
+
"type": "any"
|
|
8429
|
+
},
|
|
8430
|
+
"description": "Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.",
|
|
8431
|
+
"type": "object"
|
|
8432
|
+
},
|
|
6437
8433
|
"title": {
|
|
6438
8434
|
"description": "Title of the document.",
|
|
6439
8435
|
"type": "string"
|
|
@@ -6445,6 +8441,54 @@
|
|
|
6445
8441
|
},
|
|
6446
8442
|
"type": "object"
|
|
6447
8443
|
},
|
|
8444
|
+
"GoogleCloudDiscoveryengineV1alphaChunkPageSpan": {
|
|
8445
|
+
"description": "Page span of the chunk.",
|
|
8446
|
+
"id": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan",
|
|
8447
|
+
"properties": {
|
|
8448
|
+
"pageEnd": {
|
|
8449
|
+
"description": "The end page of the chunk.",
|
|
8450
|
+
"format": "int32",
|
|
8451
|
+
"type": "integer"
|
|
8452
|
+
},
|
|
8453
|
+
"pageStart": {
|
|
8454
|
+
"description": "The start page of the chunk.",
|
|
8455
|
+
"format": "int32",
|
|
8456
|
+
"type": "integer"
|
|
8457
|
+
}
|
|
8458
|
+
},
|
|
8459
|
+
"type": "object"
|
|
8460
|
+
},
|
|
8461
|
+
"GoogleCloudDiscoveryengineV1alphaCloudSqlSource": {
|
|
8462
|
+
"description": "Cloud SQL source import data from.",
|
|
8463
|
+
"id": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource",
|
|
8464
|
+
"properties": {
|
|
8465
|
+
"databaseId": {
|
|
8466
|
+
"description": "Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.",
|
|
8467
|
+
"type": "string"
|
|
8468
|
+
},
|
|
8469
|
+
"gcsStagingDir": {
|
|
8470
|
+
"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.",
|
|
8471
|
+
"type": "string"
|
|
8472
|
+
},
|
|
8473
|
+
"instanceId": {
|
|
8474
|
+
"description": "Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.",
|
|
8475
|
+
"type": "string"
|
|
8476
|
+
},
|
|
8477
|
+
"offload": {
|
|
8478
|
+
"description": "Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless).",
|
|
8479
|
+
"type": "boolean"
|
|
8480
|
+
},
|
|
8481
|
+
"projectId": {
|
|
8482
|
+
"description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
|
|
8483
|
+
"type": "string"
|
|
8484
|
+
},
|
|
8485
|
+
"tableId": {
|
|
8486
|
+
"description": "Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.",
|
|
8487
|
+
"type": "string"
|
|
8488
|
+
}
|
|
8489
|
+
},
|
|
8490
|
+
"type": "object"
|
|
8491
|
+
},
|
|
6448
8492
|
"GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest": {
|
|
6449
8493
|
"description": "Request message for CompletionService.CompleteQuery method.",
|
|
6450
8494
|
"id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest",
|
|
@@ -6542,7 +8586,7 @@
|
|
|
6542
8586
|
"type": "array"
|
|
6543
8587
|
},
|
|
6544
8588
|
"name": {
|
|
6545
|
-
"description": "Immutable. Fully qualified name `project
|
|
8589
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.",
|
|
6546
8590
|
"type": "string"
|
|
6547
8591
|
},
|
|
6548
8592
|
"startTime": {
|
|
@@ -6855,12 +8899,14 @@
|
|
|
6855
8899
|
"enum": [
|
|
6856
8900
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
6857
8901
|
"GENERIC",
|
|
6858
|
-
"MEDIA"
|
|
8902
|
+
"MEDIA",
|
|
8903
|
+
"HEALTHCARE_FHIR"
|
|
6859
8904
|
],
|
|
6860
8905
|
"enumDescriptions": [
|
|
6861
8906
|
"Value used when unset.",
|
|
6862
8907
|
"The generic vertical for documents that are not specific to any industry vertical.",
|
|
6863
|
-
"The media industry vertical."
|
|
8908
|
+
"The media industry vertical.",
|
|
8909
|
+
"The healthcare FHIR vertical."
|
|
6864
8910
|
],
|
|
6865
8911
|
"type": "string"
|
|
6866
8912
|
},
|
|
@@ -6875,13 +8921,15 @@
|
|
|
6875
8921
|
"SOLUTION_TYPE_UNSPECIFIED",
|
|
6876
8922
|
"SOLUTION_TYPE_RECOMMENDATION",
|
|
6877
8923
|
"SOLUTION_TYPE_SEARCH",
|
|
6878
|
-
"SOLUTION_TYPE_CHAT"
|
|
8924
|
+
"SOLUTION_TYPE_CHAT",
|
|
8925
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
6879
8926
|
],
|
|
6880
8927
|
"enumDescriptions": [
|
|
6881
8928
|
"Default value.",
|
|
6882
8929
|
"Used for Recommendations AI.",
|
|
6883
8930
|
"Used for Discovery Search.",
|
|
6884
|
-
"Used for use cases related to the Generative AI agent."
|
|
8931
|
+
"Used for use cases related to the Generative AI agent.",
|
|
8932
|
+
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
|
|
6885
8933
|
],
|
|
6886
8934
|
"type": "string"
|
|
6887
8935
|
},
|
|
@@ -7217,7 +9265,8 @@
|
|
|
7217
9265
|
"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig",
|
|
7218
9266
|
"properties": {
|
|
7219
9267
|
"enhancedDocumentElements": {
|
|
7220
|
-
"
|
|
9268
|
+
"deprecated": true,
|
|
9269
|
+
"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.",
|
|
7221
9270
|
"items": {
|
|
7222
9271
|
"type": "string"
|
|
7223
9272
|
},
|
|
@@ -7324,12 +9373,14 @@
|
|
|
7324
9373
|
"enum": [
|
|
7325
9374
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
7326
9375
|
"GENERIC",
|
|
7327
|
-
"MEDIA"
|
|
9376
|
+
"MEDIA",
|
|
9377
|
+
"HEALTHCARE_FHIR"
|
|
7328
9378
|
],
|
|
7329
9379
|
"enumDescriptions": [
|
|
7330
9380
|
"Value used when unset.",
|
|
7331
9381
|
"The generic vertical for documents that are not specific to any industry vertical.",
|
|
7332
|
-
"The media industry vertical."
|
|
9382
|
+
"The media industry vertical.",
|
|
9383
|
+
"The healthcare FHIR vertical."
|
|
7333
9384
|
],
|
|
7334
9385
|
"type": "string"
|
|
7335
9386
|
},
|
|
@@ -7360,13 +9411,15 @@
|
|
|
7360
9411
|
"SOLUTION_TYPE_UNSPECIFIED",
|
|
7361
9412
|
"SOLUTION_TYPE_RECOMMENDATION",
|
|
7362
9413
|
"SOLUTION_TYPE_SEARCH",
|
|
7363
|
-
"SOLUTION_TYPE_CHAT"
|
|
9414
|
+
"SOLUTION_TYPE_CHAT",
|
|
9415
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
7364
9416
|
],
|
|
7365
9417
|
"enumDescriptions": [
|
|
7366
9418
|
"Default value.",
|
|
7367
9419
|
"Used for Recommendations AI.",
|
|
7368
9420
|
"Used for Discovery Search.",
|
|
7369
|
-
"Used for use cases related to the Generative AI agent."
|
|
9421
|
+
"Used for use cases related to the Generative AI agent.",
|
|
9422
|
+
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
|
|
7370
9423
|
],
|
|
7371
9424
|
"type": "string"
|
|
7372
9425
|
},
|
|
@@ -7388,7 +9441,7 @@
|
|
|
7388
9441
|
"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
|
|
7389
9442
|
},
|
|
7390
9443
|
"dialogflowAgentToLink": {
|
|
7391
|
-
"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
9444
|
+
"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
|
|
7392
9445
|
"type": "string"
|
|
7393
9446
|
}
|
|
7394
9447
|
},
|
|
@@ -7558,7 +9611,7 @@
|
|
|
7558
9611
|
"type": "array"
|
|
7559
9612
|
},
|
|
7560
9613
|
"searchTier": {
|
|
7561
|
-
"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
9614
|
+
"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.",
|
|
7562
9615
|
"enum": [
|
|
7563
9616
|
"SEARCH_TIER_UNSPECIFIED",
|
|
7564
9617
|
"SEARCH_TIER_STANDARD",
|
|
@@ -7672,6 +9725,28 @@
|
|
|
7672
9725
|
},
|
|
7673
9726
|
"type": "object"
|
|
7674
9727
|
},
|
|
9728
|
+
"GoogleCloudDiscoveryengineV1alphaFactChunk": {
|
|
9729
|
+
"description": "Fact Chunk.",
|
|
9730
|
+
"id": "GoogleCloudDiscoveryengineV1alphaFactChunk",
|
|
9731
|
+
"properties": {
|
|
9732
|
+
"chunkText": {
|
|
9733
|
+
"description": "Text content of the fact chunk. Can be at most 10K characters long.",
|
|
9734
|
+
"type": "string"
|
|
9735
|
+
},
|
|
9736
|
+
"source": {
|
|
9737
|
+
"description": "Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.",
|
|
9738
|
+
"type": "string"
|
|
9739
|
+
},
|
|
9740
|
+
"sourceMetadata": {
|
|
9741
|
+
"additionalProperties": {
|
|
9742
|
+
"type": "string"
|
|
9743
|
+
},
|
|
9744
|
+
"description": "More fine-grained information for the source reference.",
|
|
9745
|
+
"type": "object"
|
|
9746
|
+
}
|
|
9747
|
+
},
|
|
9748
|
+
"type": "object"
|
|
9749
|
+
},
|
|
7675
9750
|
"GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": {
|
|
7676
9751
|
"description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.",
|
|
7677
9752
|
"id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse",
|
|
@@ -7695,10 +9770,42 @@
|
|
|
7695
9770
|
},
|
|
7696
9771
|
"type": "object"
|
|
7697
9772
|
},
|
|
9773
|
+
"GoogleCloudDiscoveryengineV1alphaFhirStoreSource": {
|
|
9774
|
+
"description": "Cloud FhirStore source import data from.",
|
|
9775
|
+
"id": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource",
|
|
9776
|
+
"properties": {
|
|
9777
|
+
"fhirStore": {
|
|
9778
|
+
"description": "Required. The full resource name of the FHIR store to import data from, in the format of `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.",
|
|
9779
|
+
"type": "string"
|
|
9780
|
+
},
|
|
9781
|
+
"gcsStagingDir": {
|
|
9782
|
+
"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory.",
|
|
9783
|
+
"type": "string"
|
|
9784
|
+
}
|
|
9785
|
+
},
|
|
9786
|
+
"type": "object"
|
|
9787
|
+
},
|
|
7698
9788
|
"GoogleCloudDiscoveryengineV1alphaFieldConfig": {
|
|
7699
9789
|
"description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.",
|
|
7700
9790
|
"id": "GoogleCloudDiscoveryengineV1alphaFieldConfig",
|
|
7701
9791
|
"properties": {
|
|
9792
|
+
"advancedSiteSearchDataSources": {
|
|
9793
|
+
"description": "If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.",
|
|
9794
|
+
"items": {
|
|
9795
|
+
"enum": [
|
|
9796
|
+
"ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED",
|
|
9797
|
+
"METATAGS",
|
|
9798
|
+
"PAGEMAP"
|
|
9799
|
+
],
|
|
9800
|
+
"enumDescriptions": [
|
|
9801
|
+
"Value used when unset.",
|
|
9802
|
+
"Retrieve value from meta tag.",
|
|
9803
|
+
"Retrieve value from page map."
|
|
9804
|
+
],
|
|
9805
|
+
"type": "string"
|
|
9806
|
+
},
|
|
9807
|
+
"type": "array"
|
|
9808
|
+
},
|
|
7702
9809
|
"completableOption": {
|
|
7703
9810
|
"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.",
|
|
7704
9811
|
"enum": [
|
|
@@ -7820,12 +9927,35 @@
|
|
|
7820
9927
|
},
|
|
7821
9928
|
"type": "object"
|
|
7822
9929
|
},
|
|
9930
|
+
"GoogleCloudDiscoveryengineV1alphaFirestoreSource": {
|
|
9931
|
+
"description": "Firestore source import data from.",
|
|
9932
|
+
"id": "GoogleCloudDiscoveryengineV1alphaFirestoreSource",
|
|
9933
|
+
"properties": {
|
|
9934
|
+
"collectionId": {
|
|
9935
|
+
"description": "Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.",
|
|
9936
|
+
"type": "string"
|
|
9937
|
+
},
|
|
9938
|
+
"databaseId": {
|
|
9939
|
+
"description": "Required. The Firestore database to copy the data from with a length limit of 256 characters.",
|
|
9940
|
+
"type": "string"
|
|
9941
|
+
},
|
|
9942
|
+
"gcsStagingDir": {
|
|
9943
|
+
"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.",
|
|
9944
|
+
"type": "string"
|
|
9945
|
+
},
|
|
9946
|
+
"projectId": {
|
|
9947
|
+
"description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
|
|
9948
|
+
"type": "string"
|
|
9949
|
+
}
|
|
9950
|
+
},
|
|
9951
|
+
"type": "object"
|
|
9952
|
+
},
|
|
7823
9953
|
"GoogleCloudDiscoveryengineV1alphaGcsSource": {
|
|
7824
9954
|
"description": "Cloud Storage location for input content.",
|
|
7825
9955
|
"id": "GoogleCloudDiscoveryengineV1alphaGcsSource",
|
|
7826
9956
|
"properties": {
|
|
7827
9957
|
"dataSchema": {
|
|
7828
|
-
"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
|
|
9958
|
+
"description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.",
|
|
7829
9959
|
"type": "string"
|
|
7830
9960
|
},
|
|
7831
9961
|
"inputUris": {
|
|
@@ -7838,6 +9968,24 @@
|
|
|
7838
9968
|
},
|
|
7839
9969
|
"type": "object"
|
|
7840
9970
|
},
|
|
9971
|
+
"GoogleCloudDiscoveryengineV1alphaGroundingFact": {
|
|
9972
|
+
"description": "Grounding Fact.",
|
|
9973
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGroundingFact",
|
|
9974
|
+
"properties": {
|
|
9975
|
+
"attributes": {
|
|
9976
|
+
"additionalProperties": {
|
|
9977
|
+
"type": "string"
|
|
9978
|
+
},
|
|
9979
|
+
"description": "Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on.",
|
|
9980
|
+
"type": "object"
|
|
9981
|
+
},
|
|
9982
|
+
"factText": {
|
|
9983
|
+
"description": "Text content of the fact. Can be at most 10K characters long.",
|
|
9984
|
+
"type": "string"
|
|
9985
|
+
}
|
|
9986
|
+
},
|
|
9987
|
+
"type": "object"
|
|
9988
|
+
},
|
|
7841
9989
|
"GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec": {
|
|
7842
9990
|
"description": "Defines guided search spec.",
|
|
7843
9991
|
"id": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec",
|
|
@@ -7913,6 +10061,11 @@
|
|
|
7913
10061
|
"format": "int64",
|
|
7914
10062
|
"type": "string"
|
|
7915
10063
|
},
|
|
10064
|
+
"totalCount": {
|
|
10065
|
+
"description": "Total count of entries that were processed.",
|
|
10066
|
+
"format": "int64",
|
|
10067
|
+
"type": "string"
|
|
10068
|
+
},
|
|
7916
10069
|
"updateTime": {
|
|
7917
10070
|
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
7918
10071
|
"format": "google-datetime",
|
|
@@ -7926,23 +10079,39 @@
|
|
|
7926
10079
|
"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest",
|
|
7927
10080
|
"properties": {
|
|
7928
10081
|
"autoGenerateIds": {
|
|
7929
|
-
"description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported.
|
|
10082
|
+
"description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.",
|
|
7930
10083
|
"type": "boolean"
|
|
7931
10084
|
},
|
|
7932
10085
|
"bigquerySource": {
|
|
7933
10086
|
"$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource",
|
|
7934
10087
|
"description": "BigQuery input source."
|
|
7935
10088
|
},
|
|
10089
|
+
"bigtableSource": {
|
|
10090
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaBigtableSource",
|
|
10091
|
+
"description": "Cloud Bigtable input source."
|
|
10092
|
+
},
|
|
10093
|
+
"cloudSqlSource": {
|
|
10094
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource",
|
|
10095
|
+
"description": "Cloud SQL input source."
|
|
10096
|
+
},
|
|
7936
10097
|
"errorConfig": {
|
|
7937
10098
|
"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig",
|
|
7938
10099
|
"description": "The desired location of errors incurred during the Import."
|
|
7939
10100
|
},
|
|
10101
|
+
"fhirStoreSource": {
|
|
10102
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource",
|
|
10103
|
+
"description": "FhirStore input source."
|
|
10104
|
+
},
|
|
10105
|
+
"firestoreSource": {
|
|
10106
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaFirestoreSource",
|
|
10107
|
+
"description": "Firestore input source."
|
|
10108
|
+
},
|
|
7940
10109
|
"gcsSource": {
|
|
7941
10110
|
"$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource",
|
|
7942
10111
|
"description": "Cloud Storage location for the input content."
|
|
7943
10112
|
},
|
|
7944
10113
|
"idField": {
|
|
7945
|
-
"description": "The field
|
|
10114
|
+
"description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.",
|
|
7946
10115
|
"type": "string"
|
|
7947
10116
|
},
|
|
7948
10117
|
"inlineSource": {
|
|
@@ -7962,6 +10131,15 @@
|
|
|
7962
10131
|
"Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location."
|
|
7963
10132
|
],
|
|
7964
10133
|
"type": "string"
|
|
10134
|
+
},
|
|
10135
|
+
"spannerSource": {
|
|
10136
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSpannerSource",
|
|
10137
|
+
"description": "Spanner input source."
|
|
10138
|
+
},
|
|
10139
|
+
"updateMask": {
|
|
10140
|
+
"description": "Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.",
|
|
10141
|
+
"format": "google-fieldmask",
|
|
10142
|
+
"type": "string"
|
|
7965
10143
|
}
|
|
7966
10144
|
},
|
|
7967
10145
|
"type": "object"
|
|
@@ -8324,6 +10502,24 @@
|
|
|
8324
10502
|
},
|
|
8325
10503
|
"type": "object"
|
|
8326
10504
|
},
|
|
10505
|
+
"GoogleCloudDiscoveryengineV1alphaListSessionsResponse": {
|
|
10506
|
+
"description": "Response for ListSessions method.",
|
|
10507
|
+
"id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse",
|
|
10508
|
+
"properties": {
|
|
10509
|
+
"nextPageToken": {
|
|
10510
|
+
"description": "Pagination token, if not returned indicates the last page.",
|
|
10511
|
+
"type": "string"
|
|
10512
|
+
},
|
|
10513
|
+
"sessions": {
|
|
10514
|
+
"description": "All the Sessions for a given data store.",
|
|
10515
|
+
"items": {
|
|
10516
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
10517
|
+
},
|
|
10518
|
+
"type": "array"
|
|
10519
|
+
}
|
|
10520
|
+
},
|
|
10521
|
+
"type": "object"
|
|
10522
|
+
},
|
|
8327
10523
|
"GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse": {
|
|
8328
10524
|
"description": "Response message for SiteSearchEngineService.ListTargetSites method.",
|
|
8329
10525
|
"id": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse",
|
|
@@ -8391,7 +10587,7 @@
|
|
|
8391
10587
|
"id": "GoogleCloudDiscoveryengineV1alphaPageInfo",
|
|
8392
10588
|
"properties": {
|
|
8393
10589
|
"pageCategory": {
|
|
8394
|
-
"description": "The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name,
|
|
10590
|
+
"description": "The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `\"pageCategory\" : \"Sales > 2017 Black Friday Deals\"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
8395
10591
|
"type": "string"
|
|
8396
10592
|
},
|
|
8397
10593
|
"pageviewId": {
|
|
@@ -8434,37 +10630,131 @@
|
|
|
8434
10630
|
},
|
|
8435
10631
|
"type": "object"
|
|
8436
10632
|
},
|
|
8437
|
-
"GoogleCloudDiscoveryengineV1alphaPauseEngineRequest": {
|
|
8438
|
-
"description": "Request for pausing training of an engine.",
|
|
8439
|
-
"id": "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest",
|
|
8440
|
-
"properties": {},
|
|
10633
|
+
"GoogleCloudDiscoveryengineV1alphaPauseEngineRequest": {
|
|
10634
|
+
"description": "Request for pausing training of an engine.",
|
|
10635
|
+
"id": "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest",
|
|
10636
|
+
"properties": {},
|
|
10637
|
+
"type": "object"
|
|
10638
|
+
},
|
|
10639
|
+
"GoogleCloudDiscoveryengineV1alphaPrincipal": {
|
|
10640
|
+
"description": "Principal identifier of a user or a group.",
|
|
10641
|
+
"id": "GoogleCloudDiscoveryengineV1alphaPrincipal",
|
|
10642
|
+
"properties": {
|
|
10643
|
+
"groupId": {
|
|
10644
|
+
"description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.",
|
|
10645
|
+
"type": "string"
|
|
10646
|
+
},
|
|
10647
|
+
"userId": {
|
|
10648
|
+
"description": "User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.",
|
|
10649
|
+
"type": "string"
|
|
10650
|
+
}
|
|
10651
|
+
},
|
|
10652
|
+
"type": "object"
|
|
10653
|
+
},
|
|
10654
|
+
"GoogleCloudDiscoveryengineV1alphaProcessedDocument": {
|
|
10655
|
+
"description": "Document captures all raw metadata information of items to be recommended or searched.",
|
|
10656
|
+
"id": "GoogleCloudDiscoveryengineV1alphaProcessedDocument",
|
|
10657
|
+
"properties": {
|
|
10658
|
+
"document": {
|
|
10659
|
+
"description": "Required. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.",
|
|
10660
|
+
"type": "string"
|
|
10661
|
+
},
|
|
10662
|
+
"jsonData": {
|
|
10663
|
+
"description": "The JSON string representation of the processed document.",
|
|
10664
|
+
"type": "string"
|
|
10665
|
+
}
|
|
10666
|
+
},
|
|
10667
|
+
"type": "object"
|
|
10668
|
+
},
|
|
10669
|
+
"GoogleCloudDiscoveryengineV1alphaProject": {
|
|
10670
|
+
"description": "Metadata and configurations for a Google Cloud project in the service.",
|
|
10671
|
+
"id": "GoogleCloudDiscoveryengineV1alphaProject",
|
|
10672
|
+
"properties": {
|
|
10673
|
+
"createTime": {
|
|
10674
|
+
"description": "Output only. The timestamp when this project is created.",
|
|
10675
|
+
"format": "google-datetime",
|
|
10676
|
+
"readOnly": true,
|
|
10677
|
+
"type": "string"
|
|
10678
|
+
},
|
|
10679
|
+
"name": {
|
|
10680
|
+
"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
|
|
10681
|
+
"readOnly": true,
|
|
10682
|
+
"type": "string"
|
|
10683
|
+
},
|
|
10684
|
+
"provisionCompletionTime": {
|
|
10685
|
+
"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.",
|
|
10686
|
+
"format": "google-datetime",
|
|
10687
|
+
"readOnly": true,
|
|
10688
|
+
"type": "string"
|
|
10689
|
+
},
|
|
10690
|
+
"serviceTermsMap": {
|
|
10691
|
+
"additionalProperties": {
|
|
10692
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms"
|
|
10693
|
+
},
|
|
10694
|
+
"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.",
|
|
10695
|
+
"readOnly": true,
|
|
10696
|
+
"type": "object"
|
|
10697
|
+
}
|
|
10698
|
+
},
|
|
8441
10699
|
"type": "object"
|
|
8442
10700
|
},
|
|
8443
|
-
"
|
|
8444
|
-
"description": "
|
|
8445
|
-
"id": "
|
|
10701
|
+
"GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": {
|
|
10702
|
+
"description": "Metadata about the terms of service.",
|
|
10703
|
+
"id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms",
|
|
8446
10704
|
"properties": {
|
|
8447
|
-
"
|
|
8448
|
-
"description": "
|
|
10705
|
+
"acceptTime": {
|
|
10706
|
+
"description": "The last time when the project agreed to the terms of service.",
|
|
10707
|
+
"format": "google-datetime",
|
|
8449
10708
|
"type": "string"
|
|
8450
10709
|
},
|
|
8451
|
-
"
|
|
8452
|
-
"description": "
|
|
10710
|
+
"declineTime": {
|
|
10711
|
+
"description": "The last time when the project declined or revoked the agreement to terms of service.",
|
|
10712
|
+
"format": "google-datetime",
|
|
10713
|
+
"type": "string"
|
|
10714
|
+
},
|
|
10715
|
+
"id": {
|
|
10716
|
+
"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.",
|
|
10717
|
+
"type": "string"
|
|
10718
|
+
},
|
|
10719
|
+
"state": {
|
|
10720
|
+
"description": "Whether the project has accepted/rejected the service terms or it is still pending.",
|
|
10721
|
+
"enum": [
|
|
10722
|
+
"STATE_UNSPECIFIED",
|
|
10723
|
+
"TERMS_ACCEPTED",
|
|
10724
|
+
"TERMS_PENDING",
|
|
10725
|
+
"TERMS_DECLINED"
|
|
10726
|
+
],
|
|
10727
|
+
"enumDescriptions": [
|
|
10728
|
+
"The default value of the enum. This value is not actually used.",
|
|
10729
|
+
"The project has given consent to the terms of service.",
|
|
10730
|
+
"The project is pending to review and accept the terms of service.",
|
|
10731
|
+
"The project has declined or revoked the agreement to terms of service."
|
|
10732
|
+
],
|
|
10733
|
+
"type": "string"
|
|
10734
|
+
},
|
|
10735
|
+
"version": {
|
|
10736
|
+
"description": "The version string of the terms of service. For acceptable values, see the comments for id above.",
|
|
8453
10737
|
"type": "string"
|
|
8454
10738
|
}
|
|
8455
10739
|
},
|
|
8456
10740
|
"type": "object"
|
|
8457
10741
|
},
|
|
8458
|
-
"
|
|
8459
|
-
"description": "
|
|
8460
|
-
"id": "
|
|
10742
|
+
"GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": {
|
|
10743
|
+
"description": "Metadata associated with a project provision operation.",
|
|
10744
|
+
"id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata",
|
|
10745
|
+
"properties": {},
|
|
10746
|
+
"type": "object"
|
|
10747
|
+
},
|
|
10748
|
+
"GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest": {
|
|
10749
|
+
"description": "Request for ProjectService.ProvisionProject method.",
|
|
10750
|
+
"id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest",
|
|
8461
10751
|
"properties": {
|
|
8462
|
-
"
|
|
8463
|
-
"description": "Required.
|
|
8464
|
-
"type": "
|
|
10752
|
+
"acceptDataUseTerms": {
|
|
10753
|
+
"description": "Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms).",
|
|
10754
|
+
"type": "boolean"
|
|
8465
10755
|
},
|
|
8466
|
-
"
|
|
8467
|
-
"description": "The
|
|
10756
|
+
"dataUseTermsVersion": {
|
|
10757
|
+
"description": "Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.",
|
|
8468
10758
|
"type": "string"
|
|
8469
10759
|
}
|
|
8470
10760
|
},
|
|
@@ -8651,6 +10941,90 @@
|
|
|
8651
10941
|
},
|
|
8652
10942
|
"type": "object"
|
|
8653
10943
|
},
|
|
10944
|
+
"GoogleCloudDiscoveryengineV1alphaQuery": {
|
|
10945
|
+
"description": "Defines a user inputed query.",
|
|
10946
|
+
"id": "GoogleCloudDiscoveryengineV1alphaQuery",
|
|
10947
|
+
"properties": {
|
|
10948
|
+
"queryId": {
|
|
10949
|
+
"description": "Unique Id for the query.",
|
|
10950
|
+
"type": "string"
|
|
10951
|
+
},
|
|
10952
|
+
"text": {
|
|
10953
|
+
"description": "Plain text.",
|
|
10954
|
+
"type": "string"
|
|
10955
|
+
}
|
|
10956
|
+
},
|
|
10957
|
+
"type": "object"
|
|
10958
|
+
},
|
|
10959
|
+
"GoogleCloudDiscoveryengineV1alphaRankRequest": {
|
|
10960
|
+
"description": "Request message for RankService.Rank method.",
|
|
10961
|
+
"id": "GoogleCloudDiscoveryengineV1alphaRankRequest",
|
|
10962
|
+
"properties": {
|
|
10963
|
+
"ignoreRecordDetailsInResponse": {
|
|
10964
|
+
"description": "If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.",
|
|
10965
|
+
"type": "boolean"
|
|
10966
|
+
},
|
|
10967
|
+
"model": {
|
|
10968
|
+
"description": "The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.",
|
|
10969
|
+
"type": "string"
|
|
10970
|
+
},
|
|
10971
|
+
"query": {
|
|
10972
|
+
"description": "The query to use.",
|
|
10973
|
+
"type": "string"
|
|
10974
|
+
},
|
|
10975
|
+
"records": {
|
|
10976
|
+
"description": "Required. A list of records to rank. At most 200 records to rank.",
|
|
10977
|
+
"items": {
|
|
10978
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord"
|
|
10979
|
+
},
|
|
10980
|
+
"type": "array"
|
|
10981
|
+
},
|
|
10982
|
+
"topN": {
|
|
10983
|
+
"description": "The number of results to return. If this is unset or no bigger than zero, returns all results.",
|
|
10984
|
+
"format": "int32",
|
|
10985
|
+
"type": "integer"
|
|
10986
|
+
}
|
|
10987
|
+
},
|
|
10988
|
+
"type": "object"
|
|
10989
|
+
},
|
|
10990
|
+
"GoogleCloudDiscoveryengineV1alphaRankResponse": {
|
|
10991
|
+
"description": "Response message for RankService.Rank method.",
|
|
10992
|
+
"id": "GoogleCloudDiscoveryengineV1alphaRankResponse",
|
|
10993
|
+
"properties": {
|
|
10994
|
+
"records": {
|
|
10995
|
+
"description": "A list of records sorted by descending score.",
|
|
10996
|
+
"items": {
|
|
10997
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord"
|
|
10998
|
+
},
|
|
10999
|
+
"type": "array"
|
|
11000
|
+
}
|
|
11001
|
+
},
|
|
11002
|
+
"type": "object"
|
|
11003
|
+
},
|
|
11004
|
+
"GoogleCloudDiscoveryengineV1alphaRankingRecord": {
|
|
11005
|
+
"description": "Record message for RankService.Rank method.",
|
|
11006
|
+
"id": "GoogleCloudDiscoveryengineV1alphaRankingRecord",
|
|
11007
|
+
"properties": {
|
|
11008
|
+
"content": {
|
|
11009
|
+
"description": "The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.",
|
|
11010
|
+
"type": "string"
|
|
11011
|
+
},
|
|
11012
|
+
"id": {
|
|
11013
|
+
"description": "The unique ID to represent the record.",
|
|
11014
|
+
"type": "string"
|
|
11015
|
+
},
|
|
11016
|
+
"score": {
|
|
11017
|
+
"description": "The score of this record based on the given query and selected model.",
|
|
11018
|
+
"format": "float",
|
|
11019
|
+
"type": "number"
|
|
11020
|
+
},
|
|
11021
|
+
"title": {
|
|
11022
|
+
"description": "The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.",
|
|
11023
|
+
"type": "string"
|
|
11024
|
+
}
|
|
11025
|
+
},
|
|
11026
|
+
"type": "object"
|
|
11027
|
+
},
|
|
8654
11028
|
"GoogleCloudDiscoveryengineV1alphaRecommendRequest": {
|
|
8655
11029
|
"description": "Request message for Recommend method.",
|
|
8656
11030
|
"id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest",
|
|
@@ -8912,6 +11286,33 @@
|
|
|
8912
11286
|
},
|
|
8913
11287
|
"type": "object"
|
|
8914
11288
|
},
|
|
11289
|
+
"GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest": {
|
|
11290
|
+
"description": "Request for ReportConsentChange method.",
|
|
11291
|
+
"id": "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest",
|
|
11292
|
+
"properties": {
|
|
11293
|
+
"consentChangeAction": {
|
|
11294
|
+
"description": "Required. Whether customer decides to accept or decline service term. At this moment, only accept action is supported.",
|
|
11295
|
+
"enum": [
|
|
11296
|
+
"CONSENT_CHANGE_ACTION_UNSPECIFIED",
|
|
11297
|
+
"ACCEPT"
|
|
11298
|
+
],
|
|
11299
|
+
"enumDescriptions": [
|
|
11300
|
+
"Invalid action, user must specify accept/decline",
|
|
11301
|
+
"User accepts service terms."
|
|
11302
|
+
],
|
|
11303
|
+
"type": "string"
|
|
11304
|
+
},
|
|
11305
|
+
"serviceTermId": {
|
|
11306
|
+
"description": "Required. The unique identifier of the terms of service to update. Available term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this service term id, the acceptable service_term_version to provide is `2022-11-23`.",
|
|
11307
|
+
"type": "string"
|
|
11308
|
+
},
|
|
11309
|
+
"serviceTermVersion": {
|
|
11310
|
+
"description": "Required. The version string of the terms of service to update.",
|
|
11311
|
+
"type": "string"
|
|
11312
|
+
}
|
|
11313
|
+
},
|
|
11314
|
+
"type": "object"
|
|
11315
|
+
},
|
|
8915
11316
|
"GoogleCloudDiscoveryengineV1alphaResumeEngineRequest": {
|
|
8916
11317
|
"description": "Request for resuming training of an engine.",
|
|
8917
11318
|
"id": "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest",
|
|
@@ -9029,7 +11430,7 @@
|
|
|
9029
11430
|
"type": "string"
|
|
9030
11431
|
},
|
|
9031
11432
|
"pageSize": {
|
|
9032
|
-
"description": "Maximum number of Documents to return.
|
|
11433
|
+
"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.",
|
|
9033
11434
|
"format": "int32",
|
|
9034
11435
|
"type": "integer"
|
|
9035
11436
|
},
|
|
@@ -9109,6 +11510,10 @@
|
|
|
9109
11510
|
"format": "float",
|
|
9110
11511
|
"type": "number"
|
|
9111
11512
|
},
|
|
11513
|
+
"boostControlSpec": {
|
|
11514
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec",
|
|
11515
|
+
"description": "Complex specification for custom ranking based on customer defined attribute value."
|
|
11516
|
+
},
|
|
9112
11517
|
"condition": {
|
|
9113
11518
|
"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\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`",
|
|
9114
11519
|
"type": "string"
|
|
@@ -9116,10 +11521,74 @@
|
|
|
9116
11521
|
},
|
|
9117
11522
|
"type": "object"
|
|
9118
11523
|
},
|
|
11524
|
+
"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": {
|
|
11525
|
+
"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.",
|
|
11526
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec",
|
|
11527
|
+
"properties": {
|
|
11528
|
+
"attributeType": {
|
|
11529
|
+
"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).",
|
|
11530
|
+
"enum": [
|
|
11531
|
+
"ATTRIBUTE_TYPE_UNSPECIFIED",
|
|
11532
|
+
"NUMERICAL",
|
|
11533
|
+
"FRESHNESS"
|
|
11534
|
+
],
|
|
11535
|
+
"enumDescriptions": [
|
|
11536
|
+
"Unspecified AttributeType.",
|
|
11537
|
+
"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.",
|
|
11538
|
+
"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. E.g. `5D`, `3DT12H30M`, `T24H`."
|
|
11539
|
+
],
|
|
11540
|
+
"type": "string"
|
|
11541
|
+
},
|
|
11542
|
+
"controlPoints": {
|
|
11543
|
+
"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.",
|
|
11544
|
+
"items": {
|
|
11545
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint"
|
|
11546
|
+
},
|
|
11547
|
+
"type": "array"
|
|
11548
|
+
},
|
|
11549
|
+
"fieldName": {
|
|
11550
|
+
"description": "The name of the field whose value will be used to determine the boost amount.",
|
|
11551
|
+
"type": "string"
|
|
11552
|
+
},
|
|
11553
|
+
"interpolationType": {
|
|
11554
|
+
"description": "The interpolation type to be applied to connect the control points listed below.",
|
|
11555
|
+
"enum": [
|
|
11556
|
+
"INTERPOLATION_TYPE_UNSPECIFIED",
|
|
11557
|
+
"LINEAR"
|
|
11558
|
+
],
|
|
11559
|
+
"enumDescriptions": [
|
|
11560
|
+
"Interpolation type is unspecified. In this case, it defaults to Linear.",
|
|
11561
|
+
"Piecewise linear interpolation will be applied."
|
|
11562
|
+
],
|
|
11563
|
+
"type": "string"
|
|
11564
|
+
}
|
|
11565
|
+
},
|
|
11566
|
+
"type": "object"
|
|
11567
|
+
},
|
|
11568
|
+
"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": {
|
|
11569
|
+
"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).",
|
|
11570
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint",
|
|
11571
|
+
"properties": {
|
|
11572
|
+
"attributeValue": {
|
|
11573
|
+
"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.",
|
|
11574
|
+
"type": "string"
|
|
11575
|
+
},
|
|
11576
|
+
"boostAmount": {
|
|
11577
|
+
"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.",
|
|
11578
|
+
"format": "float",
|
|
11579
|
+
"type": "number"
|
|
11580
|
+
}
|
|
11581
|
+
},
|
|
11582
|
+
"type": "object"
|
|
11583
|
+
},
|
|
9119
11584
|
"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": {
|
|
9120
11585
|
"description": "A specification for configuring the behavior of content search.",
|
|
9121
11586
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec",
|
|
9122
11587
|
"properties": {
|
|
11588
|
+
"chunkSpec": {
|
|
11589
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec",
|
|
11590
|
+
"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS"
|
|
11591
|
+
},
|
|
9123
11592
|
"extractiveContentSpec": {
|
|
9124
11593
|
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec",
|
|
9125
11594
|
"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response."
|
|
@@ -9149,6 +11618,23 @@
|
|
|
9149
11618
|
},
|
|
9150
11619
|
"type": "object"
|
|
9151
11620
|
},
|
|
11621
|
+
"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": {
|
|
11622
|
+
"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS",
|
|
11623
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec",
|
|
11624
|
+
"properties": {
|
|
11625
|
+
"numNextChunks": {
|
|
11626
|
+
"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.",
|
|
11627
|
+
"format": "int32",
|
|
11628
|
+
"type": "integer"
|
|
11629
|
+
},
|
|
11630
|
+
"numPreviousChunks": {
|
|
11631
|
+
"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.",
|
|
11632
|
+
"format": "int32",
|
|
11633
|
+
"type": "integer"
|
|
11634
|
+
}
|
|
11635
|
+
},
|
|
11636
|
+
"type": "object"
|
|
11637
|
+
},
|
|
9152
11638
|
"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": {
|
|
9153
11639
|
"description": "A specification for configuring the extractive content in a search response.",
|
|
9154
11640
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec",
|
|
@@ -9174,7 +11660,7 @@
|
|
|
9174
11660
|
"type": "integer"
|
|
9175
11661
|
},
|
|
9176
11662
|
"returnExtractiveSegmentScore": {
|
|
9177
|
-
"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store,
|
|
11663
|
+
"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.",
|
|
9178
11664
|
"type": "boolean"
|
|
9179
11665
|
}
|
|
9180
11666
|
},
|
|
@@ -9231,12 +11717,12 @@
|
|
|
9231
11717
|
"description": "If specified, the spec will be used to modify the model specification provided to the LLM."
|
|
9232
11718
|
},
|
|
9233
11719
|
"summaryResultCount": {
|
|
9234
|
-
"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 10 results can be used to generate a summary.",
|
|
11720
|
+
"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 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.",
|
|
9235
11721
|
"format": "int32",
|
|
9236
11722
|
"type": "integer"
|
|
9237
11723
|
},
|
|
9238
11724
|
"useSemanticChunks": {
|
|
9239
|
-
"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality.
|
|
11725
|
+
"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.",
|
|
9240
11726
|
"type": "boolean"
|
|
9241
11727
|
}
|
|
9242
11728
|
},
|
|
@@ -9737,6 +12223,13 @@
|
|
|
9737
12223
|
"description": "Document reference.",
|
|
9738
12224
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference",
|
|
9739
12225
|
"properties": {
|
|
12226
|
+
"chunkContents": {
|
|
12227
|
+
"description": "List of cited chunk contents derived from document content.",
|
|
12228
|
+
"items": {
|
|
12229
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent"
|
|
12230
|
+
},
|
|
12231
|
+
"type": "array"
|
|
12232
|
+
},
|
|
9740
12233
|
"document": {
|
|
9741
12234
|
"description": "Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.",
|
|
9742
12235
|
"type": "string"
|
|
@@ -9752,6 +12245,21 @@
|
|
|
9752
12245
|
},
|
|
9753
12246
|
"type": "object"
|
|
9754
12247
|
},
|
|
12248
|
+
"GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent": {
|
|
12249
|
+
"description": "Chunk content.",
|
|
12250
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent",
|
|
12251
|
+
"properties": {
|
|
12252
|
+
"content": {
|
|
12253
|
+
"description": "Chunk textual content.",
|
|
12254
|
+
"type": "string"
|
|
12255
|
+
},
|
|
12256
|
+
"pageIdentifier": {
|
|
12257
|
+
"description": "Page identifier.",
|
|
12258
|
+
"type": "string"
|
|
12259
|
+
}
|
|
12260
|
+
},
|
|
12261
|
+
"type": "object"
|
|
12262
|
+
},
|
|
9755
12263
|
"GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes": {
|
|
9756
12264
|
"description": "Safety Attribute categories and their associated confidence scores.",
|
|
9757
12265
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes",
|
|
@@ -9901,13 +12409,15 @@
|
|
|
9901
12409
|
"SOLUTION_TYPE_UNSPECIFIED",
|
|
9902
12410
|
"SOLUTION_TYPE_RECOMMENDATION",
|
|
9903
12411
|
"SOLUTION_TYPE_SEARCH",
|
|
9904
|
-
"SOLUTION_TYPE_CHAT"
|
|
12412
|
+
"SOLUTION_TYPE_CHAT",
|
|
12413
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
9905
12414
|
],
|
|
9906
12415
|
"enumDescriptions": [
|
|
9907
12416
|
"Default value.",
|
|
9908
12417
|
"Used for Recommendations AI.",
|
|
9909
12418
|
"Used for Discovery Search.",
|
|
9910
|
-
"Used for use cases related to the Generative AI agent."
|
|
12419
|
+
"Used for use cases related to the Generative AI agent.",
|
|
12420
|
+
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
|
|
9911
12421
|
],
|
|
9912
12422
|
"type": "string"
|
|
9913
12423
|
},
|
|
@@ -9964,6 +12474,67 @@
|
|
|
9964
12474
|
},
|
|
9965
12475
|
"type": "object"
|
|
9966
12476
|
},
|
|
12477
|
+
"GoogleCloudDiscoveryengineV1alphaSession": {
|
|
12478
|
+
"description": "External session proto definition.",
|
|
12479
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSession",
|
|
12480
|
+
"properties": {
|
|
12481
|
+
"endTime": {
|
|
12482
|
+
"description": "Output only. The time the session finished.",
|
|
12483
|
+
"format": "google-datetime",
|
|
12484
|
+
"readOnly": true,
|
|
12485
|
+
"type": "string"
|
|
12486
|
+
},
|
|
12487
|
+
"name": {
|
|
12488
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
|
|
12489
|
+
"type": "string"
|
|
12490
|
+
},
|
|
12491
|
+
"startTime": {
|
|
12492
|
+
"description": "Output only. The time the session started.",
|
|
12493
|
+
"format": "google-datetime",
|
|
12494
|
+
"readOnly": true,
|
|
12495
|
+
"type": "string"
|
|
12496
|
+
},
|
|
12497
|
+
"state": {
|
|
12498
|
+
"description": "The state of the session.",
|
|
12499
|
+
"enum": [
|
|
12500
|
+
"STATE_UNSPECIFIED",
|
|
12501
|
+
"IN_PROGRESS"
|
|
12502
|
+
],
|
|
12503
|
+
"enumDescriptions": [
|
|
12504
|
+
"State is unspecified.",
|
|
12505
|
+
"The session is currently open."
|
|
12506
|
+
],
|
|
12507
|
+
"type": "string"
|
|
12508
|
+
},
|
|
12509
|
+
"turns": {
|
|
12510
|
+
"description": "Turns.",
|
|
12511
|
+
"items": {
|
|
12512
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn"
|
|
12513
|
+
},
|
|
12514
|
+
"type": "array"
|
|
12515
|
+
},
|
|
12516
|
+
"userPseudoId": {
|
|
12517
|
+
"description": "A unique identifier for tracking users.",
|
|
12518
|
+
"type": "string"
|
|
12519
|
+
}
|
|
12520
|
+
},
|
|
12521
|
+
"type": "object"
|
|
12522
|
+
},
|
|
12523
|
+
"GoogleCloudDiscoveryengineV1alphaSessionTurn": {
|
|
12524
|
+
"description": "Represents a turn, including a query from the user and a answer from service.",
|
|
12525
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSessionTurn",
|
|
12526
|
+
"properties": {
|
|
12527
|
+
"answer": {
|
|
12528
|
+
"description": "The resource name of the answer to the user query.",
|
|
12529
|
+
"type": "string"
|
|
12530
|
+
},
|
|
12531
|
+
"query": {
|
|
12532
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
|
|
12533
|
+
"description": "The user query."
|
|
12534
|
+
}
|
|
12535
|
+
},
|
|
12536
|
+
"type": "object"
|
|
12537
|
+
},
|
|
9967
12538
|
"GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": {
|
|
9968
12539
|
"description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.",
|
|
9969
12540
|
"id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine",
|
|
@@ -10003,6 +12574,33 @@
|
|
|
10003
12574
|
},
|
|
10004
12575
|
"type": "object"
|
|
10005
12576
|
},
|
|
12577
|
+
"GoogleCloudDiscoveryengineV1alphaSpannerSource": {
|
|
12578
|
+
"description": "The Spanner source for importing data",
|
|
12579
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSpannerSource",
|
|
12580
|
+
"properties": {
|
|
12581
|
+
"databaseId": {
|
|
12582
|
+
"description": "Required. The database ID of the source Spanner table.",
|
|
12583
|
+
"type": "string"
|
|
12584
|
+
},
|
|
12585
|
+
"enableDataBoost": {
|
|
12586
|
+
"description": "Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas).",
|
|
12587
|
+
"type": "boolean"
|
|
12588
|
+
},
|
|
12589
|
+
"instanceId": {
|
|
12590
|
+
"description": "Required. The instance ID of the source Spanner table.",
|
|
12591
|
+
"type": "string"
|
|
12592
|
+
},
|
|
12593
|
+
"projectId": {
|
|
12594
|
+
"description": "The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
|
|
12595
|
+
"type": "string"
|
|
12596
|
+
},
|
|
12597
|
+
"tableId": {
|
|
12598
|
+
"description": "Required. The table name of the Spanner database that needs to be imported.",
|
|
12599
|
+
"type": "string"
|
|
12600
|
+
}
|
|
12601
|
+
},
|
|
12602
|
+
"type": "object"
|
|
12603
|
+
},
|
|
10006
12604
|
"GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry": {
|
|
10007
12605
|
"description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.",
|
|
10008
12606
|
"id": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry",
|
|
@@ -10214,8 +12812,16 @@
|
|
|
10214
12812
|
},
|
|
10215
12813
|
"type": "array"
|
|
10216
12814
|
},
|
|
12815
|
+
"metrics": {
|
|
12816
|
+
"additionalProperties": {
|
|
12817
|
+
"format": "double",
|
|
12818
|
+
"type": "number"
|
|
12819
|
+
},
|
|
12820
|
+
"description": "The metrics of the trained model.",
|
|
12821
|
+
"type": "object"
|
|
12822
|
+
},
|
|
10217
12823
|
"modelStatus": {
|
|
10218
|
-
"description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving.",
|
|
12824
|
+
"description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.",
|
|
10219
12825
|
"type": "string"
|
|
10220
12826
|
}
|
|
10221
12827
|
},
|
|
@@ -10556,6 +13162,10 @@
|
|
|
10556
13162
|
"description": "Whether to enable safe search.",
|
|
10557
13163
|
"type": "boolean"
|
|
10558
13164
|
},
|
|
13165
|
+
"enableSearchAsYouType": {
|
|
13166
|
+
"description": "Whether to enable search-as-you-type behavior for the search widget",
|
|
13167
|
+
"type": "boolean"
|
|
13168
|
+
},
|
|
10559
13169
|
"enableSnippetResultSummary": {
|
|
10560
13170
|
"description": "Turn on or off summary for each snippets result.",
|
|
10561
13171
|
"type": "boolean"
|
|
@@ -10587,12 +13197,14 @@
|
|
|
10587
13197
|
"enum": [
|
|
10588
13198
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
10589
13199
|
"GENERIC",
|
|
10590
|
-
"MEDIA"
|
|
13200
|
+
"MEDIA",
|
|
13201
|
+
"HEALTHCARE_FHIR"
|
|
10591
13202
|
],
|
|
10592
13203
|
"enumDescriptions": [
|
|
10593
13204
|
"Value used when unset.",
|
|
10594
13205
|
"The generic vertical for documents that are not specific to any industry vertical.",
|
|
10595
|
-
"The media industry vertical."
|
|
13206
|
+
"The media industry vertical.",
|
|
13207
|
+
"The healthcare FHIR vertical."
|
|
10596
13208
|
],
|
|
10597
13209
|
"readOnly": true,
|
|
10598
13210
|
"type": "string"
|
|
@@ -10631,13 +13243,15 @@
|
|
|
10631
13243
|
"SOLUTION_TYPE_UNSPECIFIED",
|
|
10632
13244
|
"SOLUTION_TYPE_RECOMMENDATION",
|
|
10633
13245
|
"SOLUTION_TYPE_SEARCH",
|
|
10634
|
-
"SOLUTION_TYPE_CHAT"
|
|
13246
|
+
"SOLUTION_TYPE_CHAT",
|
|
13247
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
10635
13248
|
],
|
|
10636
13249
|
"enumDescriptions": [
|
|
10637
13250
|
"Default value.",
|
|
10638
13251
|
"Used for Recommendations AI.",
|
|
10639
13252
|
"Used for Discovery Search.",
|
|
10640
|
-
"Used for use cases related to the Generative AI agent."
|
|
13253
|
+
"Used for use cases related to the Generative AI agent.",
|
|
13254
|
+
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
|
|
10641
13255
|
],
|
|
10642
13256
|
"type": "string"
|
|
10643
13257
|
},
|
|
@@ -10671,7 +13285,7 @@
|
|
|
10671
13285
|
"type": "string"
|
|
10672
13286
|
},
|
|
10673
13287
|
"name": {
|
|
10674
|
-
"description": "The name of the collection. It should be collection resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection_id}`. For
|
|
13288
|
+
"description": "The name of the collection. It should be collection resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field.",
|
|
10675
13289
|
"type": "string"
|
|
10676
13290
|
}
|
|
10677
13291
|
},
|
|
@@ -10691,7 +13305,7 @@
|
|
|
10691
13305
|
"type": "string"
|
|
10692
13306
|
},
|
|
10693
13307
|
"name": {
|
|
10694
|
-
"description": "The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For
|
|
13308
|
+
"description": "The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field.",
|
|
10695
13309
|
"type": "string"
|
|
10696
13310
|
}
|
|
10697
13311
|
},
|
|
@@ -10721,7 +13335,7 @@
|
|
|
10721
13335
|
"type": "string"
|
|
10722
13336
|
},
|
|
10723
13337
|
"name": {
|
|
10724
|
-
"description": "The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For
|
|
13338
|
+
"description": "The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field.",
|
|
10725
13339
|
"type": "string"
|
|
10726
13340
|
}
|
|
10727
13341
|
},
|
|
@@ -10993,12 +13607,14 @@
|
|
|
10993
13607
|
"enum": [
|
|
10994
13608
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
10995
13609
|
"GENERIC",
|
|
10996
|
-
"MEDIA"
|
|
13610
|
+
"MEDIA",
|
|
13611
|
+
"HEALTHCARE_FHIR"
|
|
10997
13612
|
],
|
|
10998
13613
|
"enumDescriptions": [
|
|
10999
13614
|
"Value used when unset.",
|
|
11000
13615
|
"The generic vertical for documents that are not specific to any industry vertical.",
|
|
11001
|
-
"The media industry vertical."
|
|
13616
|
+
"The media industry vertical.",
|
|
13617
|
+
"The healthcare FHIR vertical."
|
|
11002
13618
|
],
|
|
11003
13619
|
"type": "string"
|
|
11004
13620
|
},
|
|
@@ -11013,13 +13629,15 @@
|
|
|
11013
13629
|
"SOLUTION_TYPE_UNSPECIFIED",
|
|
11014
13630
|
"SOLUTION_TYPE_RECOMMENDATION",
|
|
11015
13631
|
"SOLUTION_TYPE_SEARCH",
|
|
11016
|
-
"SOLUTION_TYPE_CHAT"
|
|
13632
|
+
"SOLUTION_TYPE_CHAT",
|
|
13633
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
11017
13634
|
],
|
|
11018
13635
|
"enumDescriptions": [
|
|
11019
13636
|
"Default value.",
|
|
11020
13637
|
"Used for Recommendations AI.",
|
|
11021
13638
|
"Used for Discovery Search.",
|
|
11022
|
-
"Used for use cases related to the Generative AI agent."
|
|
13639
|
+
"Used for use cases related to the Generative AI agent.",
|
|
13640
|
+
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
|
|
11023
13641
|
],
|
|
11024
13642
|
"type": "string"
|
|
11025
13643
|
},
|
|
@@ -11171,7 +13789,8 @@
|
|
|
11171
13789
|
"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig",
|
|
11172
13790
|
"properties": {
|
|
11173
13791
|
"enhancedDocumentElements": {
|
|
11174
|
-
"
|
|
13792
|
+
"deprecated": true,
|
|
13793
|
+
"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.",
|
|
11175
13794
|
"items": {
|
|
11176
13795
|
"type": "string"
|
|
11177
13796
|
},
|
|
@@ -11246,12 +13865,14 @@
|
|
|
11246
13865
|
"enum": [
|
|
11247
13866
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
11248
13867
|
"GENERIC",
|
|
11249
|
-
"MEDIA"
|
|
13868
|
+
"MEDIA",
|
|
13869
|
+
"HEALTHCARE_FHIR"
|
|
11250
13870
|
],
|
|
11251
13871
|
"enumDescriptions": [
|
|
11252
13872
|
"Value used when unset.",
|
|
11253
13873
|
"The generic vertical for documents that are not specific to any industry vertical.",
|
|
11254
|
-
"The media industry vertical."
|
|
13874
|
+
"The media industry vertical.",
|
|
13875
|
+
"The healthcare FHIR vertical."
|
|
11255
13876
|
],
|
|
11256
13877
|
"type": "string"
|
|
11257
13878
|
},
|
|
@@ -11269,13 +13890,15 @@
|
|
|
11269
13890
|
"SOLUTION_TYPE_UNSPECIFIED",
|
|
11270
13891
|
"SOLUTION_TYPE_RECOMMENDATION",
|
|
11271
13892
|
"SOLUTION_TYPE_SEARCH",
|
|
11272
|
-
"SOLUTION_TYPE_CHAT"
|
|
13893
|
+
"SOLUTION_TYPE_CHAT",
|
|
13894
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
11273
13895
|
],
|
|
11274
13896
|
"enumDescriptions": [
|
|
11275
13897
|
"Default value.",
|
|
11276
13898
|
"Used for Recommendations AI.",
|
|
11277
13899
|
"Used for Discovery Search.",
|
|
11278
|
-
"Used for use cases related to the Generative AI agent."
|
|
13900
|
+
"Used for use cases related to the Generative AI agent.",
|
|
13901
|
+
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
|
|
11279
13902
|
],
|
|
11280
13903
|
"type": "string"
|
|
11281
13904
|
},
|
|
@@ -11297,7 +13920,7 @@
|
|
|
11297
13920
|
"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
|
|
11298
13921
|
},
|
|
11299
13922
|
"dialogflowAgentToLink": {
|
|
11300
|
-
"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
13923
|
+
"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
|
|
11301
13924
|
"type": "string"
|
|
11302
13925
|
}
|
|
11303
13926
|
},
|
|
@@ -11368,7 +13991,7 @@
|
|
|
11368
13991
|
"type": "array"
|
|
11369
13992
|
},
|
|
11370
13993
|
"searchTier": {
|
|
11371
|
-
"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
13994
|
+
"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.",
|
|
11372
13995
|
"enum": [
|
|
11373
13996
|
"SEARCH_TIER_UNSPECIFIED",
|
|
11374
13997
|
"SEARCH_TIER_STANDARD",
|
|
@@ -11403,6 +14026,11 @@
|
|
|
11403
14026
|
"format": "int64",
|
|
11404
14027
|
"type": "string"
|
|
11405
14028
|
},
|
|
14029
|
+
"totalCount": {
|
|
14030
|
+
"description": "Total count of entries that were processed.",
|
|
14031
|
+
"format": "int64",
|
|
14032
|
+
"type": "string"
|
|
14033
|
+
},
|
|
11406
14034
|
"updateTime": {
|
|
11407
14035
|
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
11408
14036
|
"format": "google-datetime",
|
|
@@ -11803,13 +14431,38 @@
|
|
|
11803
14431
|
},
|
|
11804
14432
|
"type": "array"
|
|
11805
14433
|
},
|
|
14434
|
+
"metrics": {
|
|
14435
|
+
"additionalProperties": {
|
|
14436
|
+
"format": "double",
|
|
14437
|
+
"type": "number"
|
|
14438
|
+
},
|
|
14439
|
+
"description": "The metrics of the trained model.",
|
|
14440
|
+
"type": "object"
|
|
14441
|
+
},
|
|
11806
14442
|
"modelStatus": {
|
|
11807
|
-
"description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving.",
|
|
14443
|
+
"description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.",
|
|
14444
|
+
"type": "string"
|
|
14445
|
+
}
|
|
14446
|
+
},
|
|
14447
|
+
"type": "object"
|
|
14448
|
+
},
|
|
14449
|
+
"GoogleCloudDiscoveryengineV1betaTuneEngineMetadata": {
|
|
14450
|
+
"description": "Metadata associated with a tune operation.",
|
|
14451
|
+
"id": "GoogleCloudDiscoveryengineV1betaTuneEngineMetadata",
|
|
14452
|
+
"properties": {
|
|
14453
|
+
"engine": {
|
|
14454
|
+
"description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`",
|
|
11808
14455
|
"type": "string"
|
|
11809
14456
|
}
|
|
11810
14457
|
},
|
|
11811
14458
|
"type": "object"
|
|
11812
14459
|
},
|
|
14460
|
+
"GoogleCloudDiscoveryengineV1betaTuneEngineResponse": {
|
|
14461
|
+
"description": "Response associated with a tune operation.",
|
|
14462
|
+
"id": "GoogleCloudDiscoveryengineV1betaTuneEngineResponse",
|
|
14463
|
+
"properties": {},
|
|
14464
|
+
"type": "object"
|
|
14465
|
+
},
|
|
11813
14466
|
"GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata": {
|
|
11814
14467
|
"description": "Metadata for UpdateSchema LRO.",
|
|
11815
14468
|
"id": "GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata",
|