From 915b08ce51de038748b52764db2c232d208b20e8 Mon Sep 17 00:00:00 2001
From: yoshi-code-bot <70984784+yoshi-code-bot@users.noreply.github.com>
Date: Mon, 9 Dec 2024 23:32:22 -0800
Subject: [PATCH] chore: Update discovery artifacts (#2531)
## Deleted keys were detected in the following stable discovery artifacts:
aiplatform v1 https://togithub.com/googleapis/google-api-python-client/commit/d50ae63492a92097d249a25ab5bd139ac6d1424a
contactcenterinsights v1 https://togithub.com/googleapis/google-api-python-client/commit/bc8379171ff238af1d966f249593ad49ddaa6cee
datafusion v1 https://togithub.com/googleapis/google-api-python-client/commit/165fb78a7e6aa9c631c8ce76828d6dd35f97c196
netapp v1 https://togithub.com/googleapis/google-api-python-client/commit/28ac561addaa5add76eb344c97b0ff7a6f808a8e
youtube v3 https://togithub.com/googleapis/google-api-python-client/commit/ff3d46ed74cd4b89c608f499a4bec96f57cd2421
## Deleted keys were detected in the following pre-stable discovery artifacts:
aiplatform v1beta1 https://togithub.com/googleapis/google-api-python-client/commit/d50ae63492a92097d249a25ab5bd139ac6d1424a
compute alpha https://togithub.com/googleapis/google-api-python-client/commit/1cfe5429aed394e5ce62e6899318f8522d019c4e
compute beta https://togithub.com/googleapis/google-api-python-client/commit/1cfe5429aed394e5ce62e6899318f8522d019c4e
dataform v1beta1 https://togithub.com/googleapis/google-api-python-client/commit/4f0c614559ee4e9db10c7e73818a8eab2f4ac786
datafusion v1beta1 https://togithub.com/googleapis/google-api-python-client/commit/165fb78a7e6aa9c631c8ce76828d6dd35f97c196
netapp v1beta1 https://togithub.com/googleapis/google-api-python-client/commit/28ac561addaa5add76eb344c97b0ff7a6f808a8e
## Discovery Artifact Change Summary:
feat(aiplatform): update the api https://togithub.com/googleapis/google-api-python-client/commit/d50ae63492a92097d249a25ab5bd139ac6d1424a
feat(androidmanagement): update the api https://togithub.com/googleapis/google-api-python-client/commit/cb1471a8b648ee5d555e9f28fc34cc2f65189910
feat(appengine): update the api https://togithub.com/googleapis/google-api-python-client/commit/57d4127949d018b9efe8739d1f26aea13486e924
feat(compute): update the api https://togithub.com/googleapis/google-api-python-client/commit/1cfe5429aed394e5ce62e6899318f8522d019c4e
feat(connectors): update the api https://togithub.com/googleapis/google-api-python-client/commit/99697fdc55812843027c466152fc491e1669b039
feat(contactcenterinsights): update the api https://togithub.com/googleapis/google-api-python-client/commit/bc8379171ff238af1d966f249593ad49ddaa6cee
feat(dataform): update the api https://togithub.com/googleapis/google-api-python-client/commit/4f0c614559ee4e9db10c7e73818a8eab2f4ac786
feat(datafusion): update the api https://togithub.com/googleapis/google-api-python-client/commit/165fb78a7e6aa9c631c8ce76828d6dd35f97c196
feat(datamigration): update the api https://togithub.com/googleapis/google-api-python-client/commit/1c1bcd25322e544a115f7add9322ee9e0871c591
feat(digitalassetlinks): update the api https://togithub.com/googleapis/google-api-python-client/commit/cf449454bb7f48478d0c87dc60971091afb0bb6a
feat(discoveryengine): update the api https://togithub.com/googleapis/google-api-python-client/commit/8a30c6c557bf1f24e6578cf00d07d1a802324c13
feat(eventarc): update the api https://togithub.com/googleapis/google-api-python-client/commit/dde23ec8cf9dfec696244dab418897a9f7c228d2
feat(firebaseappdistribution): update the api https://togithub.com/googleapis/google-api-python-client/commit/c195e5a27c7c84de78deafbbb5e885bf6e735189
feat(firebaseml): update the api https://togithub.com/googleapis/google-api-python-client/commit/ccd8de6cba324afa2b07117ad49200e297b9a39e
feat(integrations): update the api https://togithub.com/googleapis/google-api-python-client/commit/84fa3b1bc28637c1f97ec7523e6389232b8b82fc
feat(netapp): update the api https://togithub.com/googleapis/google-api-python-client/commit/28ac561addaa5add76eb344c97b0ff7a6f808a8e
feat(networkmanagement): update the api https://togithub.com/googleapis/google-api-python-client/commit/edf014bc9a8c7799ca6fce08c011e6bea5dd9aa5
feat(networksecurity): update the api https://togithub.com/googleapis/google-api-python-client/commit/dbe06d2872341d65dd13a2da41f6f7ccb42dab31
feat(orgpolicy): update the api https://togithub.com/googleapis/google-api-python-client/commit/2da03fb83a1bf6e0b5116f6e7d2b2ffdcfceece9
feat(redis): update the api https://togithub.com/googleapis/google-api-python-client/commit/8cb616f399bf0ae0942681ecdc50d95e55c16ace
feat(securitycenter): update the api https://togithub.com/googleapis/google-api-python-client/commit/380eee35b19779f3476e7cf836ad776846b2111a
feat(servicemanagement): update the api https://togithub.com/googleapis/google-api-python-client/commit/4c20798c57f262378436928d557e232de757a98c
feat(tagmanager): update the api https://togithub.com/googleapis/google-api-python-client/commit/f9a5997cb3679fae42afdffb6ad8f2f5e64db439
feat(youtube): update the api https://togithub.com/googleapis/google-api-python-client/commit/ff3d46ed74cd4b89c608f499a4bec96f57cd2421
---
docs/dyn/adsense_v2.accounts.html | 12 +-
...adsenseplatform_v1.platforms.accounts.html | 16 +-
...seplatform_v1alpha.platforms.accounts.html | 16 +-
docs/dyn/aiplatform_v1.endpoints.html | 39 +
docs/dyn/aiplatform_v1.media.html | 34 +
..._v1.projects.locations.cachedContents.html | 12 +
...tform_v1.projects.locations.endpoints.html | 39 +
.../dyn/aiplatform_v1.projects.locations.html | 179 +
...ts.locations.notebookRuntimeTemplates.html | 22 +-
...1.projects.locations.notebookRuntimes.html | 95 +-
....projects.locations.publishers.models.html | 39 +
...form_v1.projects.locations.ragCorpora.html | 13 +
...jects.locations.ragCorpora.operations.html | 268 ++
...rojects.locations.ragCorpora.ragFiles.html | 56 +
...ations.ragCorpora.ragFiles.operations.html | 268 ++
docs/dyn/aiplatform_v1.publishers.models.html | 39 +
docs/dyn/aiplatform_v1beta1.endpoints.html | 39 +
...ta1.projects.locations.cachedContents.html | 12 +
..._v1beta1.projects.locations.endpoints.html | 39 +
...eta1.projects.locations.featureGroups.html | 8 +
...aiplatform_v1beta1.projects.locations.html | 253 +
...ts.locations.notebookRuntimeTemplates.html | 22 +-
...1.projects.locations.notebookRuntimes.html | 95 +-
...beta1.projects.locations.pipelineJobs.html | 16 +-
....projects.locations.publishers.models.html | 39 +
...1.projects.locations.reasoningEngines.html | 38 +
..._v1beta1.projects.locations.schedules.html | 24 +-
...v1beta1.projects.locations.tuningJobs.html | 20 +-
.../aiplatform_v1beta1.publishers.models.html | 44 +-
...viceprovisioning_v1.customers.devices.html | 2 +-
...ndroiddeviceprovisioning_v1.customers.html | 2 +-
...oidmanagement_v1.enterprises.policies.html | 12 +-
...jects.locations.applications.services.html | 41 +
...jects.locations.applications.services.html | 41 +
docs/dyn/bigquery_v2.datasets.html | 8 +-
docs/dyn/chat_v1.spaces.html | 4 +-
...ccounts.channelPartnerLinks.customers.html | 70 +-
.../cloudchannel_v1.accounts.customers.html | 70 +-
.../cloudchannel_v1.accounts.reportJobs.html | 20 +-
.../dyn/cloudchannel_v1.accounts.reports.html | 8 +-
docs/dyn/compute_alpha.backendBuckets.html | 12 +-
docs/dyn/compute_alpha.backendServices.html | 305 +-
docs/dyn/compute_alpha.crossSiteNetworks.html | 9 +-
docs/dyn/compute_alpha.disks.html | 2 +-
.../dyn/compute_alpha.futureReservations.html | 115 +-
...ha.instanceGroupManagerResizeRequests.html | 6 +-
.../compute_alpha.instanceGroupManagers.html | 32 +-
docs/dyn/compute_alpha.instanceTemplates.html | 32 +-
docs/dyn/compute_alpha.instances.html | 238 +-
.../compute_alpha.interconnectLocations.html | 16 +-
docs/dyn/compute_alpha.interconnects.html | 12 +
docs/dyn/compute_alpha.licenses.html | 186 +-
docs/dyn/compute_alpha.machineImages.html | 48 +-
docs/dyn/compute_alpha.networkProfiles.html | 8 +
docs/dyn/compute_alpha.networks.html | 98 +-
docs/dyn/compute_alpha.nodeTypes.html | 3 +
...te_alpha.organizationSecurityPolicies.html | 32 +-
docs/dyn/compute_alpha.projects.html | 12 +-
.../compute_alpha.regionBackendServices.html | 12 +-
docs/dyn/compute_alpha.regionCommitments.html | 12 -
docs/dyn/compute_alpha.regionDisks.html | 2 +-
...ionInstanceGroupManagerResizeRequests.html | 6 +-
...ute_alpha.regionInstanceGroupManagers.html | 28 +-
...compute_alpha.regionInstanceTemplates.html | 24 +-
docs/dyn/compute_alpha.regionInstances.html | 8 +-
docs/dyn/compute_alpha.regionMultiMigs.html | 768 ---
...e_alpha.regionNetworkFirewallPolicies.html | 78 +
.../compute_alpha.regionSecurityPolicies.html | 171 +-
...ompute_alpha.regionTargetHttpsProxies.html | 8 +-
docs/dyn/compute_alpha.regionUrlMaps.html | 147 +-
docs/dyn/compute_alpha.reservationBlocks.html | 139 +-
docs/dyn/compute_alpha.reservations.html | 146 +-
docs/dyn/compute_alpha.securityPolicies.html | 37 +-
docs/dyn/compute_alpha.subnetworks.html | 12 +-
.../dyn/compute_alpha.targetHttpsProxies.html | 10 +-
docs/dyn/compute_alpha.urlMaps.html | 171 +-
docs/dyn/compute_alpha.wireGroups.html | 44 +-
.../compute_alpha.zoneQueuedResources.html | 32 +-
docs/dyn/compute_beta.backendBuckets.html | 10 +-
docs/dyn/compute_beta.backendServices.html | 288 +-
docs/dyn/compute_beta.futureReservations.html | 10 -
.../compute_beta.instanceGroupManagers.html | 8 +-
docs/dyn/compute_beta.instanceTemplates.html | 28 +
docs/dyn/compute_beta.instances.html | 228 +-
.../compute_beta.interconnectLocations.html | 4 +-
docs/dyn/compute_beta.licenses.html | 18 +-
docs/dyn/compute_beta.machineImages.html | 42 +
docs/dyn/compute_beta.networkProfiles.html | 8 +
docs/dyn/compute_beta.networks.html | 98 +-
...ute_beta.organizationSecurityPolicies.html | 32 +-
docs/dyn/compute_beta.projects.html | 12 +-
.../compute_beta.regionBackendServices.html | 12 +-
docs/dyn/compute_beta.regionCommitments.html | 12 -
...pute_beta.regionInstanceGroupManagers.html | 8 +-
.../compute_beta.regionInstanceTemplates.html | 21 +
docs/dyn/compute_beta.regionInstances.html | 7 +
docs/dyn/compute_beta.regionMultiMigs.html | 12 +-
...te_beta.regionNetworkFirewallPolicies.html | 78 +
.../compute_beta.regionSecurityPolicies.html | 170 +-
...compute_beta.regionTargetHttpsProxies.html | 8 +-
docs/dyn/compute_beta.regionUrlMaps.html | 144 +-
docs/dyn/compute_beta.reservationBlocks.html | 2 -
docs/dyn/compute_beta.reservations.html | 10 -
docs/dyn/compute_beta.routers.html | 48 +
docs/dyn/compute_beta.securityPolicies.html | 37 +-
docs/dyn/compute_beta.subnetworks.html | 22 +-
docs/dyn/compute_beta.targetHttpsProxies.html | 10 +-
docs/dyn/compute_beta.urlMaps.html | 168 +-
docs/dyn/compute_v1.backendBuckets.html | 10 +-
docs/dyn/compute_v1.backendServices.html | 14 +-
docs/dyn/compute_v1.html | 5 +
.../dyn/compute_v1.instanceGroupManagers.html | 588 ++-
docs/dyn/compute_v1.instances.html | 12 +-
.../dyn/compute_v1.interconnectLocations.html | 4 +-
docs/dyn/compute_v1.licenses.html | 18 +-
docs/dyn/compute_v1.networkProfiles.html | 261 ++
docs/dyn/compute_v1.networks.html | 16 +
docs/dyn/compute_v1.projects.html | 12 +-
.../dyn/compute_v1.regionBackendServices.html | 12 +-
...ompute_v1.regionInstanceGroupManagers.html | 582 ++-
.../compute_v1.regionSecurityPolicies.html | 166 +-
.../compute_v1.regionTargetHttpsProxies.html | 8 +-
docs/dyn/compute_v1.regionUrlMaps.html | 144 +-
docs/dyn/compute_v1.routers.html | 9 +
docs/dyn/compute_v1.routes.html | 9 +
docs/dyn/compute_v1.securityPolicies.html | 32 +-
docs/dyn/compute_v1.subnetworks.html | 12 +-
docs/dyn/compute_v1.targetHttpsProxies.html | 10 +-
docs/dyn/compute_v1.urlMaps.html | 168 +-
...ations.connections.eventSubscriptions.html | 12 +
...ors_v1.projects.locations.connections.html | 150 +-
...tomConnectors.customConnectorVersions.html | 105 +
...tomConnectors.customConnectorVersions.html | 174 +-
...tors_v1.projects.locations.operations.html | 4 +-
...ojects.locations.providers.connectors.html | 12 +
...cations.providers.connectors.versions.html | 976 ++--
...ns.authorizedViewSets.authorizedViews.html | 231 +-
...s_v1.projects.locations.conversations.html | 42 +-
...tcenterinsights_v1.projects.locations.html | 4 +-
...house_v1.projects.locations.documents.html | 154 +-
...jects.locations.documents.referenceId.html | 66 +-
...alog_v1.projects.locations.operations.html | 4 +-
.../dataform_v1beta1.projects.locations.html | 5 -
...beta1.projects.locations.repositories.html | 5 -
...jects.locations.instances.dnsPeerings.html | 6 +-
...usion_v1.projects.locations.instances.html | 112 +-
...sion_v1.projects.locations.operations.html | 4 +-
...fusion_v1.projects.locations.versions.html | 12 +-
...v1beta1.projects.locations.operations.html | 4 +-
...n_v1beta1.projects.locations.versions.html | 12 +-
...eage_v1.projects.locations.operations.html | 4 +-
...neage_v1.projects.locations.processes.html | 12 +-
...ojects.locations.conversionWorkspaces.html | 16 +
...n_v1.projects.locations.migrationJobs.html | 159 +-
...jects.locations.migrationJobs.objects.html | 151 +
...tion_v1.projects.locations.operations.html | 4 +-
...v1beta1.projects.locations.operations.html | 4 +-
...ections.dataStores.branches.documents.html | 1 +
...collections.dataStores.servingConfigs.html | 709 ++-
...llections.dataStores.sessions.answers.html | 14 +
...tions.collections.dataStores.sessions.html | 103 +-
...ons.collections.dataStores.userEvents.html | 2 +-
...ns.collections.engines.servingConfigs.html | 709 ++-
....collections.engines.sessions.answers.html | 14 +
...ocations.collections.engines.sessions.html | 103 +-
...cations.dataStores.branches.documents.html | 1 +
...s.locations.dataStores.servingConfigs.html | 709 ++-
...locations.dataStores.sessions.answers.html | 14 +
...rojects.locations.dataStores.sessions.html | 103 +-
...jects.locations.dataStores.userEvents.html | 2 +-
...gine_v1.projects.locations.userEvents.html | 2 +-
...ections.dataStores.branches.documents.html | 1 +
...collections.dataStores.servingConfigs.html | 532 ++-
...llections.dataStores.sessions.answers.html | 14 +
...tions.collections.dataStores.sessions.html | 103 +-
...ons.collections.dataStores.userEvents.html | 2 +-
...ns.collections.engines.servingConfigs.html | 532 ++-
....collections.engines.sessions.answers.html | 14 +
...ocations.collections.engines.sessions.html | 103 +-
...cations.dataStores.branches.documents.html | 1 +
...s.locations.dataStores.servingConfigs.html | 532 ++-
...locations.dataStores.sessions.answers.html | 14 +
...rojects.locations.dataStores.sessions.html | 103 +-
...jects.locations.dataStores.userEvents.html | 2 +-
...1alpha.projects.locations.evaluations.html | 57 +
...v1alpha.projects.locations.userEvents.html | 2 +-
...ections.dataStores.branches.documents.html | 1 +
...collections.dataStores.servingConfigs.html | 529 ++-
...llections.dataStores.sessions.answers.html | 14 +
...tions.collections.dataStores.sessions.html | 103 +-
...ons.collections.dataStores.userEvents.html | 2 +-
...ns.collections.engines.servingConfigs.html | 529 ++-
....collections.engines.sessions.answers.html | 14 +
...ocations.collections.engines.sessions.html | 103 +-
...cations.dataStores.branches.documents.html | 1 +
...s.locations.dataStores.servingConfigs.html | 529 ++-
...locations.dataStores.sessions.answers.html | 14 +
...rojects.locations.dataStores.sessions.html | 103 +-
...jects.locations.dataStores.userEvents.html | 2 +-
...v1beta.projects.locations.evaluations.html | 57 +
..._v1beta.projects.locations.userEvents.html | 2 +-
...yvideo_v2.firstAndThirdPartyAudiences.html | 2 +-
...yvideo_v3.firstAndThirdPartyAudiences.html | 2 +-
docs/dyn/dlp_v2.infoTypes.html | 1 +
docs/dyn/dlp_v2.locations.infoTypes.html | 1 +
...projects.locations.channelConnections.html | 9 +
...entarc_v1.projects.locations.channels.html | 12 +
...arc_v1.projects.locations.enrollments.html | 2 +-
...1.projects.locations.googleApiSources.html | 10 +-
...rc_v1.projects.locations.messageBuses.html | 12 +-
...tarc_v1.projects.locations.operations.html | 4 +-
...ntarc_v1.projects.locations.pipelines.html | 18 +-
.../firebaseappdistribution_v1alpha.apps.html | 8 +-
...appdistribution_v1alpha.apps.releases.html | 4 +-
...tribution_v1alpha.apps.releases.notes.html | 8 +-
...stribution_v1alpha.apps.upload_status.html | 2 +-
..._v1alpha.projects.apps.releases.tests.html | 4 +
docs/dyn/firebasedatabase_v1beta.html | 2 +-
.../dyn/firebasedatabase_v1beta.projects.html | 2 +-
...asedatabase_v1beta.projects.locations.html | 2 +-
...e_v1beta.projects.locations.instances.html | 2 +-
docs/dyn/firebasehosting_v1.operations.html | 4 +-
....projects.locations.publishers.models.html | 39 +
docs/dyn/iap_v1.v1.html | 6 +-
docs/dyn/index.md | 3 +
...ons_v1.projects.locations.connections.html | 30 +-
.../integrations_v1.projects.locations.html | 37 +
...ns_v1.projects.locations.integrations.html | 2 +-
...tions.integrations.versions.testCases.html | 36 +-
...jects.locations.products.integrations.html | 2 +-
.../localservices_v1.detailedLeadReports.html | 4 +-
...astore_v1.projects.locations.services.html | 2 +-
...e_v1alpha.projects.locations.services.html | 2 +-
...re_v1beta.projects.locations.services.html | 2 +-
docs/dyn/metastore_v2.html | 111 +
docs/dyn/metastore_v2.projects.html | 91 +
docs/dyn/metastore_v2.projects.locations.html | 91 +
...2.projects.locations.services.backups.html | 452 ++
...astore_v2.projects.locations.services.html | 865 ++++
docs/dyn/metastore_v2alpha.html | 111 +
docs/dyn/metastore_v2alpha.projects.html | 91 +
.../metastore_v2alpha.projects.locations.html | 91 +
...a.projects.locations.services.backups.html | 476 ++
...e_v2alpha.projects.locations.services.html | 1093 +++++
...ocations.services.migrationExecutions.html | 250 +
docs/dyn/metastore_v2beta.html | 111 +
docs/dyn/metastore_v2beta.projects.html | 91 +
.../metastore_v2beta.projects.locations.html | 91 +
...a.projects.locations.services.backups.html | 476 ++
...re_v2beta.projects.locations.services.html | 1093 +++++
...ocations.services.migrationExecutions.html | 250 +
...tapp_v1.projects.locations.operations.html | 4 +-
...pp_v1.projects.locations.storagePools.html | 45 +
.../netapp_v1.projects.locations.volumes.html | 5 -
...ojects.locations.volumes.replications.html | 16 +
...v1beta1.projects.locations.operations.html | 4 +-
...beta1.projects.locations.storagePools.html | 45 +
...pp_v1beta1.projects.locations.volumes.html | 5 -
...ojects.locations.volumes.replications.html | 16 +
...s.locations.global_.connectivityTests.html | 2172 +++++++--
...projects.locations.global_.operations.html | 4 +-
...s.locations.global_.connectivityTests.html | 2172 +++++++--
...projects.locations.global_.operations.html | 4 +-
...v1.organizations.locations.operations.html | 4 +-
...tions.locations.securityProfileGroups.html | 12 +-
...anizations.locations.securityProfiles.html | 20 +-
...y_v1.projects.locations.authzPolicies.html | 32 +-
...rity_v1.projects.locations.operations.html | 4 +-
...a1.organizations.locations.operations.html | 4 +-
...tions.locations.securityProfileGroups.html | 12 +-
...anizations.locations.securityProfiles.html | 20 +-
...eta1.projects.locations.authzPolicies.html | 32 +-
...rksecurity_v1beta1.projects.locations.html | 20 +
...s.locations.interceptDeploymentGroups.html | 341 ++
...ojects.locations.interceptDeployments.html | 328 ++
...ns.interceptEndpointGroupAssociations.html | 349 ++
...cts.locations.interceptEndpointGroups.html | 353 ++
...s.locations.mirroringDeploymentGroups.html | 8 +-
...v1beta1.projects.locations.operations.html | 4 +-
...ices_v1.projects.locations.operations.html | 4 +-
...v1beta1.projects.locations.operations.html | 4 +-
.../dyn/orgpolicy_v2.folders.constraints.html | 1 +
docs/dyn/orgpolicy_v2.folders.policies.html | 63 +
...rgpolicy_v2.organizations.constraints.html | 1 +
.../orgpolicy_v2.organizations.policies.html | 63 +
.../orgpolicy_v2.projects.constraints.html | 1 +
docs/dyn/orgpolicy_v2.projects.policies.html | 63 +
...osconfig_v1.projects.patchDeployments.html | 32 +-
...nfig_v1beta.projects.patchDeployments.html | 32 +-
...s.locations.backupCollections.backups.html | 2 +
....projects.locations.backupCollections.html | 2 +
.../redis_v1.projects.locations.clusters.html | 60 +-
...s.locations.backupCollections.backups.html | 2 +
....projects.locations.backupCollections.html | 2 +
...s_v1beta1.projects.locations.clusters.html | 60 +-
...tycenter_v1.organizations.attackPaths.html | 165 +
docs/dyn/securitycenter_v1.organizations.html | 5 +
...itycenter_v1.organizations.operations.html | 4 +-
...nter_v1beta1.organizations.operations.html | 4 +-
...servicemanagement_v1.services.configs.html | 16 +
docs/dyn/servicemanagement_v1.services.html | 4 +
...nager_v2.accounts.containers.versions.html | 7 +
...ger_v2.accounts.containers.workspaces.html | 8 +
...ounts.containers.workspaces.templates.html | 7 +
docs/dyn/vault_v1.operations.html | 4 +-
docs/dyn/walletobjects_v1.jwt.html | 4 +-
docs/dyn/walletobjects_v1.loyaltyclass.html | 18 +-
docs/dyn/walletobjects_v1.loyaltyobject.html | 20 +-
...ions_v1.projects.locations.operations.html | 4 +-
...orkstationClusters.workstationConfigs.html | 30 +-
...sters.workstationConfigs.workstations.html | 4 +-
..._v1beta.projects.locations.operations.html | 4 +-
...orkstationClusters.workstationConfigs.html | 30 +-
...sters.workstationConfigs.workstations.html | 4 +-
docs/dyn/youtube_v3.youtube.v3.html | 5 -
.../discovery_cache/documents/adsense.v2.json | 6 +-
.../documents/adsenseplatform.v1.json | 6 +-
.../documents/adsenseplatform.v1alpha.json | 6 +-
.../documents/aiplatform.v1.json | 985 +++-
.../documents/aiplatform.v1beta1.json | 746 ++-
.../androiddeviceprovisioning.v1.json | 6 +-
.../documents/androidmanagement.v1.json | 20 +-
.../documents/appengine.v1.json | 49 +-
.../documents/appengine.v1beta.json | 49 +-
.../documents/bigquery.v2.json | 10 +-
.../discovery_cache/documents/chat.v1.json | 4 +-
.../documents/checks.v1alpha.json | 10 +-
.../documents/cloudchannel.v1.json | 16 +-
.../documents/compute.alpha.json | 1326 +++++-
.../documents/compute.beta.json | 999 +++-
.../discovery_cache/documents/compute.v1.json | 4137 ++++++++++++-----
.../documents/connectors.v1.json | 228 +-
.../documents/contactcenterinsights.v1.json | 46 +-
.../documents/contentwarehouse.v1.json | 16 +-
.../documents/datacatalog.v1.json | 4 +-
.../documents/dataform.v1beta1.json | 221 +-
.../documents/datafusion.v1.json | 393 +-
.../documents/datafusion.v1beta1.json | 362 +-
.../documents/datalineage.v1.json | 6 +-
.../documents/datamigration.v1.json | 333 +-
.../documents/datamigration.v1beta1.json | 4 +-
.../documents/digitalassetlinks.v1.json | 3 +-
.../documents/discoveryengine.v1.json | 634 ++-
.../documents/discoveryengine.v1alpha.json | 628 ++-
.../documents/discoveryengine.v1beta.json | 839 +++-
.../documents/displayvideo.v2.json | 16 +-
.../documents/displayvideo.v3.json | 26 +-
.../discovery_cache/documents/dlp.v2.json | 6 +-
.../documents/eventarc.v1.json | 32 +-
.../firebaseappdistribution.v1alpha.json | 27 +-
.../documents/firebasedatabase.v1beta.json | 4 +-
.../documents/firebasehosting.v1.json | 4 +-
.../documents/firebaseml.v2beta.json | 84 +-
.../discovery_cache/documents/iap.v1.json | 4 +-
.../documents/integrations.v1.json | 124 +-
.../documents/localservices.v1.json | 6 +-
.../documents/metastore.v1.json | 6 +-
.../documents/metastore.v1alpha.json | 6 +-
.../documents/metastore.v1beta.json | 6 +-
.../documents/metastore.v2.json | 1813 ++++++++
.../documents/metastore.v2alpha.json | 2313 +++++++++
.../documents/metastore.v2beta.json | 2313 +++++++++
.../discovery_cache/documents/netapp.v1.json | 328 +-
.../documents/netapp.v1beta1.json | 328 +-
.../documents/networkmanagement.v1.json | 13 +-
.../documents/networkmanagement.v1beta1.json | 13 +-
.../documents/networksecurity.v1.json | 43 +-
.../documents/networksecurity.v1beta1.json | 3279 ++++++++-----
.../documents/networkservices.v1.json | 6 +-
.../documents/networkservices.v1beta1.json | 6 +-
.../documents/orgpolicy.v2.json | 14 +-
.../documents/osconfig.v1.json | 6 +-
.../documents/osconfig.v1beta.json | 6 +-
.../discovery_cache/documents/redis.v1.json | 95 +-
.../documents/redis.v1beta1.json | 95 +-
.../documents/securitycenter.v1.json | 446 +-
.../documents/securitycenter.v1beta1.json | 401 +-
.../documents/securitycenter.v1beta2.json | 399 +-
.../documents/servicemanagement.v1.json | 13 +-
.../documents/tagmanager.v2.json | 6 +-
.../discovery_cache/documents/vault.v1.json | 4 +-
.../documents/walletobjects.v1.json | 4 +-
.../documents/workstations.v1.json | 12 +-
.../documents/workstations.v1beta.json | 12 +-
.../discovery_cache/documents/youtube.v3.json | 68 +-
385 files changed, 46350 insertions(+), 8700 deletions(-)
create mode 100644 docs/dyn/aiplatform_v1.projects.locations.ragCorpora.operations.html
create mode 100644 docs/dyn/aiplatform_v1.projects.locations.ragCorpora.ragFiles.operations.html
create mode 100644 docs/dyn/compute_v1.networkProfiles.html
create mode 100644 docs/dyn/metastore_v2.html
create mode 100644 docs/dyn/metastore_v2.projects.html
create mode 100644 docs/dyn/metastore_v2.projects.locations.html
create mode 100644 docs/dyn/metastore_v2.projects.locations.services.backups.html
create mode 100644 docs/dyn/metastore_v2.projects.locations.services.html
create mode 100644 docs/dyn/metastore_v2alpha.html
create mode 100644 docs/dyn/metastore_v2alpha.projects.html
create mode 100644 docs/dyn/metastore_v2alpha.projects.locations.html
create mode 100644 docs/dyn/metastore_v2alpha.projects.locations.services.backups.html
create mode 100644 docs/dyn/metastore_v2alpha.projects.locations.services.html
create mode 100644 docs/dyn/metastore_v2alpha.projects.locations.services.migrationExecutions.html
create mode 100644 docs/dyn/metastore_v2beta.html
create mode 100644 docs/dyn/metastore_v2beta.projects.html
create mode 100644 docs/dyn/metastore_v2beta.projects.locations.html
create mode 100644 docs/dyn/metastore_v2beta.projects.locations.services.backups.html
create mode 100644 docs/dyn/metastore_v2beta.projects.locations.services.html
create mode 100644 docs/dyn/metastore_v2beta.projects.locations.services.migrationExecutions.html
create mode 100644 docs/dyn/networksecurity_v1beta1.projects.locations.interceptDeploymentGroups.html
create mode 100644 docs/dyn/networksecurity_v1beta1.projects.locations.interceptDeployments.html
create mode 100644 docs/dyn/networksecurity_v1beta1.projects.locations.interceptEndpointGroupAssociations.html
create mode 100644 docs/dyn/networksecurity_v1beta1.projects.locations.interceptEndpointGroups.html
create mode 100644 docs/dyn/securitycenter_v1.organizations.attackPaths.html
create mode 100644 googleapiclient/discovery_cache/documents/metastore.v2.json
create mode 100644 googleapiclient/discovery_cache/documents/metastore.v2alpha.json
create mode 100644 googleapiclient/discovery_cache/documents/metastore.v2beta.json
diff --git a/docs/dyn/adsense_v2.accounts.html b/docs/dyn/adsense_v2.accounts.html
index 0c8108b350d..071245c8a65 100644
--- a/docs/dyn/adsense_v2.accounts.html
+++ b/docs/dyn/adsense_v2.accounts.html
@@ -155,8 +155,8 @@ Method Details
"premium": True or False, # Output only. Whether this account is premium.
"state": "A String", # Output only. State of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
- "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
- "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
}
@@ -208,8 +208,8 @@ Method Details
"premium": True or False, # Output only. Whether this account is premium.
"state": "A String", # Output only. State of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
- "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
- "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
},
],
@@ -245,8 +245,8 @@ Method Details
"premium": True or False, # Output only. Whether this account is premium.
"state": "A String", # Output only. State of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
- "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
- "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
},
],
diff --git a/docs/dyn/adsenseplatform_v1.platforms.accounts.html b/docs/dyn/adsenseplatform_v1.platforms.accounts.html
index 06f3491d1fa..5c16537c2fa 100644
--- a/docs/dyn/adsenseplatform_v1.platforms.accounts.html
+++ b/docs/dyn/adsenseplatform_v1.platforms.accounts.html
@@ -144,8 +144,8 @@ Method Details
"regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
"state": "A String", # Output only. Approval state of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
- "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
- "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
}
@@ -165,8 +165,8 @@ Method Details
"regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
"state": "A String", # Output only. Approval state of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
- "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
- "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
}
@@ -193,8 +193,8 @@ Method Details
"regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
"state": "A String", # Output only. Approval state of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
- "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
- "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
}
@@ -225,8 +225,8 @@ Method Details
"regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
"state": "A String", # Output only. Approval state of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
- "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
- "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
},
],
diff --git a/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html
index d2be5261406..91a9c5f4005 100644
--- a/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html
+++ b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html
@@ -144,8 +144,8 @@ Method Details
"regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
"state": "A String", # Output only. Approval state of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
- "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
- "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
}
@@ -165,8 +165,8 @@ Method Details
"regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
"state": "A String", # Output only. Approval state of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
- "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
- "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
}
@@ -193,8 +193,8 @@ Method Details
"regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
"state": "A String", # Output only. Approval state of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
- "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
- "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
}
@@ -225,8 +225,8 @@ Method Details
"regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
"state": "A String", # Output only. Approval state of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
- "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
- "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
},
],
diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html
index 8a35e6f9577..4a966e18293 100644
--- a/docs/dyn/aiplatform_v1.endpoints.html
+++ b/docs/dyn/aiplatform_v1.endpoints.html
@@ -221,6 +221,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
@@ -264,10 +267,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -383,6 +394,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -487,6 +500,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
@@ -530,10 +546,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -663,6 +687,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -913,6 +939,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
@@ -956,10 +985,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -1089,6 +1126,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
diff --git a/docs/dyn/aiplatform_v1.media.html b/docs/dyn/aiplatform_v1.media.html
index 029ba8a16a9..0ef633a5d83 100644
--- a/docs/dyn/aiplatform_v1.media.html
+++ b/docs/dyn/aiplatform_v1.media.html
@@ -137,6 +137,23 @@ Method Details
],
},
"name": "A String", # Output only. The resource name of the RagFile.
+ "sharePointSources": { # The SharePointSources to pass to ImportRagFiles. # The RagFile is imported from a SharePoint source.
+ "sharePointSources": [ # The SharePoint sources.
+ { # An individual SharePointSource.
+ "clientId": "A String", # The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All.
+ "clientSecret": { # The API secret. # The application secret for the app registered in Azure.
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "driveId": "A String", # The ID of the drive to download from.
+ "driveName": "A String", # The name of the drive to download from.
+ "fileId": "A String", # Output only. The SharePoint file id. Output only.
+ "sharepointFolderId": "A String", # The ID of the SharePoint folder to download from.
+ "sharepointFolderPath": "A String", # The path of the SharePoint folder to download from.
+ "sharepointSiteName": "A String", # The name of the SharePoint site to download from. This can be the site name or the site id.
+ "tenantId": "A String", # Unique identifier of the Azure Active Directory Instance.
+ },
+ ],
+ },
"slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel.
"channels": [ # Required. The Slack channels.
{ # SlackChannels contains the Slack channels and corresponding access token.
@@ -228,6 +245,23 @@ Method Details
],
},
"name": "A String", # Output only. The resource name of the RagFile.
+ "sharePointSources": { # The SharePointSources to pass to ImportRagFiles. # The RagFile is imported from a SharePoint source.
+ "sharePointSources": [ # The SharePoint sources.
+ { # An individual SharePointSource.
+ "clientId": "A String", # The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All.
+ "clientSecret": { # The API secret. # The application secret for the app registered in Azure.
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "driveId": "A String", # The ID of the drive to download from.
+ "driveName": "A String", # The name of the drive to download from.
+ "fileId": "A String", # Output only. The SharePoint file id. Output only.
+ "sharepointFolderId": "A String", # The ID of the SharePoint folder to download from.
+ "sharepointFolderPath": "A String", # The path of the SharePoint folder to download from.
+ "sharepointSiteName": "A String", # The name of the SharePoint site to download from. This can be the site name or the site id.
+ "tenantId": "A String", # Unique identifier of the Azure Active Directory Instance.
+ },
+ ],
+ },
"slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel.
"channels": [ # Required. The Slack channels.
{ # SlackChannels contains the Slack channels and corresponding access token.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html
index 6056a8bd708..cba71bfa54c 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html
@@ -266,6 +266,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -475,6 +477,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -709,6 +713,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -929,6 +935,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -1157,6 +1165,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -1367,6 +1377,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
index 3a33595cdbd..92908b2d8e2 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
@@ -288,6 +288,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
@@ -331,10 +334,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -450,6 +461,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -1450,6 +1463,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
@@ -1493,10 +1509,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -1626,6 +1650,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -3306,6 +3332,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
@@ -3349,10 +3378,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -3482,6 +3519,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html
index 9fb5beecaf3..e6eece1d180 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.html
@@ -752,6 +752,143 @@ Method Details
"useStrictStringMatch": True or False, # Optional. Whether to use STRICT string match on parameter values.
},
},
+ "trajectoryAnyOrderMatchInput": { # Instances and metric spec for TrajectoryAnyOrderMatch metric. # Input for trajectory match any order metric.
+ "instances": [ # Required. Repeated TrajectoryAnyOrderMatch instance.
+ { # Spec for TrajectoryAnyOrderMatch instance.
+ "predictedTrajectory": { # Spec for trajectory. # Required. Spec for predicted tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ "referenceTrajectory": { # Spec for trajectory. # Required. Spec for reference tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ },
+ ],
+ "metricSpec": { # Spec for TrajectoryAnyOrderMatch metric - returns 1 if all tool calls in the reference trajectory appear in the predicted trajectory in any order, else 0. # Required. Spec for TrajectoryAnyOrderMatch metric.
+ },
+ },
+ "trajectoryExactMatchInput": { # Instances and metric spec for TrajectoryExactMatch metric. # Input for trajectory exact match metric.
+ "instances": [ # Required. Repeated TrajectoryExactMatch instance.
+ { # Spec for TrajectoryExactMatch instance.
+ "predictedTrajectory": { # Spec for trajectory. # Required. Spec for predicted tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ "referenceTrajectory": { # Spec for trajectory. # Required. Spec for reference tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ },
+ ],
+ "metricSpec": { # Spec for TrajectoryExactMatch metric - returns 1 if tool calls in the reference trajectory exactly match the predicted trajectory, else 0. # Required. Spec for TrajectoryExactMatch metric.
+ },
+ },
+ "trajectoryInOrderMatchInput": { # Instances and metric spec for TrajectoryInOrderMatch metric. # Input for trajectory in order match metric.
+ "instances": [ # Required. Repeated TrajectoryInOrderMatch instance.
+ { # Spec for TrajectoryInOrderMatch instance.
+ "predictedTrajectory": { # Spec for trajectory. # Required. Spec for predicted tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ "referenceTrajectory": { # Spec for trajectory. # Required. Spec for reference tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ },
+ ],
+ "metricSpec": { # Spec for TrajectoryInOrderMatch metric - returns 1 if tool calls in the reference trajectory appear in the predicted trajectory in the same order, else 0. # Required. Spec for TrajectoryInOrderMatch metric.
+ },
+ },
+ "trajectoryPrecisionInput": { # Instances and metric spec for TrajectoryPrecision metric. # Input for trajectory precision metric.
+ "instances": [ # Required. Repeated TrajectoryPrecision instance.
+ { # Spec for TrajectoryPrecision instance.
+ "predictedTrajectory": { # Spec for trajectory. # Required. Spec for predicted tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ "referenceTrajectory": { # Spec for trajectory. # Required. Spec for reference tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ },
+ ],
+ "metricSpec": { # Spec for TrajectoryPrecision metric - returns a float score based on average precision of individual tool calls. # Required. Spec for TrajectoryPrecision metric.
+ },
+ },
+ "trajectoryRecallInput": { # Instances and metric spec for TrajectoryRecall metric. # Input for trajectory recall metric.
+ "instances": [ # Required. Repeated TrajectoryRecall instance.
+ { # Spec for TrajectoryRecall instance.
+ "predictedTrajectory": { # Spec for trajectory. # Required. Spec for predicted tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ "referenceTrajectory": { # Spec for trajectory. # Required. Spec for reference tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ },
+ ],
+ "metricSpec": { # Spec for TrajectoryRecall metric - returns a float score based on average recall of individual tool calls. # Required. Spec for TrajectoryRecall metric.
+ },
+ },
+ "trajectorySingleToolUseInput": { # Instances and metric spec for TrajectorySingleToolUse metric. # Input for trajectory single tool use metric.
+ "instances": [ # Required. Repeated TrajectorySingleToolUse instance.
+ { # Spec for TrajectorySingleToolUse instance.
+ "predictedTrajectory": { # Spec for trajectory. # Required. Spec for predicted tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ },
+ ],
+ "metricSpec": { # Spec for TrajectorySingleToolUse metric - returns 1 if tool is present in the predicted trajectory, else 0. # Required. Spec for TrajectorySingleToolUse metric.
+ "toolName": "A String", # Required. Spec for tool name to be checked for in the predicted trajectory.
+ },
+ },
}
x__xgafv: string, V1 error format.
@@ -896,6 +1033,48 @@ Method Details
},
],
},
+ "trajectoryAnyOrderMatchResults": { # Results for TrajectoryAnyOrderMatch metric. # Result for trajectory any order match metric.
+ "trajectoryAnyOrderMatchMetricValues": [ # Output only. TrajectoryAnyOrderMatch metric values.
+ { # TrajectoryAnyOrderMatch metric value for an instance.
+ "score": 3.14, # Output only. TrajectoryAnyOrderMatch score.
+ },
+ ],
+ },
+ "trajectoryExactMatchResults": { # Results for TrajectoryExactMatch metric. # Result for trajectory exact match metric.
+ "trajectoryExactMatchMetricValues": [ # Output only. TrajectoryExactMatch metric values.
+ { # TrajectoryExactMatch metric value for an instance.
+ "score": 3.14, # Output only. TrajectoryExactMatch score.
+ },
+ ],
+ },
+ "trajectoryInOrderMatchResults": { # Results for TrajectoryInOrderMatch metric. # Result for trajectory in order match metric.
+ "trajectoryInOrderMatchMetricValues": [ # Output only. TrajectoryInOrderMatch metric values.
+ { # TrajectoryInOrderMatch metric value for an instance.
+ "score": 3.14, # Output only. TrajectoryInOrderMatch score.
+ },
+ ],
+ },
+ "trajectoryPrecisionResults": { # Results for TrajectoryPrecision metric. # Result for trajectory precision metric.
+ "trajectoryPrecisionMetricValues": [ # Output only. TrajectoryPrecision metric values.
+ { # TrajectoryPrecision metric value for an instance.
+ "score": 3.14, # Output only. TrajectoryPrecision score.
+ },
+ ],
+ },
+ "trajectoryRecallResults": { # Results for TrajectoryRecall metric. # Results for trajectory recall metric.
+ "trajectoryRecallMetricValues": [ # Output only. TrajectoryRecall metric values.
+ { # TrajectoryRecall metric value for an instance.
+ "score": 3.14, # Output only. TrajectoryRecall score.
+ },
+ ],
+ },
+ "trajectorySingleToolUseResults": { # Results for TrajectorySingleToolUse metric. # Results for trajectory single tool use metric.
+ "trajectorySingleToolUseMetricValues": [ # Output only. TrajectorySingleToolUse metric values.
+ { # TrajectorySingleToolUse metric value for an instance.
+ "score": 3.14, # Output only. TrajectorySingleToolUse score.
+ },
+ ],
+ },
}
diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimeTemplates.html b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimeTemplates.html
index bbd33610f15..51d56400b8a 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimeTemplates.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimeTemplates.html
@@ -144,7 +144,7 @@ Method Details
"idleShutdownDisabled": True or False, # Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
"idleTimeout": "A String", # Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60.
},
- "isDefault": True or False, # Output only. The default template to use if not specified.
+ "isDefault": True or False, # Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.
"labels": { # The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
@@ -171,7 +171,7 @@ Method Details
"A String",
],
"notebookRuntimeType": "A String", # Optional. Immutable. The type of the notebook runtime template.
- "serviceAccount": "A String", # The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
+ "serviceAccount": "A String", # Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
"shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
"enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
},
@@ -277,7 +277,7 @@ Method Details
"idleShutdownDisabled": True or False, # Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
"idleTimeout": "A String", # Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60.
},
- "isDefault": True or False, # Output only. The default template to use if not specified.
+ "isDefault": True or False, # Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.
"labels": { # The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
@@ -304,7 +304,7 @@ Method Details
"A String",
],
"notebookRuntimeType": "A String", # Optional. Immutable. The type of the notebook runtime template.
- "serviceAccount": "A String", # The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
+ "serviceAccount": "A String", # Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
"shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
"enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
},
@@ -353,7 +353,7 @@ Method Details
Args:
parent: string, Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}` (required)
- filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED`
+ filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`
orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
pageSize: integer, Optional. The standard list page size.
pageToken: string, Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.
@@ -389,7 +389,7 @@ Method Details
"idleShutdownDisabled": True or False, # Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
"idleTimeout": "A String", # Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60.
},
- "isDefault": True or False, # Output only. The default template to use if not specified.
+ "isDefault": True or False, # Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.
"labels": { # The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
@@ -416,7 +416,7 @@ Method Details
"A String",
],
"notebookRuntimeType": "A String", # Optional. Immutable. The type of the notebook runtime template.
- "serviceAccount": "A String", # The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
+ "serviceAccount": "A String", # Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
"shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
"enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
},
@@ -469,7 +469,7 @@ Method Details
"idleShutdownDisabled": True or False, # Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
"idleTimeout": "A String", # Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60.
},
- "isDefault": True or False, # Output only. The default template to use if not specified.
+ "isDefault": True or False, # Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.
"labels": { # The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
@@ -496,7 +496,7 @@ Method Details
"A String",
],
"notebookRuntimeType": "A String", # Optional. Immutable. The type of the notebook runtime template.
- "serviceAccount": "A String", # The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
+ "serviceAccount": "A String", # Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
"shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
"enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
},
@@ -532,7 +532,7 @@ Method Details
"idleShutdownDisabled": True or False, # Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
"idleTimeout": "A String", # Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60.
},
- "isDefault": True or False, # Output only. The default template to use if not specified.
+ "isDefault": True or False, # Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.
"labels": { # The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
@@ -559,7 +559,7 @@ Method Details
"A String",
],
"notebookRuntimeType": "A String", # Optional. Immutable. The type of the notebook runtime template.
- "serviceAccount": "A String", # The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
+ "serviceAccount": "A String", # Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
"shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
"enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
},
diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.html b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.html
index 3ebb925e22f..7a5620dbecc 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.html
@@ -119,11 +119,19 @@ Method Details
{ # Request message for NotebookService.AssignNotebookRuntime.
"notebookRuntime": { # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours. # Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment.
"createTime": "A String", # Output only. Timestamp when this NotebookRuntime was created.
+ "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.
+ "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
+ "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
+ },
"description": "A String", # The description of the NotebookRuntime.
"displayName": "A String", # Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Output only. Customer-managed encryption key spec for the notebook runtime.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
+ "eucConfig": { # The euc configuration of NotebookRuntimeTemplate. # Output only. EUC configuration of the notebook runtime.
+ "bypassActasCheck": True or False, # Output only. Whether ActAs check is bypassed for service account attached to the VM. If false, we need ActAs check for the default Compute Engine Service account. When a Runtime is created, a VM is allocated using Default Compute Engine Service Account. Any user requesting to use this Runtime requires Service Account User (ActAs) permission over this SA. If true, Runtime owner is using EUC and does not require the above permission as VM no longer use default Compute Engine SA, but a P4SA.
+ "eucDisabled": True or False, # Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. In proto3, the default value of a boolean is false. In this way, by default EUC will be enabled for NotebookRuntimeTemplate.
+ },
"expirationTime": "A String", # Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
"healthState": "A String", # Output only. The health state of the NotebookRuntime.
"idleShutdownConfig": { # The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field. # Output only. The idle shutdown configuration of the notebook runtime.
@@ -134,7 +142,25 @@ Method Details
"labels": { # The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.
"a_key": "A String",
},
+ "machineSpec": { # Specification of a single machine. # Output only. The specification of a single machine used by the notebook runtime.
+ "acceleratorCount": 42, # The number of accelerators to attach to the machine.
+ "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
+ "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
+ "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
+ "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
+ "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
+ "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
+ "A String",
+ ],
+ },
+ "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
+ },
"name": "A String", # Output only. The resource name of the NotebookRuntime.
+ "networkSpec": { # Network spec. # Output only. Network spec of the notebook runtime.
+ "enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
+ "network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
+ "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
+ },
"networkTags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
"A String",
],
@@ -147,7 +173,10 @@ Method Details
"runtimeUser": "A String", # Required. The user email of the NotebookRuntime.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
- "serviceAccount": "A String", # Output only. The service account that the NotebookRuntime workload runs as.
+ "serviceAccount": "A String", # Output only. Deprecated: This field is no longer used and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. The service account that the NotebookRuntime workload runs as.
+ "shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Output only. Runtime Shielded VM spec.
+ "enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
+ },
"updateTime": "A String", # Output only. Timestamp when this NotebookRuntime was most recently updated.
"version": "A String", # Output only. The VM os image version of NotebookRuntime.
},
@@ -240,11 +269,19 @@ Method Details
{ # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.
"createTime": "A String", # Output only. Timestamp when this NotebookRuntime was created.
+ "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.
+ "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
+ "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
+ },
"description": "A String", # The description of the NotebookRuntime.
"displayName": "A String", # Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Output only. Customer-managed encryption key spec for the notebook runtime.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
+ "eucConfig": { # The euc configuration of NotebookRuntimeTemplate. # Output only. EUC configuration of the notebook runtime.
+ "bypassActasCheck": True or False, # Output only. Whether ActAs check is bypassed for service account attached to the VM. If false, we need ActAs check for the default Compute Engine Service account. When a Runtime is created, a VM is allocated using Default Compute Engine Service Account. Any user requesting to use this Runtime requires Service Account User (ActAs) permission over this SA. If true, Runtime owner is using EUC and does not require the above permission as VM no longer use default Compute Engine SA, but a P4SA.
+ "eucDisabled": True or False, # Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. In proto3, the default value of a boolean is false. In this way, by default EUC will be enabled for NotebookRuntimeTemplate.
+ },
"expirationTime": "A String", # Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
"healthState": "A String", # Output only. The health state of the NotebookRuntime.
"idleShutdownConfig": { # The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field. # Output only. The idle shutdown configuration of the notebook runtime.
@@ -255,7 +292,25 @@ Method Details
"labels": { # The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.
"a_key": "A String",
},
+ "machineSpec": { # Specification of a single machine. # Output only. The specification of a single machine used by the notebook runtime.
+ "acceleratorCount": 42, # The number of accelerators to attach to the machine.
+ "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
+ "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
+ "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
+ "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
+ "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
+ "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
+ "A String",
+ ],
+ },
+ "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
+ },
"name": "A String", # Output only. The resource name of the NotebookRuntime.
+ "networkSpec": { # Network spec. # Output only. Network spec of the notebook runtime.
+ "enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
+ "network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
+ "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
+ },
"networkTags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
"A String",
],
@@ -268,7 +323,10 @@ Method Details
"runtimeUser": "A String", # Required. The user email of the NotebookRuntime.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
- "serviceAccount": "A String", # Output only. The service account that the NotebookRuntime workload runs as.
+ "serviceAccount": "A String", # Output only. Deprecated: This field is no longer used and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. The service account that the NotebookRuntime workload runs as.
+ "shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Output only. Runtime Shielded VM spec.
+ "enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
+ },
"updateTime": "A String", # Output only. Timestamp when this NotebookRuntime was most recently updated.
"version": "A String", # Output only. The VM os image version of NotebookRuntime.
}
@@ -280,7 +338,7 @@ Method Details
Args:
parent: string, Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}` (required)
- filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED`
+ filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`
orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
pageSize: integer, Optional. The standard list page size.
pageToken: string, Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.
@@ -298,11 +356,19 @@ Method Details
"notebookRuntimes": [ # List of NotebookRuntimes in the requested page.
{ # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.
"createTime": "A String", # Output only. Timestamp when this NotebookRuntime was created.
+ "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.
+ "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
+ "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
+ },
"description": "A String", # The description of the NotebookRuntime.
"displayName": "A String", # Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Output only. Customer-managed encryption key spec for the notebook runtime.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
+ "eucConfig": { # The euc configuration of NotebookRuntimeTemplate. # Output only. EUC configuration of the notebook runtime.
+ "bypassActasCheck": True or False, # Output only. Whether ActAs check is bypassed for service account attached to the VM. If false, we need ActAs check for the default Compute Engine Service account. When a Runtime is created, a VM is allocated using Default Compute Engine Service Account. Any user requesting to use this Runtime requires Service Account User (ActAs) permission over this SA. If true, Runtime owner is using EUC and does not require the above permission as VM no longer use default Compute Engine SA, but a P4SA.
+ "eucDisabled": True or False, # Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. In proto3, the default value of a boolean is false. In this way, by default EUC will be enabled for NotebookRuntimeTemplate.
+ },
"expirationTime": "A String", # Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
"healthState": "A String", # Output only. The health state of the NotebookRuntime.
"idleShutdownConfig": { # The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field. # Output only. The idle shutdown configuration of the notebook runtime.
@@ -313,7 +379,25 @@ Method Details
"labels": { # The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.
"a_key": "A String",
},
+ "machineSpec": { # Specification of a single machine. # Output only. The specification of a single machine used by the notebook runtime.
+ "acceleratorCount": 42, # The number of accelerators to attach to the machine.
+ "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
+ "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
+ "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
+ "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
+ "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
+ "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
+ "A String",
+ ],
+ },
+ "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
+ },
"name": "A String", # Output only. The resource name of the NotebookRuntime.
+ "networkSpec": { # Network spec. # Output only. Network spec of the notebook runtime.
+ "enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
+ "network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
+ "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
+ },
"networkTags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
"A String",
],
@@ -326,7 +410,10 @@ Method Details
"runtimeUser": "A String", # Required. The user email of the NotebookRuntime.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
- "serviceAccount": "A String", # Output only. The service account that the NotebookRuntime workload runs as.
+ "serviceAccount": "A String", # Output only. Deprecated: This field is no longer used and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. The service account that the NotebookRuntime workload runs as.
+ "shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Output only. Runtime Shielded VM spec.
+ "enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
+ },
"updateTime": "A String", # Output only. Timestamp when this NotebookRuntime was most recently updated.
"version": "A String", # Output only. The VM os image version of NotebookRuntime.
},
diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
index 5ca40c908a4..b8c6815eeb9 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
@@ -239,6 +239,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
@@ -282,10 +285,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -401,6 +412,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -547,6 +560,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
@@ -590,10 +606,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -723,6 +747,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -1282,6 +1308,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
@@ -1325,10 +1354,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -1458,6 +1495,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.html b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.html
index 62fbccb85e1..d0df35947b2 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.html
@@ -74,6 +74,11 @@
Instance Methods
+
+ operations()
+
+Returns the operations Resource.
+
ragFiles()
@@ -141,6 +146,8 @@ Method Details
"modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.
},
},
+ "ragManagedDb": { # The config for the default RAG-managed Vector DB. # The config for the RAG-managed Vector DB.
+ },
"vertexVectorSearch": { # The config for the Vertex Vector Search. # The config for the Vertex Vector Search.
"index": "A String", # The resource name of the Index. Format: `projects/{project}/locations/{location}/indexes/{index}`
"indexEndpoint": "A String", # The resource name of the Index Endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
@@ -253,6 +260,8 @@ Method Details
"modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.
},
},
+ "ragManagedDb": { # The config for the default RAG-managed Vector DB. # The config for the RAG-managed Vector DB.
+ },
"vertexVectorSearch": { # The config for the Vertex Vector Search. # The config for the Vertex Vector Search.
"index": "A String", # The resource name of the Index. Format: `projects/{project}/locations/{location}/indexes/{index}`
"indexEndpoint": "A String", # The resource name of the Index Endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
@@ -306,6 +315,8 @@ Method Details
"modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.
},
},
+ "ragManagedDb": { # The config for the default RAG-managed Vector DB. # The config for the RAG-managed Vector DB.
+ },
"vertexVectorSearch": { # The config for the Vertex Vector Search. # The config for the Vertex Vector Search.
"index": "A String", # The resource name of the Index. Format: `projects/{project}/locations/{location}/indexes/{index}`
"indexEndpoint": "A String", # The resource name of the Index Endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
@@ -365,6 +376,8 @@ Method Details
"modelVersionId": "A String", # Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.
},
},
+ "ragManagedDb": { # The config for the default RAG-managed Vector DB. # The config for the RAG-managed Vector DB.
+ },
"vertexVectorSearch": { # The config for the Vertex Vector Search. # The config for the Vertex Vector Search.
"index": "A String", # The resource name of the Index. Format: `projects/{project}/locations/{location}/indexes/{index}`
"indexEndpoint": "A String", # The resource name of the Index Endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
diff --git a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.operations.html b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.operations.html
new file mode 100644
index 00000000000..778111257e1
--- /dev/null
+++ b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.operations.html
@@ -0,0 +1,268 @@
+
+
+
+
+Instance Methods
+
+ cancel(name, x__xgafv=None)
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+ close()
+Close httplib2 connections.
+
+ delete(name, x__xgafv=None)
+Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+ get(name, x__xgafv=None)
+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.
+
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+ list_next()
+Retrieves the next page of results.
+
+ wait(name, timeout=None, x__xgafv=None)
+Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+Method Details
+
+
cancel(name, x__xgafv=None)
+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
close()
+
Close httplib2 connections.
+
+
delete(name, x__xgafv=None)
+
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
get(name, x__xgafv=None)
+
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.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation's parent resource. (required)
+ filter: string, The standard list filter.
+ pageSize: integer, The standard list page size.
+ pageToken: string, The standard list page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+}
+
+
list_next()
+
Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
wait(name, timeout=None, x__xgafv=None)
+
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+ name: string, The name of the operation resource to wait on. (required)
+ timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
Instance Methods
+
+ operations()
+
+Returns the operations Resource.
+
close()
Close httplib2 connections.
@@ -188,6 +193,23 @@ Method Details
],
},
"name": "A String", # Output only. The resource name of the RagFile.
+ "sharePointSources": { # The SharePointSources to pass to ImportRagFiles. # The RagFile is imported from a SharePoint source.
+ "sharePointSources": [ # The SharePoint sources.
+ { # An individual SharePointSource.
+ "clientId": "A String", # The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All.
+ "clientSecret": { # The API secret. # The application secret for the app registered in Azure.
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "driveId": "A String", # The ID of the drive to download from.
+ "driveName": "A String", # The name of the drive to download from.
+ "fileId": "A String", # Output only. The SharePoint file id. Output only.
+ "sharepointFolderId": "A String", # The ID of the SharePoint folder to download from.
+ "sharepointFolderPath": "A String", # The path of the SharePoint folder to download from.
+ "sharepointSiteName": "A String", # The name of the SharePoint site to download from. This can be the site name or the site id.
+ "tenantId": "A String", # Unique identifier of the Azure Active Directory Instance.
+ },
+ ],
+ },
"slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel.
"channels": [ # Required. The Slack channels.
{ # SlackChannels contains the Slack channels and corresponding access token.
@@ -264,6 +286,23 @@ Method Details
},
},
},
+ "sharePointSources": { # The SharePointSources to pass to ImportRagFiles. # SharePoint sources.
+ "sharePointSources": [ # The SharePoint sources.
+ { # An individual SharePointSource.
+ "clientId": "A String", # The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All.
+ "clientSecret": { # The API secret. # The application secret for the app registered in Azure.
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "driveId": "A String", # The ID of the drive to download from.
+ "driveName": "A String", # The name of the drive to download from.
+ "fileId": "A String", # Output only. The SharePoint file id. Output only.
+ "sharepointFolderId": "A String", # The ID of the SharePoint folder to download from.
+ "sharepointFolderPath": "A String", # The path of the SharePoint folder to download from.
+ "sharepointSiteName": "A String", # The name of the SharePoint site to download from. This can be the site name or the site id.
+ "tenantId": "A String", # Unique identifier of the Azure Active Directory Instance.
+ },
+ ],
+ },
"slackSource": { # The Slack source for the ImportRagFilesRequest. # Slack channels with their corresponding access tokens.
"channels": [ # Required. The Slack channels.
{ # SlackChannels contains the Slack channels and corresponding access token.
@@ -372,6 +411,23 @@ Method Details
],
},
"name": "A String", # Output only. The resource name of the RagFile.
+ "sharePointSources": { # The SharePointSources to pass to ImportRagFiles. # The RagFile is imported from a SharePoint source.
+ "sharePointSources": [ # The SharePoint sources.
+ { # An individual SharePointSource.
+ "clientId": "A String", # The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All.
+ "clientSecret": { # The API secret. # The application secret for the app registered in Azure.
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "driveId": "A String", # The ID of the drive to download from.
+ "driveName": "A String", # The name of the drive to download from.
+ "fileId": "A String", # Output only. The SharePoint file id. Output only.
+ "sharepointFolderId": "A String", # The ID of the SharePoint folder to download from.
+ "sharepointFolderPath": "A String", # The path of the SharePoint folder to download from.
+ "sharepointSiteName": "A String", # The name of the SharePoint site to download from. This can be the site name or the site id.
+ "tenantId": "A String", # Unique identifier of the Azure Active Directory Instance.
+ },
+ ],
+ },
"slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel.
"channels": [ # Required. The Slack channels.
{ # SlackChannels contains the Slack channels and corresponding access token.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.ragFiles.operations.html b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.ragFiles.operations.html
new file mode 100644
index 00000000000..7e8c0be055f
--- /dev/null
+++ b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.ragFiles.operations.html
@@ -0,0 +1,268 @@
+
+
+
+
+Instance Methods
+
+ cancel(name, x__xgafv=None)
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+ close()
+Close httplib2 connections.
+
+ delete(name, x__xgafv=None)
+Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+ get(name, x__xgafv=None)
+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.
+
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+ list_next()
+Retrieves the next page of results.
+
+ wait(name, timeout=None, x__xgafv=None)
+Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+Method Details
+
+
cancel(name, x__xgafv=None)
+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
close()
+
Close httplib2 connections.
+
+
delete(name, x__xgafv=None)
+
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
get(name, x__xgafv=None)
+
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.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation's parent resource. (required)
+ filter: string, The standard list filter.
+ pageSize: integer, The standard list page size.
+ pageToken: string, The standard list page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+}
+
+
list_next()
+
Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
wait(name, timeout=None, x__xgafv=None)
+
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+ name: string, The name of the operation resource to wait on. (required)
+ timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
@@ -267,10 +270,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -386,6 +397,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -490,6 +503,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
@@ -533,10 +549,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -666,6 +690,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -1311,6 +1337,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
@@ -1354,10 +1383,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -1487,6 +1524,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html
index 50190c11389..b26863b5947 100644
--- a/docs/dyn/aiplatform_v1beta1.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.endpoints.html
@@ -237,6 +237,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -280,10 +283,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -409,6 +420,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -535,6 +548,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -578,10 +594,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -721,6 +745,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -1004,6 +1030,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -1047,10 +1076,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -1190,6 +1227,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html
index da9d3682c75..b7d58cf887a 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html
@@ -284,6 +284,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -525,6 +527,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -791,6 +795,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -1043,6 +1049,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -1303,6 +1311,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -1545,6 +1555,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
index c5c8ffc6788..fb3b36a84ce 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
@@ -313,6 +313,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -356,10 +359,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -485,6 +496,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -1646,6 +1659,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -1689,10 +1705,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -1832,6 +1856,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -3666,6 +3692,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -3709,10 +3738,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -3852,6 +3889,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.html
index d767cc75331..095ea1e8394 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.html
@@ -146,6 +146,8 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
+ "serviceAccountEmail": "A String", # Output only. A Service Account unique to this FeatureGroup. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to access source data while running jobs under this FeatureGroup.
+ "serviceAgentType": "A String", # Optional. Service agent type used during jobs under a FeatureGroup. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureGroup within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_GROUP`. This will generate a separate service account to access the BigQuery source table.
"updateTime": "A String", # Output only. Timestamp when this FeatureGroup was last updated.
}
@@ -250,6 +252,8 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
+ "serviceAccountEmail": "A String", # Output only. A Service Account unique to this FeatureGroup. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to access source data while running jobs under this FeatureGroup.
+ "serviceAgentType": "A String", # Optional. Service agent type used during jobs under a FeatureGroup. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureGroup within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_GROUP`. This will generate a separate service account to access the BigQuery source table.
"updateTime": "A String", # Output only. Timestamp when this FeatureGroup was last updated.
}
@@ -295,6 +299,8 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
+ "serviceAccountEmail": "A String", # Output only. A Service Account unique to this FeatureGroup. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to access source data while running jobs under this FeatureGroup.
+ "serviceAgentType": "A String", # Optional. Service agent type used during jobs under a FeatureGroup. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureGroup within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_GROUP`. This will generate a separate service account to access the BigQuery source table.
"updateTime": "A String", # Output only. Timestamp when this FeatureGroup was last updated.
},
],
@@ -346,6 +352,8 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
+ "serviceAccountEmail": "A String", # Output only. A Service Account unique to this FeatureGroup. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to access source data while running jobs under this FeatureGroup.
+ "serviceAgentType": "A String", # Optional. Service agent type used during jobs under a FeatureGroup. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureGroup within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_GROUP`. This will generate a separate service account to access the BigQuery source table.
"updateTime": "A String", # Output only. Timestamp when this FeatureGroup was last updated.
}
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html
index 8154d02dfba..93c1573a812 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html
@@ -293,6 +293,9 @@ Instance Methods
corroborateContent(parent, body=None, x__xgafv=None)
Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.
+
+ deploy(destination, body=None, x__xgafv=None)
+Deploys publisher models.
evaluateInstances(location, body=None, x__xgafv=None)
Evaluates instances based on a given metric.
@@ -558,6 +561,77 @@ Method Details
}
+
+
deploy(destination, body=None, x__xgafv=None)
+
Deploys publisher models.
+
+Args:
+ destination: string, Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ModelGardenService.DeployPublisherModel.
+ "acceptEula": True or False, # Optional. Whether the user accepts the End User License Agreement (EULA) for the model.
+ "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.
+ "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`.
+ { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.
+ "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization`
+ "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided.
+ },
+ ],
+ "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction.
+ "acceleratorCount": 42, # The number of accelerators to attach to the machine.
+ "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
+ "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
+ "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
+ "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
+ "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
+ "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
+ "A String",
+ ],
+ },
+ "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
+ },
+ "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).
+ "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed.
+ "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial model deployment/mutation is desired. If set, the model deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count.
+ "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
+ },
+ "endpointDisplayName": "A String", # Optional. The user-specified display name of the endpoint. If not set, a default name will be used.
+ "huggingFaceAccessToken": "A String", # Optional. The Hugging Face read access token used to access the model artifacts of gated models.
+ "model": "A String", # Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`
+ "modelDisplayName": "A String", # Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
evaluateInstances(location, body=None, x__xgafv=None)
Evaluates instances based on a given metric.
@@ -835,6 +909,143 @@ Method Details
"useStrictStringMatch": True or False, # Optional. Whether to use STRICT string match on parameter values.
},
},
+ "trajectoryAnyOrderMatchInput": { # Instances and metric spec for TrajectoryAnyOrderMatch metric. # Input for trajectory match any order metric.
+ "instances": [ # Required. Repeated TrajectoryAnyOrderMatch instance.
+ { # Spec for TrajectoryAnyOrderMatch instance.
+ "predictedTrajectory": { # Spec for trajectory. # Required. Spec for predicted tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ "referenceTrajectory": { # Spec for trajectory. # Required. Spec for reference tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ },
+ ],
+ "metricSpec": { # Spec for TrajectoryAnyOrderMatch metric - returns 1 if all tool calls in the reference trajectory appear in the predicted trajectory in any order, else 0. # Required. Spec for TrajectoryAnyOrderMatch metric.
+ },
+ },
+ "trajectoryExactMatchInput": { # Instances and metric spec for TrajectoryExactMatch metric. # Input for trajectory exact match metric.
+ "instances": [ # Required. Repeated TrajectoryExactMatch instance.
+ { # Spec for TrajectoryExactMatch instance.
+ "predictedTrajectory": { # Spec for trajectory. # Required. Spec for predicted tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ "referenceTrajectory": { # Spec for trajectory. # Required. Spec for reference tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ },
+ ],
+ "metricSpec": { # Spec for TrajectoryExactMatch metric - returns 1 if tool calls in the reference trajectory exactly match the predicted trajectory, else 0. # Required. Spec for TrajectoryExactMatch metric.
+ },
+ },
+ "trajectoryInOrderMatchInput": { # Instances and metric spec for TrajectoryInOrderMatch metric. # Input for trajectory in order match metric.
+ "instances": [ # Required. Repeated TrajectoryInOrderMatch instance.
+ { # Spec for TrajectoryInOrderMatch instance.
+ "predictedTrajectory": { # Spec for trajectory. # Required. Spec for predicted tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ "referenceTrajectory": { # Spec for trajectory. # Required. Spec for reference tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ },
+ ],
+ "metricSpec": { # Spec for TrajectoryInOrderMatch metric - returns 1 if tool calls in the reference trajectory appear in the predicted trajectory in the same order, else 0. # Required. Spec for TrajectoryInOrderMatch metric.
+ },
+ },
+ "trajectoryPrecisionInput": { # Instances and metric spec for TrajectoryPrecision metric. # Input for trajectory precision metric.
+ "instances": [ # Required. Repeated TrajectoryPrecision instance.
+ { # Spec for TrajectoryPrecision instance.
+ "predictedTrajectory": { # Spec for trajectory. # Required. Spec for predicted tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ "referenceTrajectory": { # Spec for trajectory. # Required. Spec for reference tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ },
+ ],
+ "metricSpec": { # Spec for TrajectoryPrecision metric - returns a float score based on average precision of individual tool calls. # Required. Spec for TrajectoryPrecision metric.
+ },
+ },
+ "trajectoryRecallInput": { # Instances and metric spec for TrajectoryRecall metric. # Input for trajectory recall metric.
+ "instances": [ # Required. Repeated TrajectoryRecall instance.
+ { # Spec for TrajectoryRecall instance.
+ "predictedTrajectory": { # Spec for trajectory. # Required. Spec for predicted tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ "referenceTrajectory": { # Spec for trajectory. # Required. Spec for reference tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ },
+ ],
+ "metricSpec": { # Spec for TrajectoryRecall metric - returns a float score based on average recall of individual tool calls. # Required. Spec for TrajectoryRecall metric.
+ },
+ },
+ "trajectorySingleToolUseInput": { # Instances and metric spec for TrajectorySingleToolUse metric. # Input for trajectory single tool use metric.
+ "instances": [ # Required. Repeated TrajectorySingleToolUse instance.
+ { # Spec for TrajectorySingleToolUse instance.
+ "predictedTrajectory": { # Spec for trajectory. # Required. Spec for predicted tool call trajectory.
+ "toolCalls": [ # Required. Tool calls in the trajectory.
+ { # Spec for tool call.
+ "toolInput": "A String", # Optional. Spec for tool input
+ "toolName": "A String", # Required. Spec for tool name
+ },
+ ],
+ },
+ },
+ ],
+ "metricSpec": { # Spec for TrajectorySingleToolUse metric - returns 1 if tool is present in the predicted trajectory, else 0. # Required. Spec for TrajectorySingleToolUse metric.
+ "toolName": "A String", # Required. Spec for tool name to be checked for in the predicted trajectory.
+ },
+ },
}
x__xgafv: string, V1 error format.
@@ -979,6 +1190,48 @@ Method Details
},
],
},
+ "trajectoryAnyOrderMatchResults": { # Results for TrajectoryAnyOrderMatch metric. # Result for trajectory any order match metric.
+ "trajectoryAnyOrderMatchMetricValues": [ # Output only. TrajectoryAnyOrderMatch metric values.
+ { # TrajectoryAnyOrderMatch metric value for an instance.
+ "score": 3.14, # Output only. TrajectoryAnyOrderMatch score.
+ },
+ ],
+ },
+ "trajectoryExactMatchResults": { # Results for TrajectoryExactMatch metric. # Result for trajectory exact match metric.
+ "trajectoryExactMatchMetricValues": [ # Output only. TrajectoryExactMatch metric values.
+ { # TrajectoryExactMatch metric value for an instance.
+ "score": 3.14, # Output only. TrajectoryExactMatch score.
+ },
+ ],
+ },
+ "trajectoryInOrderMatchResults": { # Results for TrajectoryInOrderMatch metric. # Result for trajectory in order match metric.
+ "trajectoryInOrderMatchMetricValues": [ # Output only. TrajectoryInOrderMatch metric values.
+ { # TrajectoryInOrderMatch metric value for an instance.
+ "score": 3.14, # Output only. TrajectoryInOrderMatch score.
+ },
+ ],
+ },
+ "trajectoryPrecisionResults": { # Results for TrajectoryPrecision metric. # Result for trajectory precision metric.
+ "trajectoryPrecisionMetricValues": [ # Output only. TrajectoryPrecision metric values.
+ { # TrajectoryPrecision metric value for an instance.
+ "score": 3.14, # Output only. TrajectoryPrecision score.
+ },
+ ],
+ },
+ "trajectoryRecallResults": { # Results for TrajectoryRecall metric. # Results for trajectory recall metric.
+ "trajectoryRecallMetricValues": [ # Output only. TrajectoryRecall metric values.
+ { # TrajectoryRecall metric value for an instance.
+ "score": 3.14, # Output only. TrajectoryRecall score.
+ },
+ ],
+ },
+ "trajectorySingleToolUseResults": { # Results for TrajectorySingleToolUse metric. # Results for trajectory single tool use metric.
+ "trajectorySingleToolUseMetricValues": [ # Output only. TrajectorySingleToolUse metric values.
+ { # TrajectorySingleToolUse metric value for an instance.
+ "score": 3.14, # Output only. TrajectorySingleToolUse score.
+ },
+ ],
+ },
}
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.html
index 00ee9077f7e..677d993b502 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.html
@@ -144,7 +144,7 @@ Method Details
"idleShutdownDisabled": True or False, # Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
"idleTimeout": "A String", # Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60.
},
- "isDefault": True or False, # Output only. The default template to use if not specified.
+ "isDefault": True or False, # Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.
"labels": { # The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
@@ -171,7 +171,7 @@ Method Details
"A String",
],
"notebookRuntimeType": "A String", # Optional. Immutable. The type of the notebook runtime template.
- "serviceAccount": "A String", # The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
+ "serviceAccount": "A String", # Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
"shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
"enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
},
@@ -277,7 +277,7 @@ Method Details
"idleShutdownDisabled": True or False, # Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
"idleTimeout": "A String", # Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60.
},
- "isDefault": True or False, # Output only. The default template to use if not specified.
+ "isDefault": True or False, # Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.
"labels": { # The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
@@ -304,7 +304,7 @@ Method Details
"A String",
],
"notebookRuntimeType": "A String", # Optional. Immutable. The type of the notebook runtime template.
- "serviceAccount": "A String", # The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
+ "serviceAccount": "A String", # Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
"shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
"enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
},
@@ -353,7 +353,7 @@ Method Details
Args:
parent: string, Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}` (required)
- filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED`
+ filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`
orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
pageSize: integer, Optional. The standard list page size.
pageToken: string, Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.
@@ -389,7 +389,7 @@ Method Details
"idleShutdownDisabled": True or False, # Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
"idleTimeout": "A String", # Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60.
},
- "isDefault": True or False, # Output only. The default template to use if not specified.
+ "isDefault": True or False, # Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.
"labels": { # The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
@@ -416,7 +416,7 @@ Method Details
"A String",
],
"notebookRuntimeType": "A String", # Optional. Immutable. The type of the notebook runtime template.
- "serviceAccount": "A String", # The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
+ "serviceAccount": "A String", # Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
"shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
"enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
},
@@ -469,7 +469,7 @@ Method Details
"idleShutdownDisabled": True or False, # Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
"idleTimeout": "A String", # Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60.
},
- "isDefault": True or False, # Output only. The default template to use if not specified.
+ "isDefault": True or False, # Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.
"labels": { # The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
@@ -496,7 +496,7 @@ Method Details
"A String",
],
"notebookRuntimeType": "A String", # Optional. Immutable. The type of the notebook runtime template.
- "serviceAccount": "A String", # The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
+ "serviceAccount": "A String", # Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
"shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
"enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
},
@@ -532,7 +532,7 @@ Method Details
"idleShutdownDisabled": True or False, # Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
"idleTimeout": "A String", # Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60.
},
- "isDefault": True or False, # Output only. The default template to use if not specified.
+ "isDefault": True or False, # Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.
"labels": { # The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
"a_key": "A String",
},
@@ -559,7 +559,7 @@ Method Details
"A String",
],
"notebookRuntimeType": "A String", # Optional. Immutable. The type of the notebook runtime template.
- "serviceAccount": "A String", # The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
+ "serviceAccount": "A String", # Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
"shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Optional. Immutable. Runtime Shielded VM spec.
"enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
},
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html
index b1953a576be..083fef73739 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html
@@ -125,11 +125,19 @@ Method Details
{ # Request message for NotebookService.AssignNotebookRuntime.
"notebookRuntime": { # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours. # Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment.
"createTime": "A String", # Output only. Timestamp when this NotebookRuntime was created.
+ "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.
+ "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
+ "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
+ },
"description": "A String", # The description of the NotebookRuntime.
"displayName": "A String", # Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Output only. Customer-managed encryption key spec for the notebook runtime.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
+ "eucConfig": { # The euc configuration of NotebookRuntimeTemplate. # Output only. EUC configuration of the notebook runtime.
+ "bypassActasCheck": True or False, # Output only. Whether ActAs check is bypassed for service account attached to the VM. If false, we need ActAs check for the default Compute Engine Service account. When a Runtime is created, a VM is allocated using Default Compute Engine Service Account. Any user requesting to use this Runtime requires Service Account User (ActAs) permission over this SA. If true, Runtime owner is using EUC and does not require the above permission as VM no longer use default Compute Engine SA, but a P4SA.
+ "eucDisabled": True or False, # Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. In proto3, the default value of a boolean is false. In this way, by default EUC will be enabled for NotebookRuntimeTemplate.
+ },
"expirationTime": "A String", # Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
"healthState": "A String", # Output only. The health state of the NotebookRuntime.
"idleShutdownConfig": { # The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field. # Output only. The idle shutdown configuration of the notebook runtime.
@@ -140,7 +148,25 @@ Method Details
"labels": { # The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.
"a_key": "A String",
},
+ "machineSpec": { # Specification of a single machine. # Output only. The specification of a single machine used by the notebook runtime.
+ "acceleratorCount": 42, # The number of accelerators to attach to the machine.
+ "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
+ "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
+ "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
+ "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
+ "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
+ "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
+ "A String",
+ ],
+ },
+ "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
+ },
"name": "A String", # Output only. The resource name of the NotebookRuntime.
+ "networkSpec": { # Network spec. # Output only. Network spec of the notebook runtime.
+ "enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
+ "network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
+ "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
+ },
"networkTags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
"A String",
],
@@ -153,7 +179,10 @@ Method Details
"runtimeUser": "A String", # Required. The user email of the NotebookRuntime.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
- "serviceAccount": "A String", # Output only. The service account that the NotebookRuntime workload runs as.
+ "serviceAccount": "A String", # Output only. Deprecated: This field is no longer used and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. The service account that the NotebookRuntime workload runs as.
+ "shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Output only. Runtime Shielded VM spec.
+ "enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
+ },
"updateTime": "A String", # Output only. Timestamp when this NotebookRuntime was most recently updated.
"version": "A String", # Output only. The VM os image version of NotebookRuntime.
},
@@ -275,11 +304,19 @@ Method Details
{ # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.
"createTime": "A String", # Output only. Timestamp when this NotebookRuntime was created.
+ "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.
+ "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
+ "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
+ },
"description": "A String", # The description of the NotebookRuntime.
"displayName": "A String", # Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Output only. Customer-managed encryption key spec for the notebook runtime.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
+ "eucConfig": { # The euc configuration of NotebookRuntimeTemplate. # Output only. EUC configuration of the notebook runtime.
+ "bypassActasCheck": True or False, # Output only. Whether ActAs check is bypassed for service account attached to the VM. If false, we need ActAs check for the default Compute Engine Service account. When a Runtime is created, a VM is allocated using Default Compute Engine Service Account. Any user requesting to use this Runtime requires Service Account User (ActAs) permission over this SA. If true, Runtime owner is using EUC and does not require the above permission as VM no longer use default Compute Engine SA, but a P4SA.
+ "eucDisabled": True or False, # Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. In proto3, the default value of a boolean is false. In this way, by default EUC will be enabled for NotebookRuntimeTemplate.
+ },
"expirationTime": "A String", # Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
"healthState": "A String", # Output only. The health state of the NotebookRuntime.
"idleShutdownConfig": { # The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field. # Output only. The idle shutdown configuration of the notebook runtime.
@@ -290,7 +327,25 @@ Method Details
"labels": { # The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.
"a_key": "A String",
},
+ "machineSpec": { # Specification of a single machine. # Output only. The specification of a single machine used by the notebook runtime.
+ "acceleratorCount": 42, # The number of accelerators to attach to the machine.
+ "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
+ "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
+ "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
+ "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
+ "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
+ "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
+ "A String",
+ ],
+ },
+ "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
+ },
"name": "A String", # Output only. The resource name of the NotebookRuntime.
+ "networkSpec": { # Network spec. # Output only. Network spec of the notebook runtime.
+ "enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
+ "network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
+ "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
+ },
"networkTags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
"A String",
],
@@ -303,7 +358,10 @@ Method Details
"runtimeUser": "A String", # Required. The user email of the NotebookRuntime.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
- "serviceAccount": "A String", # Output only. The service account that the NotebookRuntime workload runs as.
+ "serviceAccount": "A String", # Output only. Deprecated: This field is no longer used and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. The service account that the NotebookRuntime workload runs as.
+ "shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Output only. Runtime Shielded VM spec.
+ "enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
+ },
"updateTime": "A String", # Output only. Timestamp when this NotebookRuntime was most recently updated.
"version": "A String", # Output only. The VM os image version of NotebookRuntime.
}
@@ -315,7 +373,7 @@ Method Details
Args:
parent: string, Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}` (required)
- filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED`
+ filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`
orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
pageSize: integer, Optional. The standard list page size.
pageToken: string, Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.
@@ -333,11 +391,19 @@ Method Details
"notebookRuntimes": [ # List of NotebookRuntimes in the requested page.
{ # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.
"createTime": "A String", # Output only. Timestamp when this NotebookRuntime was created.
+ "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.
+ "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
+ "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
+ },
"description": "A String", # The description of the NotebookRuntime.
"displayName": "A String", # Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Output only. Customer-managed encryption key spec for the notebook runtime.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
+ "eucConfig": { # The euc configuration of NotebookRuntimeTemplate. # Output only. EUC configuration of the notebook runtime.
+ "bypassActasCheck": True or False, # Output only. Whether ActAs check is bypassed for service account attached to the VM. If false, we need ActAs check for the default Compute Engine Service account. When a Runtime is created, a VM is allocated using Default Compute Engine Service Account. Any user requesting to use this Runtime requires Service Account User (ActAs) permission over this SA. If true, Runtime owner is using EUC and does not require the above permission as VM no longer use default Compute Engine SA, but a P4SA.
+ "eucDisabled": True or False, # Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. In proto3, the default value of a boolean is false. In this way, by default EUC will be enabled for NotebookRuntimeTemplate.
+ },
"expirationTime": "A String", # Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
"healthState": "A String", # Output only. The health state of the NotebookRuntime.
"idleShutdownConfig": { # The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field. # Output only. The idle shutdown configuration of the notebook runtime.
@@ -348,7 +414,25 @@ Method Details
"labels": { # The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.
"a_key": "A String",
},
+ "machineSpec": { # Specification of a single machine. # Output only. The specification of a single machine used by the notebook runtime.
+ "acceleratorCount": 42, # The number of accelerators to attach to the machine.
+ "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
+ "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
+ "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
+ "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
+ "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
+ "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
+ "A String",
+ ],
+ },
+ "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
+ },
"name": "A String", # Output only. The resource name of the NotebookRuntime.
+ "networkSpec": { # Network spec. # Output only. Network spec of the notebook runtime.
+ "enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
+ "network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
+ "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
+ },
"networkTags": [ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
"A String",
],
@@ -361,7 +445,10 @@ Method Details
"runtimeUser": "A String", # Required. The user email of the NotebookRuntime.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
- "serviceAccount": "A String", # Output only. The service account that the NotebookRuntime workload runs as.
+ "serviceAccount": "A String", # Output only. Deprecated: This field is no longer used and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. The service account that the NotebookRuntime workload runs as.
+ "shieldedVmConfig": { # A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). # Output only. Runtime Shielded VM spec.
+ "enableSecureBoot": True or False, # Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
+ },
"updateTime": "A String", # Output only. Timestamp when this NotebookRuntime was most recently updated.
"version": "A String", # Output only. The VM os image version of NotebookRuntime.
},
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html
index ab8ca02b1a8..d4cae7c8f0e 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html
@@ -470,8 +470,8 @@ Method Details
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
- "defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview.
- "persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
+ "defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not set, Standard Vertex Custom Job(https://cloud.google.com/vertex-ai/docs/training/overview) is used as the runtime. If set, all pipeline tasks will run on the default runtime unless a task is a GCPC custom job component (https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component) based task. If the task is based on a GCPC custom job component, it runs solely according to the component's configuration.
+ "persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information about persistent resource, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
@@ -754,8 +754,8 @@ Method Details
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
- "defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview.
- "persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
+ "defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not set, Standard Vertex Custom Job(https://cloud.google.com/vertex-ai/docs/training/overview) is used as the runtime. If set, all pipeline tasks will run on the default runtime unless a task is a GCPC custom job component (https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component) based task. If the task is based on a GCPC custom job component, it runs solely according to the component's configuration.
+ "persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information about persistent resource, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
@@ -1079,8 +1079,8 @@ Method Details
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
- "defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview.
- "persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
+ "defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not set, Standard Vertex Custom Job(https://cloud.google.com/vertex-ai/docs/training/overview) is used as the runtime. If set, all pipeline tasks will run on the default runtime unless a task is a GCPC custom job component (https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component) based task. If the task is based on a GCPC custom job component, it runs solely according to the component's configuration.
+ "persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information about persistent resource, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
@@ -1377,8 +1377,8 @@ Method Details
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
- "defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview.
- "persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
+ "defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not set, Standard Vertex Custom Job(https://cloud.google.com/vertex-ai/docs/training/overview) is used as the runtime. If set, all pipeline tasks will run on the default runtime unless a task is a GCPC custom job component (https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component) based task. If the task is based on a GCPC custom job component, it runs solely according to the component's configuration.
+ "persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information about persistent resource, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
index 48eff828743..341b6c94c74 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
@@ -258,6 +258,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -301,10 +304,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -430,6 +441,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -598,6 +611,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -641,10 +657,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -784,6 +808,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
@@ -1411,6 +1437,9 @@ Method Details
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+ "responseModalities": [ # Optional. The modalities of the response.
+ "A String",
+ ],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -1454,10 +1483,18 @@ Method Details
},
},
"seed": 42, # Optional. Seed.
+ "speechConfig": { # The speech generation config. # Optional. The speech generation config.
+ "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
+ "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
+ "voiceName": "A String", # The name of the preset voice to use.
+ },
+ },
+ },
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
+ "tokenResolution": "A String", # Optional. If specified, the token resolution specified will be used.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
@@ -1597,6 +1634,8 @@ Method Details
},
},
],
+ "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+ },
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html
index 522a500ef9b..8a9b2b61ed1 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html
@@ -103,6 +103,9 @@ Instance Methods
query(name, body=None, x__xgafv=None)
Queries using a reasoning engine.
+
+ streamQuery(name, body=None, x__xgafv=None)
+Streams queries using a reasoning engine.
Method Details
close()
@@ -390,4 +393,39 @@
Method Details
}
+
+
streamQuery(name, body=None, x__xgafv=None)
+
Streams queries using a reasoning engine.
+
+Args:
+ name: string, Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ReasoningEngineExecutionService.StreamQuery.
+ "classMethod": "A String", # Optional. Class method to be used for the stream query. It is optional and defaults to "stream_query" if unspecified.
+ "input": { # Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
+ "a_key": "", # Properties of the object.
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+