From 86cb1335984094dad37bbf5e2148ef9b44dee5d9 Mon Sep 17 00:00:00 2001
From: yoshi-code-bot <70984784+yoshi-code-bot@users.noreply.github.com>
Date: Tue, 21 Oct 2025 00:38:24 -0700
Subject: [PATCH 1/2] chore: Update discovery artifacts (#2678)
## Deleted keys were detected in the following stable discovery artifacts:
discoveryengine v1 https://togithub.com/googleapis/google-api-python-client/commit/4ef572d0b1cd330069093d2ed01bb3255eb2e91c
networkconnectivity v1 https://togithub.com/googleapis/google-api-python-client/commit/0382bddf3ef4ada932471257406aa5657d1ee7bc
## Deleted keys were detected in the following pre-stable discovery artifacts:
discoveryengine v1alpha https://togithub.com/googleapis/google-api-python-client/commit/4ef572d0b1cd330069093d2ed01bb3255eb2e91c
discoveryengine v1beta https://togithub.com/googleapis/google-api-python-client/commit/4ef572d0b1cd330069093d2ed01bb3255eb2e91c
## Discovery Artifact Change Summary:
feat(aiplatform): update the api https://togithub.com/googleapis/google-api-python-client/commit/aa200df296b38f1ae0bae429043f9e89a892820f
feat(alloydb): update the api https://togithub.com/googleapis/google-api-python-client/commit/a3710208f69ad6c24b72565a065ab0d40676acb7
feat(androidmanagement): update the api https://togithub.com/googleapis/google-api-python-client/commit/4089690d82b5e4f0ea15daf59383dbb8865cda21
feat(bigqueryreservation): update the api https://togithub.com/googleapis/google-api-python-client/commit/b02e40481808a67509aca1ab068d234246739a0c
feat(bigtableadmin): update the api https://togithub.com/googleapis/google-api-python-client/commit/cf3137300922d49739fcf04428ef4cec524a5c72
feat(chromemanagement): update the api https://togithub.com/googleapis/google-api-python-client/commit/10f60fac6070c294debc82dfbfe43c14792581a4
feat(compute): update the api https://togithub.com/googleapis/google-api-python-client/commit/165dd10c023051c0b2940bb4a2729eda8f5f5ac8
feat(container): update the api https://togithub.com/googleapis/google-api-python-client/commit/f150c46382d36eac325d25c2cff64fa5c3c8713b
feat(dataplex): update the api https://togithub.com/googleapis/google-api-python-client/commit/58c5a2f8bb1f9c549ae7b31d35bc55ce78997634
feat(dataproc): update the api https://togithub.com/googleapis/google-api-python-client/commit/afef7f8f48e4487e9e32998718b4187951b454e2
fix(datastore): update the api https://togithub.com/googleapis/google-api-python-client/commit/c31137da3f86180871322fa4210d0713841df1a8
feat(dfareporting): update the api https://togithub.com/googleapis/google-api-python-client/commit/9a30f60645a55a2a54158312e43fcc4ccbac7d41
feat(dialogflow): update the api https://togithub.com/googleapis/google-api-python-client/commit/79bff2cc113b98ac99acfdce1e2177d657286695
feat(discoveryengine): update the api https://togithub.com/googleapis/google-api-python-client/commit/4ef572d0b1cd330069093d2ed01bb3255eb2e91c
feat(docs): update the api https://togithub.com/googleapis/google-api-python-client/commit/ba9ea7d59faa6600a42a59dcc42f0240413a9235
feat(firebaseappdistribution): update the api https://togithub.com/googleapis/google-api-python-client/commit/6e2819320176d99be289241627a91b38add960ba
feat(firebaseml): update the api https://togithub.com/googleapis/google-api-python-client/commit/ad4cb43ed8d9a57ebf50db956b91fec535594f52
fix(firestore): update the api https://togithub.com/googleapis/google-api-python-client/commit/85edf19ba1ae6a851b116bb7c7156cd1ebd83f11
feat(iam): update the api https://togithub.com/googleapis/google-api-python-client/commit/cbfdcaca9d804f275370cc7bbb29f2458fd7694b
feat(managedkafka): update the api https://togithub.com/googleapis/google-api-python-client/commit/ec4f7a422d9dee6210fc42b3feb8d5b11f5922a1
feat(networkconnectivity): update the api https://togithub.com/googleapis/google-api-python-client/commit/0382bddf3ef4ada932471257406aa5657d1ee7bc
feat(notebooks): update the api https://togithub.com/googleapis/google-api-python-client/commit/b0fdfae7fa17341f77b4fe7cc03821c3657d498d
feat(oracledatabase): update the api https://togithub.com/googleapis/google-api-python-client/commit/aba722928bdca980eae2d3f6d8efc74dafc81898
feat(paymentsresellersubscription): update the api https://togithub.com/googleapis/google-api-python-client/commit/1ad68fcb6d53108d8f40c62e584c8a8a7f980b27
feat(recommendationengine): update the api https://togithub.com/googleapis/google-api-python-client/commit/733525aebb064ce99040e004044f09e0e5cdb01d
feat(redis): update the api https://togithub.com/googleapis/google-api-python-client/commit/536f17cf1f853c2bcf9bde4318ef5dc565857ae4
feat(storagebatchoperations): update the api https://togithub.com/googleapis/google-api-python-client/commit/09293519aebccf0631e83479fc43fb358332f4be
feat(texttospeech): update the api https://togithub.com/googleapis/google-api-python-client/commit/cde9af05a1dc897bad123b98f337c38e41f716de
feat(vault): update the api https://togithub.com/googleapis/google-api-python-client/commit/03df181749f4e8ec4716e11b817045c2c933f30e
---
docs/dyn/aiplatform_v1.endpoints.html | 51 +
..._v1.projects.locations.cachedContents.html | 12 +
...jects.locations.customJobs.operations.html | 8 +-
...locations.dataLabelingJobs.operations.html | 8 +-
...s.datasets.annotationSpecs.operations.html | 8 +-
...sets.dataItems.annotations.operations.html | 8 +-
...cations.datasets.dataItems.operations.html | 8 +-
...rojects.locations.datasets.operations.html | 8 +-
...ions.datasets.savedQueries.operations.html | 8 +-
...ns.deploymentResourcePools.operations.html | 8 +-
...tform_v1.projects.locations.endpoints.html | 51 +
...ojects.locations.endpoints.operations.html | 8 +-
..._v1.projects.locations.evaluationRuns.html | 428 +-
...ons.featureGroups.features.operations.html | 8 +-
...ts.locations.featureGroups.operations.html | 8 +-
...ions.featureOnlineStores.featureViews.html | 41 +
...eOnlineStores.featureViews.operations.html | 8 +-
...rojects.locations.featureOnlineStores.html | 24 +
...ations.featureOnlineStores.operations.html | 8 +-
...tores.entityTypes.features.operations.html | 8 +-
....featurestores.entityTypes.operations.html | 8 +-
...ts.locations.featurestores.operations.html | 8 +-
.../dyn/aiplatform_v1.projects.locations.html | 108 +
...s.hyperparameterTuningJobs.operations.html | 8 +-
..._v1.projects.locations.indexEndpoints.html | 14 +-
...s.locations.indexEndpoints.operations.html | 8 +-
...projects.locations.indexes.operations.html | 8 +-
...s.metadataStores.artifacts.operations.html | 8 +-
...ns.metadataStores.contexts.operations.html | 8 +-
....metadataStores.executions.operations.html | 8 +-
...s.locations.metadataStores.operations.html | 8 +-
...ations.migratableResources.operations.html | 8 +-
...elDeploymentMonitoringJobs.operations.html | 8 +-
...cations.models.evaluations.operations.html | 8 +-
....projects.locations.models.operations.html | 8 +-
...ions.notebookExecutionJobs.operations.html | 8 +-
...s.notebookRuntimeTemplates.operations.html | 8 +-
...locations.notebookRuntimes.operations.html | 8 +-
...form_v1.projects.locations.operations.html | 8 +-
...ations.persistentResources.operations.html | 8 +-
...cts.locations.pipelineJobs.operations.html | 8 +-
....projects.locations.publishers.models.html | 51 +
...jects.locations.ragCorpora.operations.html | 8 +-
...ations.ragCorpora.ragFiles.operations.html | 8 +-
....locations.ragEngineConfig.operations.html | 8 +-
...locations.reasoningEngines.operations.html | 8 +-
...ojects.locations.schedules.operations.html | 8 +-
....locations.specialistPools.operations.html | 8 +-
...projects.locations.studies.operations.html | 8 +-
...s.locations.studies.trials.operations.html | 8 +-
...s.tensorboards.experiments.operations.html | 8 +-
...sorboards.experiments.runs.operations.html | 8 +-
...xperiments.runs.timeSeries.operations.html | 8 +-
...cts.locations.tensorboards.operations.html | 8 +-
...ocations.trainingPipelines.operations.html | 8 +-
...form_v1.projects.locations.tuningJobs.html | 45 +-
...jects.locations.tuningJobs.operations.html | 8 +-
docs/dyn/aiplatform_v1.publishers.models.html | 51 +
docs/dyn/aiplatform_v1beta1.endpoints.html | 51 +
....projects.locations.agents.operations.html | 8 +-
...a1.projects.locations.apps.operations.html | 8 +-
...ta1.projects.locations.cachedContents.html | 12 +
...jects.locations.customJobs.operations.html | 8 +-
...locations.dataLabelingJobs.operations.html | 8 +-
...s.datasets.annotationSpecs.operations.html | 8 +-
...sets.dataItems.annotations.operations.html | 8 +-
...cations.datasets.dataItems.operations.html | 8 +-
...m_v1beta1.projects.locations.datasets.html | 34 +
...rojects.locations.datasets.operations.html | 8 +-
...ions.datasets.savedQueries.operations.html | 8 +-
...cts.locations.deploymentResourcePools.html | 25 +
...ns.deploymentResourcePools.operations.html | 8 +-
...ects.locations.edgeDevices.operations.html | 8 +-
..._v1beta1.projects.locations.endpoints.html | 91 +
...ojects.locations.endpoints.operations.html | 8 +-
....locations.evaluationItems.operations.html | 8 +-
...ta1.projects.locations.evaluationRuns.html | 428 +-
...s.locations.evaluationRuns.operations.html | 8 +-
...s.locations.evaluationSets.operations.html | 8 +-
....locations.evaluationTasks.operations.html | 8 +-
...ts.locations.exampleStores.operations.html | 8 +-
...tions.extensionControllers.operations.html | 8 +-
...jects.locations.extensions.operations.html | 8 +-
...tureGroups.featureMonitors.operations.html | 8 +-
...ons.featureGroups.features.operations.html | 8 +-
...ts.locations.featureGroups.operations.html | 8 +-
...ions.featureOnlineStores.featureViews.html | 41 +
...eOnlineStores.featureViews.operations.html | 8 +-
...rojects.locations.featureOnlineStores.html | 24 +
...ations.featureOnlineStores.operations.html | 8 +-
...tores.entityTypes.features.operations.html | 8 +-
....featurestores.entityTypes.operations.html | 8 +-
...ts.locations.featurestores.operations.html | 8 +-
...aiplatform_v1beta1.projects.locations.html | 118 +
...s.hyperparameterTuningJobs.operations.html | 8 +-
...ta1.projects.locations.indexEndpoints.html | 49 +-
...s.locations.indexEndpoints.operations.html | 8 +-
...projects.locations.indexes.operations.html | 8 +-
...s.metadataStores.artifacts.operations.html | 8 +-
...ns.metadataStores.contexts.operations.html | 8 +-
....metadataStores.executions.operations.html | 8 +-
...s.locations.metadataStores.operations.html | 8 +-
...ations.migratableResources.operations.html | 8 +-
...elDeploymentMonitoringJobs.operations.html | 8 +-
...ts.locations.modelMonitors.operations.html | 8 +-
...cations.models.evaluations.operations.html | 8 +-
....projects.locations.models.operations.html | 8 +-
...ions.notebookExecutionJobs.operations.html | 8 +-
...s.notebookRuntimeTemplates.operations.html | 8 +-
...locations.notebookRuntimes.operations.html | 8 +-
...v1beta1.projects.locations.operations.html | 8 +-
...ations.persistentResources.operations.html | 8 +-
...cts.locations.pipelineJobs.operations.html | 8 +-
....projects.locations.publishers.models.html | 51 +
...jects.locations.ragCorpora.operations.html | 8 +-
...ations.ragCorpora.ragFiles.operations.html | 8 +-
....locations.ragEngineConfig.operations.html | 8 +-
....reasoningEngines.memories.operations.html | 8 +-
...locations.reasoningEngines.operations.html | 8 +-
....reasoningEngines.sandboxEnvironments.html | 21 +
...ngines.sandboxEnvironments.operations.html | 8 +-
....reasoningEngines.sessions.operations.html | 8 +-
...ojects.locations.schedules.operations.html | 8 +-
...projects.locations.solvers.operations.html | 8 +-
....locations.specialistPools.operations.html | 8 +-
...projects.locations.studies.operations.html | 8 +-
...s.locations.studies.trials.operations.html | 8 +-
...s.tensorboards.experiments.operations.html | 8 +-
...sorboards.experiments.runs.operations.html | 8 +-
...xperiments.runs.timeSeries.operations.html | 8 +-
...cts.locations.tensorboards.operations.html | 8 +-
...ocations.trainingPipelines.operations.html | 8 +-
...v1beta1.projects.locations.tuningJobs.html | 525 +-
.../aiplatform_v1beta1.publishers.models.html | 71 +
...b_v1alpha.projects.locations.clusters.html | 7 +
...db_v1beta.projects.locations.clusters.html | 7 +
...roidmanagement_v1.enterprises.devices.html | 60 +
...oidmanagement_v1.enterprises.policies.html | 96 +-
...remetalsolution_v2.projects.locations.html | 2 +-
docs/dyn/bigquerydatapolicy_v2.html | 111 +
docs/dyn/bigquerydatapolicy_v2.projects.html | 91 +
...cy_v2.projects.locations.dataPolicies.html | 577 ++
...querydatapolicy_v2.projects.locations.html | 91 +
...ueryreservation_v1.projects.locations.html | 8 +
...ts.locations.reservations.assignments.html | 24 +
...on_v1.projects.locations.reservations.html | 28 +
...ojects.instances.tables.schemaBundles.html | 180 +
docs/dyn/chat_v1.spaces.messages.html | 112 +-
docs/dyn/chat_v1.spaces.spaceEvents.html | 168 +-
...gement_v1.customers.telemetry.devices.html | 12 +
...agement_v1.customers.telemetry.events.html | 12 +
...erceprocurement_v1.providers.accounts.html | 2 +-
docs/dyn/compute_beta.reservationBlocks.html | 1290 +++++
.../compute_beta.reservationSubBlocks.html | 1290 +++++
docs/dyn/compute_v1.reservationBlocks.html | 1290 +++++
docs/dyn/compute_v1.reservationSubBlocks.html | 1290 +++++
...tainer_v1.projects.locations.clusters.html | 58 +-
...projects.locations.clusters.nodePools.html | 20 +-
.../container_v1.projects.zones.clusters.html | 58 +-
..._v1.projects.zones.clusters.nodePools.html | 20 +-
...r_v1beta1.projects.locations.clusters.html | 79 +-
...projects.locations.clusters.nodePools.html | 20 +-
...ainer_v1beta1.projects.zones.clusters.html | 79 +-
...ta1.projects.zones.clusters.nodePools.html | 20 +-
docs/dyn/dataform_v1.html | 111 +
docs/dyn/dataform_v1.projects.html | 91 +
...ataform_v1.projects.locations.folders.html | 218 +
docs/dyn/dataform_v1.projects.locations.html | 250 +
...form_v1.projects.locations.operations.html | 239 +
...tions.repositories.compilationResults.html | 603 ++
...rm_v1.projects.locations.repositories.html | 782 +++
...locations.repositories.releaseConfigs.html | 466 ++
...ocations.repositories.workflowConfigs.html | 472 ++
...ions.repositories.workflowInvocations.html | 450 ++
...cts.locations.repositories.workspaces.html | 884 +++
...orm_v1.projects.locations.teamFolders.html | 218 +
...lex_v1.projects.locations.aspectTypes.html | 4 +
...rojects.locations.entryGroups.entries.html | 2 +-
docs/dyn/dataplex_v1.projects.locations.html | 2 +-
...ataproc_v1.projects.locations.batches.html | 12 +-
...proc_v1.projects.locations.operations.html | 8 +-
...taproc_v1.projects.locations.sessions.html | 12 +-
....projects.locations.workflowTemplates.html | 14 +-
...dataproc_v1.projects.regions.clusters.html | 8 +-
.../dataproc_v1.projects.regions.jobs.html | 16 +
...taproc_v1.projects.regions.operations.html | 8 +-
...v1.projects.regions.workflowTemplates.html | 14 +-
docs/dyn/dfareporting_v4.dynamicFeeds.html | 322 +-
docs/dyn/dfareporting_v4.dynamicProfiles.html | 38 +
docs/dyn/dfareporting_v4.html | 10 +
.../dfareporting_v4.studioCreativeAssets.html | 138 +
docs/dyn/dfareporting_v4.studioCreatives.html | 215 +
docs/dyn/dfareporting_v5.dynamicFeeds.html | 322 +-
docs/dyn/dfareporting_v5.dynamicProfiles.html | 38 +
docs/dyn/dfareporting_v5.html | 10 +
.../dfareporting_v5.studioCreativeAssets.html | 138 +
docs/dyn/dfareporting_v5.studioCreatives.html | 215 +
...ojects.locations.agents.conversations.html | 10 +
...ocations.agents.environments.sessions.html | 20 +
....projects.locations.agents.generators.html | 30 +
...low_v3beta1.projects.locations.agents.html | 15 +
...1.projects.locations.agents.playbooks.html | 30 +
...s.locations.agents.playbooks.versions.html | 25 +
...a1.projects.locations.agents.sessions.html | 20 +
...collections.dataStores.servingConfigs.html | 38 +
...tions.collections.dataStores.sessions.html | 114 +
...ations.collections.engines.assistants.html | 18 +-
...ns.collections.engines.servingConfigs.html | 38 +
...ocations.collections.engines.sessions.html | 114 +
...s.locations.dataStores.servingConfigs.html | 38 +
...rojects.locations.dataStores.sessions.html | 114 +
..._v1.projects.locations.licenseConfigs.html | 95 +-
...collections.dataStores.servingConfigs.html | 38 +
...tions.collections.dataStores.sessions.html | 114 +
...ations.collections.engines.assistants.html | 18 +-
...ns.collections.engines.servingConfigs.html | 38 +
...ocations.collections.engines.sessions.html | 114 +
...s.locations.dataStores.servingConfigs.html | 38 +
...rojects.locations.dataStores.sessions.html | 114 +
...veryengine_v1alpha.projects.locations.html | 54 +
...pha.projects.locations.licenseConfigs.html | 5 +
...collections.dataStores.servingConfigs.html | 38 +
...tions.collections.dataStores.sessions.html | 114 +
...ations.collections.engines.assistants.html | 18 +-
...ns.collections.engines.servingConfigs.html | 38 +
...ocations.collections.engines.sessions.html | 114 +
...s.locations.dataStores.servingConfigs.html | 38 +
...rojects.locations.dataStores.sessions.html | 114 +
...eta.projects.locations.licenseConfigs.html | 95 +-
...izations.locations.columnDataProfiles.html | 2 +-
...2.organizations.locations.connections.html | 4 +-
...lp_v2.organizations.locations.dlpJobs.html | 2 +-
...tions.locations.fileStoreDataProfiles.html | 2 +-
...2.organizations.locations.jobTriggers.html | 2 +-
...zations.locations.projectDataProfiles.html | 2 +-
...nizations.locations.tableDataProfiles.html | 2 +-
docs/dyn/dlp_v2.projects.dlpJobs.html | 2 +-
docs/dyn/dlp_v2.projects.jobTriggers.html | 2 +-
...projects.locations.columnDataProfiles.html | 2 +-
...dlp_v2.projects.locations.connections.html | 4 +-
.../dlp_v2.projects.locations.dlpJobs.html | 2 +-
...jects.locations.fileStoreDataProfiles.html | 2 +-
...dlp_v2.projects.locations.jobTriggers.html | 2 +-
...rojects.locations.projectDataProfiles.html | 2 +-
....projects.locations.tableDataProfiles.html | 2 +-
docs/dyn/docs_v1.documents.html | 42 +
...ntai_v1.projects.locations.processors.html | 8 +-
...ocations.processors.humanReviewConfig.html | 4 +-
...ocations.processors.processorVersions.html | 8 +-
...projects.locations.processors.dataset.html | 4 +-
...v1beta3.projects.locations.processors.html | 12 +-
...ocations.processors.humanReviewConfig.html | 8 +-
...ocations.processors.processorVersions.html | 12 +-
docs/dyn/drive_v3.changes.html | 24 +-
docs/dyn/drive_v3.files.html | 192 +-
docs/dyn/drive_v3.permissions.html | 186 +-
...ution_v1alpha.projects.apps.testCases.html | 82 +-
....projects.locations.publishers.models.html | 15 +
...v1.locations.workforcePools.providers.html | 4 +
docs/dyn/iap_v1.v1.html | 6 +-
docs/dyn/index.md | 2 +
docs/dyn/jobs_v3.projects.companies.html | 12 +-
docs/dyn/jobs_v3.projects.jobs.html | 24 +-
.../jobs_v3p1beta1.projects.companies.html | 12 +-
docs/dyn/jobs_v3p1beta1.projects.jobs.html | 24 +-
.../jobs_v4.projects.tenants.companies.html | 12 +-
docs/dyn/jobs_v4.projects.tenants.jobs.html | 28 +-
....locations.connectClusters.connectors.html | 18 +-
...afka_v1.projects.locations.operations.html | 8 +-
...orkconnectivity_v1.projects.locations.html | 10 -
...jects.locations.serviceConnectionMaps.html | 72 +
...s.locations.serviceConnectionPolicies.html | 2 +-
docs/dyn/notebooks_v1.projects.locations.html | 2 +-
...ooks_v1.projects.locations.operations.html | 8 +-
docs/dyn/notebooks_v2.projects.locations.html | 2 +-
...books_v2.projects.locations.instances.html | 25 +-
...ooks_v2.projects.locations.operations.html | 8 +-
...abase_v1.projects.locations.databases.html | 2 +-
...locations.dbSystemInitialStorageSizes.html | 2 +-
...base_v1.projects.locations.dbVersions.html | 2 +-
...cts.locations.exadbVmClusters.dbNodes.html | 143 +
...v1.projects.locations.exadbVmClusters.html | 5 +
...ubscription_v1.partners.subscriptions.html | 22 +-
...n_v1.partners.subscriptions.lineItems.html | 260 +
...chaenterprise_v1.projects.assessments.html | 4 +-
.../recaptchaenterprise_v1.projects.keys.html | 42 +-
...tions.catalogs.eventStores.operations.html | 8 +-
...rojects.locations.catalogs.operations.html | 8 +-
...edis_v1.projects.locations.operations.html | 8 +-
...v1beta1.projects.locations.operations.html | 8 +-
...operations_v1.projects.locations.jobs.html | 12 +
docs/dyn/texttospeech_v1.text.html | 1 +
docs/dyn/texttospeech_v1beta1.text.html | 1 +
docs/dyn/vault_v1.operations.html | 8 +-
.../documents/accessapproval.v1.json | 6 +-
.../documents/aiplatform.v1.json | 501 +-
.../documents/aiplatform.v1beta1.json | 638 ++-
.../discovery_cache/documents/alloydb.v1.json | 26 +-
.../documents/alloydb.v1alpha.json | 40 +-
.../documents/alloydb.v1beta.json | 40 +-
.../documents/androidmanagement.v1.json | 208 +-
.../documents/baremetalsolution.v2.json | 4 +-
.../documents/bigquerydatapolicy.v2.json | 802 +++
.../documents/bigqueryreservation.v1.json | 27 +-
.../documents/bigtableadmin.v2.json | 98 +-
.../discovery_cache/documents/chat.v1.json | 8 +-
.../documents/chromemanagement.v1.json | 80 +-
.../documents/chromewebstore.v1.1.json | 4 +-
.../cloudcommerceprocurement.v1.json | 4 +-
.../documents/compute.beta.json | 352 +-
.../discovery_cache/documents/compute.v1.json | 352 +-
.../documents/contactcenterinsights.v1.json | 14 +-
.../documents/container.v1.json | 19 +-
.../documents/container.v1beta1.json | 54 +-
.../documents/dataform.v1.json | 4918 +++++++++++++++++
.../documents/dataplex.v1.json | 28 +-
.../documents/dataproc.v1.json | 35 +-
.../documents/datastore.v1.json | 12 +-
.../documents/datastore.v1beta1.json | 12 +-
.../documents/datastore.v1beta3.json | 12 +-
.../documents/dfareporting.v4.json | 473 +-
.../documents/dfareporting.v5.json | 481 +-
.../documents/dialogflow.v2.json | 2 +-
.../documents/dialogflow.v2beta1.json | 2 +-
.../documents/dialogflow.v3beta1.json | 50 +-
.../documents/discoveryengine.v1.json | 1053 ++--
.../documents/discoveryengine.v1alpha.json | 1386 +++--
.../documents/discoveryengine.v1beta.json | 1119 ++--
.../discovery_cache/documents/dlp.v2.json | 38 +-
.../discovery_cache/documents/docs.v1.json | 31 +-
.../documents/documentai.v1.json | 3 +-
.../documents/documentai.v1beta3.json | 3 +-
.../discovery_cache/documents/drive.v3.json | 58 +-
.../firebaseappdistribution.v1alpha.json | 79 +-
.../documents/firebaseml.v2beta.json | 38 +-
.../documents/firestore.v1.json | 12 +-
.../documents/firestore.v1beta1.json | 12 +-
.../documents/firestore.v1beta2.json | 12 +-
.../discovery_cache/documents/iam.v1.json | 16 +-
.../discovery_cache/documents/iap.v1.json | 4 +-
.../discovery_cache/documents/jobs.v3.json | 4 +-
.../documents/jobs.v3p1beta1.json | 4 +-
.../discovery_cache/documents/jobs.v4.json | 4 +-
.../documents/kmsinventory.v1.json | 10 +-
.../documents/managedkafka.v1.json | 20 +-
.../documents/networkconnectivity.v1.json | 644 +--
.../documents/networkmanagement.v1.json | 10 +-
.../documents/networkmanagement.v1beta1.json | 10 +-
.../documents/notebooks.v1.json | 16 +-
.../documents/notebooks.v2.json | 27 +-
.../documents/oracledatabase.v1.json | 50 +-
.../paymentsresellersubscription.v1.json | 83 +-
.../documents/recaptchaenterprise.v1.json | 10 +-
.../recommendationengine.v1beta1.json | 19 +-
.../discovery_cache/documents/redis.v1.json | 49 +-
.../documents/redis.v1beta1.json | 49 +-
.../documents/storagebatchoperations.v1.json | 31 +-
.../documents/texttospeech.v1.json | 6 +-
.../documents/texttospeech.v1beta1.json | 6 +-
.../discovery_cache/documents/vault.v1.json | 14 +-
360 files changed, 31092 insertions(+), 3130 deletions(-)
create mode 100644 docs/dyn/bigquerydatapolicy_v2.html
create mode 100644 docs/dyn/bigquerydatapolicy_v2.projects.html
create mode 100644 docs/dyn/bigquerydatapolicy_v2.projects.locations.dataPolicies.html
create mode 100644 docs/dyn/bigquerydatapolicy_v2.projects.locations.html
create mode 100644 docs/dyn/dataform_v1.html
create mode 100644 docs/dyn/dataform_v1.projects.html
create mode 100644 docs/dyn/dataform_v1.projects.locations.folders.html
create mode 100644 docs/dyn/dataform_v1.projects.locations.html
create mode 100644 docs/dyn/dataform_v1.projects.locations.operations.html
create mode 100644 docs/dyn/dataform_v1.projects.locations.repositories.compilationResults.html
create mode 100644 docs/dyn/dataform_v1.projects.locations.repositories.html
create mode 100644 docs/dyn/dataform_v1.projects.locations.repositories.releaseConfigs.html
create mode 100644 docs/dyn/dataform_v1.projects.locations.repositories.workflowConfigs.html
create mode 100644 docs/dyn/dataform_v1.projects.locations.repositories.workflowInvocations.html
create mode 100644 docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html
create mode 100644 docs/dyn/dataform_v1.projects.locations.teamFolders.html
create mode 100644 docs/dyn/dfareporting_v4.studioCreativeAssets.html
create mode 100644 docs/dyn/dfareporting_v4.studioCreatives.html
create mode 100644 docs/dyn/dfareporting_v5.studioCreativeAssets.html
create mode 100644 docs/dyn/dfareporting_v5.studioCreatives.html
create mode 100644 docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.dbNodes.html
create mode 100644 docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.lineItems.html
create mode 100644 googleapiclient/discovery_cache/documents/bigquerydatapolicy.v2.json
create mode 100644 googleapiclient/discovery_cache/documents/dataform.v1.json
diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html
index 5deef6364b8..054d0015e62 100644
--- a/docs/dyn/aiplatform_v1.endpoints.html
+++ b/docs/dyn/aiplatform_v1.endpoints.html
@@ -257,6 +257,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -317,6 +320,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -388,6 +403,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -482,6 +498,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -706,6 +723,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -766,6 +786,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -862,6 +894,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -956,6 +989,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -1442,6 +1476,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1502,6 +1539,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1598,6 +1647,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -1692,6 +1742,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html
index 72d31963c12..c8b7c3e314d 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html
@@ -231,6 +231,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -325,6 +326,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -562,6 +564,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -656,6 +659,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -918,6 +922,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -1012,6 +1017,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -1260,6 +1266,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -1354,6 +1361,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -1610,6 +1618,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -1704,6 +1713,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -1942,6 +1952,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -2036,6 +2047,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
diff --git a/docs/dyn/aiplatform_v1.projects.locations.customJobs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.customJobs.operations.html
index a00c2affa05..31dd0c59e78 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.customJobs.operations.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.customJobs.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -385,6 +388,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -456,6 +471,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -550,6 +566,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -1668,6 +1685,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1728,6 +1748,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1824,6 +1856,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -1918,6 +1951,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -3881,6 +3915,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -3941,6 +3978,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -4037,6 +4086,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -4131,6 +4181,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.operations.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.operations.html
index ae8f4d846e8..25fd435b25a 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.operations.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -231,6 +234,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -263,6 +278,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -323,6 +341,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -357,6 +387,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -417,6 +450,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -474,6 +519,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -534,6 +582,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -562,6 +622,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -622,6 +685,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -679,6 +754,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -739,6 +817,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -786,6 +876,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -846,6 +939,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -863,7 +968,7 @@ Method Details
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
- "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
},
},
"labels": { # Optional. Labels for the evaluation run.
@@ -919,6 +1024,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -979,6 +1087,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1011,6 +1131,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1071,6 +1194,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1105,6 +1240,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1165,6 +1303,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1222,6 +1372,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1282,6 +1435,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1310,6 +1475,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1370,6 +1538,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1427,6 +1607,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1487,6 +1670,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1534,6 +1729,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1594,6 +1792,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1611,7 +1821,7 @@ Method Details
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
- "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
},
},
"labels": { # Optional. Labels for the evaluation run.
@@ -1709,6 +1919,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1769,6 +1982,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1801,6 +2026,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1861,6 +2089,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1895,6 +2135,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1955,6 +2198,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2012,6 +2267,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2072,6 +2330,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2100,6 +2370,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2160,6 +2433,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2217,6 +2502,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2277,6 +2565,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2324,6 +2624,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2384,6 +2687,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2401,7 +2716,7 @@ Method Details
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
- "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
},
},
"labels": { # Optional. Labels for the evaluation run.
@@ -2470,6 +2785,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2530,6 +2848,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2562,6 +2892,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2622,6 +2955,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2656,6 +3001,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2716,6 +3064,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2773,6 +3133,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2833,6 +3196,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2861,6 +3236,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2921,6 +3299,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2978,6 +3368,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -3038,6 +3431,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -3085,6 +3490,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -3145,6 +3553,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -3162,7 +3582,7 @@ Method Details
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
- "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
},
},
"labels": { # Optional. Labels for the evaluation run.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureGroups.features.operations.html b/docs/dyn/aiplatform_v1.projects.locations.featureGroups.features.operations.html
index 281f6058d15..e4d62e035fa 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.featureGroups.features.operations.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.featureGroups.features.operations.html
@@ -84,7 +84,7 @@ Instance Methods
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.
- listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.
listWait_next()
@@ -152,7 +152,7 @@ Method Details
-
listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,6 +192,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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.
- listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.
listWait_next()
@@ -152,7 +152,7 @@ Method Details
-
listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,6 +192,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
fetchFeatureValues(featureView, body=None, x__xgafv=None)
Fetch feature values under a FeatureView.
+
+ generateFetchAccessToken(featureView, body=None, x__xgafv=None)
+RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.
get(name, x__xgafv=None)
Gets details of a single FeatureView.
@@ -148,6 +151,9 @@ Method Details
],
"uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.
},
+ "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable.
+ "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable.
+ },
"createTime": "A String", # Output only. Timestamp when this FeatureView was created.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
@@ -456,6 +462,32 @@ Method Details
}
+
+
generateFetchAccessToken(featureView, body=None, x__xgafv=None)
+
RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.
+
+Args:
+ featureView: string, FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for FeatureOnlineStoreService.GenerateFetchAccessToken.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for FeatureOnlineStoreService.GenerateFetchAccessToken.
+ "accessToken": "A String", # The OAuth 2.0 access token.
+ "expireTime": "A String", # Token expiration time. This is always set
+}
+
get(name, x__xgafv=None)
Gets details of a single FeatureView.
@@ -477,6 +509,9 @@ Method Details
],
"uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.
},
+ "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable.
+ "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable.
+ },
"createTime": "A String", # Output only. Timestamp when this FeatureView was created.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
@@ -592,6 +627,9 @@ Method Details
],
"uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.
},
+ "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable.
+ "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable.
+ },
"createTime": "A String", # Output only. Timestamp when this FeatureView was created.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
@@ -678,6 +716,9 @@ Method Details
],
"uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.
},
+ "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable.
+ "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable.
+ },
"createTime": "A String", # Output only. Timestamp when this FeatureView was created.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.operations.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.operations.html
index 0e63c82eab4..e3129d6a415 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.operations.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.operations.html
@@ -84,7 +84,7 @@ Instance Methods
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.
- listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.
listWait_next()
@@ -152,7 +152,7 @@ Method Details
-
listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,6 +192,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'.
"minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.
},
+ "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only.
+ "instanceId": "A String", # The Cloud Bigtable instance id.
+ "tableId": "A String", # The Cloud Bigtable table id.
+ "tenantProjectId": "A String", # Tenant project ID.
+ },
+ "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance.
},
"createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created.
"dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.
@@ -262,6 +268,12 @@ Method Details
"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'.
"minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.
},
+ "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only.
+ "instanceId": "A String", # The Cloud Bigtable instance id.
+ "tableId": "A String", # The Cloud Bigtable table id.
+ "tenantProjectId": "A String", # Tenant project ID.
+ },
+ "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance.
},
"createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created.
"dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.
@@ -364,6 +376,12 @@ Method Details
"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'.
"minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.
},
+ "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only.
+ "instanceId": "A String", # The Cloud Bigtable instance id.
+ "tableId": "A String", # The Cloud Bigtable table id.
+ "tenantProjectId": "A String", # Tenant project ID.
+ },
+ "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance.
},
"createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created.
"dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.
@@ -437,6 +455,12 @@ Method Details
"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'.
"minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.
},
+ "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only.
+ "instanceId": "A String", # The Cloud Bigtable instance id.
+ "tableId": "A String", # The Cloud Bigtable table id.
+ "tenantProjectId": "A String", # Tenant project ID.
+ },
+ "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance.
},
"createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created.
"dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.operations.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.operations.html
index f0aca295ef4..1a086ccf5b4 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.operations.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.operations.html
@@ -84,7 +84,7 @@ Instance Methods
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.
- listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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`.
listWait_next()
@@ -152,7 +152,7 @@ Method Details
-
listWait(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,6 +192,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"dedicatedEndpointEnabled": True or False, # Optional. Deprecated. Use dedicated_endpoint_disabled instead. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.
"endpointDisplayName": "A String", # Optional. The user-specified display name of the endpoint. If not set, a default name will be used.
"endpointUserId": "A String", # Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.
+ "labels": { # Optional. The labels with user-defined metadata to organize your Endpoints. 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",
+ },
"privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect.
"enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect.
"projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment.
@@ -822,6 +825,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -882,6 +888,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -933,6 +951,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -993,6 +1014,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1028,6 +1061,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1088,6 +1124,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1199,6 +1247,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1259,6 +1310,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1599,6 +1662,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1659,6 +1725,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1694,6 +1772,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1754,6 +1835,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2586,6 +2679,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2646,6 +2742,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.operations.html
index 949db640101..f8ee388a9d5 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.operations.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
@@ -360,7 +360,7 @@ Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
@@ -610,7 +610,7 @@ Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
@@ -745,7 +745,7 @@ Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
@@ -883,7 +883,7 @@ Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
@@ -999,7 +999,7 @@ Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
@@ -1122,7 +1122,7 @@ Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.operations.html b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.operations.html
index d3b94cb0bbe..676b7811534 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.operations.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -321,6 +324,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -392,6 +407,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -486,6 +502,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -710,6 +727,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -770,6 +790,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -866,6 +898,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -960,6 +993,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -1674,6 +1708,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1734,6 +1771,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1830,6 +1879,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -1924,6 +1974,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
diff --git a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.operations.html b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.operations.html
index 778111257e1..7274d12ee7e 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.operations.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"a_key": "A String",
},
"name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
+ "preTunedModel": { # A pre-tuned model for continuous tuning. # The pre-tuned model for continuous tuning.
+ "baseModel": "A String", # Output only. The name of the base model this PreTunedModel was tuned from.
+ "checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used.
+ "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
+ },
"serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
@@ -184,9 +189,9 @@ Method Details
},
],
"endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
- "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+ "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
},
- "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+ "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
"droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped.
@@ -334,6 +339,11 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
+ "preTunedModel": { # A pre-tuned model for continuous tuning. # The pre-tuned model for continuous tuning.
+ "baseModel": "A String", # Output only. The name of the base model this PreTunedModel was tuned from.
+ "checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used.
+ "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
+ },
"serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
@@ -357,9 +367,9 @@ Method Details
},
],
"endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
- "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+ "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
},
- "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+ "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
"droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped.
@@ -514,6 +524,11 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
+ "preTunedModel": { # A pre-tuned model for continuous tuning. # The pre-tuned model for continuous tuning.
+ "baseModel": "A String", # Output only. The name of the base model this PreTunedModel was tuned from.
+ "checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used.
+ "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
+ },
"serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
@@ -537,9 +552,9 @@ Method Details
},
],
"endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
- "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+ "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
},
- "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+ "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
"droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped.
@@ -700,6 +715,11 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
+ "preTunedModel": { # A pre-tuned model for continuous tuning. # The pre-tuned model for continuous tuning.
+ "baseModel": "A String", # Output only. The name of the base model this PreTunedModel was tuned from.
+ "checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used.
+ "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
+ },
"serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
@@ -723,9 +743,9 @@ Method Details
},
],
"endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
- "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+ "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
},
- "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+ "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
"droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped.
@@ -901,6 +921,11 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
+ "preTunedModel": { # A pre-tuned model for continuous tuning. # The pre-tuned model for continuous tuning.
+ "baseModel": "A String", # Output only. The name of the base model this PreTunedModel was tuned from.
+ "checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used.
+ "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
+ },
"serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
"state": "A String", # Output only. The detailed state of the job.
@@ -924,9 +949,9 @@ Method Details
},
],
"endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
- "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+ "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
},
- "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+ "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
"droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html
index 247de0bc9aa..609ff001458 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -170,7 +170,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -178,6 +178,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -209,6 +210,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -315,6 +318,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -386,6 +401,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -480,6 +496,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -704,6 +721,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -764,6 +784,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -860,6 +892,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -954,6 +987,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -2013,6 +2047,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2073,6 +2110,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2169,6 +2218,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -2263,6 +2313,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html
index 267867eccaf..7bbf4858e75 100644
--- a/docs/dyn/aiplatform_v1beta1.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.endpoints.html
@@ -261,6 +261,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -324,6 +327,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -397,6 +412,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -491,6 +507,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -724,6 +741,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -787,6 +807,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -885,6 +917,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -979,6 +1012,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -1479,6 +1513,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1542,6 +1579,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1640,6 +1689,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -1734,6 +1784,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.operations.html
index 0488ae8b8a6..bbd95652ba0 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.operations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -329,6 +330,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -577,6 +579,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -671,6 +674,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -944,6 +948,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -1038,6 +1043,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -1297,6 +1303,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -1391,6 +1398,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -1658,6 +1666,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -1752,6 +1761,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -2001,6 +2011,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -2095,6 +2106,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.operations.html
index dc573a08335..d9b579cff82 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.operations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -274,6 +277,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -369,6 +384,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -463,6 +479,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -679,6 +696,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -742,6 +762,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -837,6 +869,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -931,6 +964,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.operations.html
index 896aedf5c47..46476aaa4ea 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.operations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -155,6 +156,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
@@ -262,6 +267,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -280,6 +286,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
@@ -326,6 +336,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -344,6 +355,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
@@ -398,6 +413,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -416,6 +432,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"disableContainerLogging": True or False, # If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
@@ -503,6 +523,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -521,6 +542,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.operations.html
index 71c0f6f2dd9..9a68c98cc51 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.operations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -401,6 +404,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -474,6 +489,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -568,6 +584,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -731,6 +748,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -749,6 +767,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
@@ -1062,6 +1084,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -1080,6 +1103,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
@@ -1870,6 +1897,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1933,6 +1963,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2031,6 +2073,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -2125,6 +2168,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -2521,6 +2565,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -2539,6 +2584,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
@@ -2842,6 +2891,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -2860,6 +2910,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
@@ -3126,6 +3180,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -3144,6 +3199,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
@@ -3374,6 +3433,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -3392,6 +3452,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
@@ -3647,6 +3711,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -3665,6 +3730,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
@@ -4316,6 +4385,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -4379,6 +4451,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -4477,6 +4561,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -4571,6 +4656,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -5070,6 +5156,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -5088,6 +5175,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"disableContainerLogging": True or False, # For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.operations.html
index 919eda45ad6..bb6e5055d85 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.operations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -152,7 +152,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,6 +192,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -239,6 +242,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -271,6 +286,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -334,6 +352,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -368,6 +398,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -431,6 +464,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -488,6 +533,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -551,6 +599,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -579,6 +639,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -642,6 +705,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -699,6 +774,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -762,6 +840,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -809,6 +899,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -872,6 +965,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -889,7 +994,7 @@ Method Details
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
- "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
},
},
"labels": { # Optional. Labels for the evaluation run.
@@ -945,6 +1050,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1008,6 +1116,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1040,6 +1160,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1103,6 +1226,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1137,6 +1272,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1200,6 +1338,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1257,6 +1407,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1320,6 +1473,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1348,6 +1513,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1411,6 +1579,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1468,6 +1648,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1531,6 +1714,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1578,6 +1773,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1641,6 +1839,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1658,7 +1868,7 @@ Method Details
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
- "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
},
},
"labels": { # Optional. Labels for the evaluation run.
@@ -1756,6 +1966,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1819,6 +2032,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1851,6 +2076,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1914,6 +2142,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1948,6 +2188,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2011,6 +2254,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2068,6 +2323,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2131,6 +2389,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2159,6 +2429,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2222,6 +2495,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2279,6 +2564,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2342,6 +2630,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2389,6 +2689,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2452,6 +2755,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2469,7 +2784,7 @@ Method Details
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
- "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
},
},
"labels": { # Optional. Labels for the evaluation run.
@@ -2538,6 +2853,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2601,6 +2919,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2633,6 +2963,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2696,6 +3029,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2730,6 +3075,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2793,6 +3141,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2850,6 +3210,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2913,6 +3276,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2941,6 +3316,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -3004,6 +3382,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -3061,6 +3451,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -3124,6 +3517,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -3171,6 +3576,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -3234,6 +3642,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -3251,7 +3671,7 @@ Method Details
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
- "model": "A String", # Required. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
},
},
"labels": { # Optional. Labels for the evaluation run.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.operations.html
index 632b076d8a0..1298a2b25c4 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.operations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.operations.html
@@ -84,7 +84,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -152,7 +152,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,6 +192,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -152,7 +152,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,6 +192,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -152,7 +152,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,6 +192,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -152,7 +152,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,6 +192,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -152,7 +152,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,6 +192,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -152,7 +152,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,6 +192,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
fetchFeatureValues(featureView, body=None, x__xgafv=None)
Fetch feature values under a FeatureView.
+
+ generateFetchAccessToken(featureView, body=None, x__xgafv=None)
+RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.
get(name, x__xgafv=None)
Gets details of a single FeatureView.
@@ -151,6 +154,9 @@ Method Details
],
"uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.
},
+ "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable.
+ "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable.
+ },
"createTime": "A String", # Output only. Timestamp when this FeatureView was created.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
@@ -516,6 +522,32 @@ Method Details
}
+
+
generateFetchAccessToken(featureView, body=None, x__xgafv=None)
+
RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.
+
+Args:
+ featureView: string, FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for FeatureOnlineStoreService.GenerateFetchAccessToken.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for FeatureOnlineStoreService.GenerateFetchAccessToken.
+ "accessToken": "A String", # The OAuth 2.0 access token.
+ "expireTime": "A String", # Token expiration time. This is always set
+}
+
get(name, x__xgafv=None)
Gets details of a single FeatureView.
@@ -537,6 +569,9 @@ Method Details
],
"uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.
},
+ "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable.
+ "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable.
+ },
"createTime": "A String", # Output only. Timestamp when this FeatureView was created.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
@@ -666,6 +701,9 @@ Method Details
],
"uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.
},
+ "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable.
+ "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable.
+ },
"createTime": "A String", # Output only. Timestamp when this FeatureView was created.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
@@ -766,6 +804,9 @@ Method Details
],
"uri": "A String", # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.
},
+ "bigtableMetadata": { # Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances. # Output only. Metadata containing information about the Cloud Bigtable.
+ "readAppProfile": "A String", # Output only. The Bigtable App Profile to use for reading from Bigtable.
+ },
"createTime": "A String", # Output only. Timestamp when this FeatureView was created.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"featureRegistrySource": { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.operations.html
index cd9875e9def..0d7c94b3d14 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.operations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.operations.html
@@ -84,7 +84,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -152,7 +152,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,6 +192,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'.
"minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.
},
+ "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only.
+ "instanceId": "A String", # The Cloud Bigtable instance id.
+ "tableId": "A String", # The Cloud Bigtable table id.
+ "tenantProjectId": "A String", # Tenant project ID.
+ },
+ "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance.
},
"createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created.
"dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.
@@ -266,6 +272,12 @@ Method Details
"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'.
"minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.
},
+ "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only.
+ "instanceId": "A String", # The Cloud Bigtable instance id.
+ "tableId": "A String", # The Cloud Bigtable table id.
+ "tenantProjectId": "A String", # Tenant project ID.
+ },
+ "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance.
},
"createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created.
"dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.
@@ -372,6 +384,12 @@ Method Details
"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'.
"minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.
},
+ "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only.
+ "instanceId": "A String", # The Cloud Bigtable instance id.
+ "tableId": "A String", # The Cloud Bigtable table id.
+ "tenantProjectId": "A String", # Tenant project ID.
+ },
+ "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance.
},
"createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created.
"dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.
@@ -449,6 +467,12 @@ Method Details
"maxNodeCount": 42, # Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'.
"minNodeCount": 42, # Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.
},
+ "bigtableMetadata": { # Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project. # Output only. Metadata of the Bigtable instance. Output only.
+ "instanceId": "A String", # The Cloud Bigtable instance id.
+ "tableId": "A String", # The Cloud Bigtable table id.
+ "tenantProjectId": "A String", # Tenant project ID.
+ },
+ "enableDirectBigtableAccess": True or False, # Optional. It true, enable direct access to the Bigtable instance.
},
"createTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was created.
"dedicatedServingEndpoint": { # The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. # Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.operations.html
index 22fc45fcccb..13f0857e401 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.operations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.operations.html
@@ -84,7 +84,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -152,7 +152,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -160,6 +160,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,6 +192,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -684,6 +685,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"fastTryoutEnabled": True or False, # Optional. If true, enable the QMT fast tryout feature for this model if possible.
@@ -696,6 +701,9 @@ Method Details
"dedicatedEndpointEnabled": True or False, # Optional. Deprecated. Use dedicated_endpoint_disabled instead. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.
"endpointDisplayName": "A String", # Optional. The user-specified display name of the endpoint. If not set, a default name will be used.
"endpointUserId": "A String", # Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.
+ "labels": { # Optional. The labels with user-defined metadata to organize your Endpoints. 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",
+ },
"privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect.
"enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect.
"enableSecurePrivateServiceConnect": True or False, # Optional. If set to true, enable secure private service connect with IAM authorization. Otherwise, private service connect will be done without authorization. Note latency will be slightly increased if authorization is enabled.
@@ -905,6 +913,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -923,6 +932,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"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.
@@ -978,6 +991,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1041,6 +1057,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1092,6 +1120,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1155,6 +1186,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1190,6 +1233,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1253,6 +1299,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1364,6 +1422,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1427,6 +1488,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1775,6 +1848,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1838,6 +1914,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1873,6 +1961,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1936,6 +2027,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2774,6 +2877,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2837,6 +2943,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.operations.html
index b9b3ffb0802..da5a851ba86 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.operations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -170,6 +171,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint.
@@ -183,7 +188,7 @@ Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
@@ -346,6 +351,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -364,6 +370,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint.
@@ -377,7 +387,7 @@ Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
@@ -604,6 +614,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -622,6 +633,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint.
@@ -635,7 +650,7 @@ Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
@@ -748,6 +763,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -766,6 +782,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint.
@@ -779,7 +799,7 @@ Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
@@ -895,6 +915,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -913,6 +934,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint.
@@ -926,7 +951,7 @@ Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
@@ -1019,6 +1044,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -1037,6 +1063,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint.
@@ -1050,7 +1080,7 @@ Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
@@ -1151,6 +1181,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -1169,6 +1200,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"deployedIndexAuthConfig": { # Used to set up the auth on the DeployedIndex's private endpoint. # Optional. If set, the authentication is enabled for the private endpoint.
@@ -1182,7 +1217,7 @@ Method Details
},
},
"deploymentGroup": "A String", # Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
- "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE.
+ "deploymentTier": "A String", # Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.
"displayName": "A String", # The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
"enableAccessLogging": True or False, # Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
"enableDatapointUpsertLogging": True or False, # Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.operations.html
index d65d85540e7..5d6a55b827a 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.operations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -340,6 +343,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -413,6 +428,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -507,6 +523,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -812,6 +829,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -875,6 +895,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -973,6 +1005,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -1067,6 +1100,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -1882,6 +1916,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1945,6 +1982,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2043,6 +2092,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -2137,6 +2187,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.operations.html
index ebe0738fcc7..e7494fefb83 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.operations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
The object takes the form of:
{ # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.
+ "connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment.
+ "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer.
+ "loadBalancerIp": "A String", # Output only. The IP address of the load balancer.
+ "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment.
+ },
"createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
"displayName": "A String", # Required. The display name of the SandboxEnvironment.
"expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
@@ -125,6 +130,8 @@ Method Details
"codeLanguage": "A String", # The coding language supported in this environment.
"machineConfig": "A String", # The machine config of the code execution environment.
},
+ "computerUseEnvironment": { # The computer use environment with customized settings. # Optional. The computer use environment.
+ },
},
"state": "A String", # Output only. The runtime state of the SandboxEnvironment.
"ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL.
@@ -256,6 +263,11 @@ Method Details
An object of the form:
{ # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.
+ "connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment.
+ "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer.
+ "loadBalancerIp": "A String", # Output only. The IP address of the load balancer.
+ "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment.
+ },
"createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
"displayName": "A String", # Required. The display name of the SandboxEnvironment.
"expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
@@ -265,6 +277,8 @@ Method Details
"codeLanguage": "A String", # The coding language supported in this environment.
"machineConfig": "A String", # The machine config of the code execution environment.
},
+ "computerUseEnvironment": { # The computer use environment with customized settings. # Optional. The computer use environment.
+ },
},
"state": "A String", # Output only. The runtime state of the SandboxEnvironment.
"ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL.
@@ -293,6 +307,11 @@ Method Details
"nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
"sandboxEnvironments": [ # The SandboxEnvironments matching the request.
{ # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.
+ "connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment.
+ "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer.
+ "loadBalancerIp": "A String", # Output only. The IP address of the load balancer.
+ "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment.
+ },
"createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
"displayName": "A String", # Required. The display name of the SandboxEnvironment.
"expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
@@ -302,6 +321,8 @@ Method Details
"codeLanguage": "A String", # The coding language supported in this environment.
"machineConfig": "A String", # The machine config of the code execution environment.
},
+ "computerUseEnvironment": { # The computer use environment with customized settings. # Optional. The computer use environment.
+ },
},
"state": "A String", # Output only. The runtime state of the SandboxEnvironment.
"ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.operations.html
index 2effd706dea..0ceb370f4d4 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.operations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.operations.html
@@ -87,7 +87,7 @@ Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -149,7 +149,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -157,6 +157,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -188,6 +189,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Instance Methods
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)
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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()
@@ -173,7 +173,7 @@ Method Details
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=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:
@@ -181,6 +181,7 @@ Method Details
filter: string, The standard list filter.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -212,6 +213,9 @@ Method Details
},
},
],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+ "A String",
+ ],
}
Method Details
},
],
"experiment": "A String", # Output only. The Experiment associated with this TuningJob.
+ "fullFineTuningSpec": { # Tuning Spec for Full Fine Tuning. # Tuning Spec for Full Fine Tuning.
+ "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for Full Fine Tuning.
+ "adapterSize": "A String", # Optional. Adapter size for tuning.
+ "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models.
+ "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
+ "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
+ },
+ "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+ "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+ },
"labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. 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",
},
@@ -270,6 +281,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -333,6 +347,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -374,6 +400,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -437,6 +466,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -472,6 +513,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -535,6 +579,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -623,6 +679,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -686,6 +745,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -727,6 +798,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -790,6 +864,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -825,6 +911,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -888,6 +977,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -973,9 +1074,9 @@ Method Details
},
],
"endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
- "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+ "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
},
- "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+ "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
"trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
@@ -1504,6 +1605,17 @@ Method Details
},
],
"experiment": "A String", # Output only. The Experiment associated with this TuningJob.
+ "fullFineTuningSpec": { # Tuning Spec for Full Fine Tuning. # Tuning Spec for Full Fine Tuning.
+ "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for Full Fine Tuning.
+ "adapterSize": "A String", # Optional. Adapter size for tuning.
+ "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models.
+ "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
+ "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
+ },
+ "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+ "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+ },
"labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. 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",
},
@@ -1532,6 +1644,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1595,6 +1710,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1636,6 +1763,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1699,6 +1829,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1734,6 +1876,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1797,6 +1942,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1885,6 +2042,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -1948,6 +2108,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -1989,6 +2161,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2052,6 +2227,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2087,6 +2274,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2150,6 +2340,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2235,9 +2437,9 @@ Method Details
},
],
"endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
- "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+ "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
},
- "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+ "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
"trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
@@ -2773,6 +2975,17 @@ Method Details
},
],
"experiment": "A String", # Output only. The Experiment associated with this TuningJob.
+ "fullFineTuningSpec": { # Tuning Spec for Full Fine Tuning. # Tuning Spec for Full Fine Tuning.
+ "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for Full Fine Tuning.
+ "adapterSize": "A String", # Optional. Adapter size for tuning.
+ "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models.
+ "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
+ "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
+ },
+ "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+ "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+ },
"labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. 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",
},
@@ -2801,6 +3014,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2864,6 +3080,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2905,6 +3133,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2968,6 +3199,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -3003,6 +3246,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -3066,6 +3312,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -3154,6 +3412,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -3217,6 +3478,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -3258,6 +3531,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -3321,6 +3597,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -3356,6 +3644,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -3419,6 +3710,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -3504,9 +3807,9 @@ Method Details
},
],
"endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
- "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+ "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
},
- "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+ "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
"trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
@@ -4048,6 +4351,17 @@ Method Details
},
],
"experiment": "A String", # Output only. The Experiment associated with this TuningJob.
+ "fullFineTuningSpec": { # Tuning Spec for Full Fine Tuning. # Tuning Spec for Full Fine Tuning.
+ "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for Full Fine Tuning.
+ "adapterSize": "A String", # Optional. Adapter size for tuning.
+ "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models.
+ "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
+ "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
+ },
+ "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+ "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+ },
"labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. 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",
},
@@ -4076,6 +4390,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -4139,6 +4456,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -4180,6 +4509,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -4243,6 +4575,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -4278,6 +4622,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -4341,6 +4688,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -4429,6 +4788,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -4492,6 +4854,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -4533,6 +4907,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -4596,6 +4973,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -4631,6 +5020,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -4694,6 +5086,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -4779,9 +5183,9 @@ Method Details
},
],
"endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
- "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+ "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
},
- "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+ "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
"trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
@@ -5456,6 +5860,17 @@ Method Details
},
],
"experiment": "A String", # Output only. The Experiment associated with this TuningJob.
+ "fullFineTuningSpec": { # Tuning Spec for Full Fine Tuning. # Tuning Spec for Full Fine Tuning.
+ "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for Full Fine Tuning.
+ "adapterSize": "A String", # Optional. Adapter size for tuning.
+ "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models.
+ "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
+ "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
+ },
+ "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+ "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+ },
"labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. 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",
},
@@ -5484,6 +5899,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -5547,6 +5965,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -5588,6 +6018,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -5651,6 +6084,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -5686,6 +6131,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -5749,6 +6197,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -5837,6 +6297,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -5900,6 +6363,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -5941,6 +6416,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -6004,6 +6482,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -6039,6 +6529,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -6102,6 +6595,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -6187,9 +6692,9 @@ Method Details
},
],
"endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
- "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version_id will be 1. For continuous tuning, the version id will be incremented by 1 from the last version id in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+ "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
},
- "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+ "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
"tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
"distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
"trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html
index d292f7abe13..07105cac91c 100644
--- a/docs/dyn/aiplatform_v1beta1.publishers.models.html
+++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html
@@ -265,6 +265,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -328,6 +331,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -401,6 +416,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -495,6 +511,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -728,6 +745,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -791,6 +811,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -889,6 +921,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -983,6 +1016,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
@@ -1545,6 +1579,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -1563,6 +1598,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config.
@@ -1732,6 +1771,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -1750,6 +1790,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config.
@@ -2149,6 +2193,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -2167,6 +2212,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config.
@@ -2336,6 +2385,7 @@ Method Details
"flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
"maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
},
+ "initialReplicaCount": 42, # Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count > 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
"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.
@@ -2354,6 +2404,10 @@ Method Details
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that 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 to that many replicas is guaranteed (barring service outages). If traffic 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 that will be always deployed on. This value must be greater than or equal to 1. If traffic 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 deployment/mutation is desired. If set, the 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.
+ "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature.
+ "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)
+ "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)
+ },
"spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
},
"deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config.
@@ -2702,6 +2756,9 @@ Method Details
"candidateCount": 42, # Optional. Number of candidates to generate.
"enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
+ "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+ "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+ },
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
@@ -2765,6 +2822,18 @@ Method Details
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
+ "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+ "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+ { # Configuration for a single speaker in a multi speaker setup.
+ "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+ "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
+ "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.
+ },
+ },
+ },
+ ],
+ },
"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.
@@ -2863,6 +2932,7 @@ Method Details
"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
},
"enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
"A String",
],
@@ -2957,6 +3027,7 @@ Method Details
"enableWidget": True or False, # Optional. If true, include the widget context token in the response.
},
"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.
+ "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html
index 6f7bc5dc4d3..9cebe06928a 100644
--- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html
+++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html
@@ -297,6 +297,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
@@ -537,6 +538,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
@@ -885,6 +887,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
@@ -1160,6 +1163,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
@@ -1389,6 +1393,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
@@ -1686,6 +1691,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
@@ -1937,6 +1943,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html
index c4d9813ddf2..48dcd8de904 100644
--- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html
+++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html
@@ -297,6 +297,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
@@ -536,6 +537,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
@@ -883,6 +885,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
@@ -1157,6 +1160,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
@@ -1385,6 +1389,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
@@ -1681,6 +1686,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
@@ -1931,6 +1937,7 @@ Method Details
},
],
},
+ "maintenanceVersionSelectionPolicy": "A String", # Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
"migrationSource": { # Subset of the source instance configuration that is available when reading the cluster resource. # Output only. Cluster created via DMS migration.
"hostPort": "A String", # Output only. The host and port of the on-premises instance in host:port format
"referenceId": "A String", # Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.
diff --git a/docs/dyn/androidmanagement_v1.enterprises.devices.html b/docs/dyn/androidmanagement_v1.enterprises.devices.html
index 05918af8c22..f44af95f5c9 100644
--- a/docs/dyn/androidmanagement_v1.enterprises.devices.html
+++ b/docs/dyn/androidmanagement_v1.enterprises.devices.html
@@ -204,6 +204,18 @@ Method Details
"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled.
"policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification.
},
+ "defaultApplicationInfo": [ # Output only. The default application information for the DefaultApplicationType. This information is only available if defaultApplicationInfoReportingEnabled is true in the device's policy. Available on Android 16 and above.All app types are reported on fully managed devices. DEFAULT_BROWSER, DEFAULT_CALL_REDIRECTION, DEFAULT_CALL_SCREENING and DEFAULT_DIALER types are reported for the work profiles on company-owned devices with a work profile and personally-owned devices. DEFAULT_WALLET is also reported for company-owned devices with a work profile, but will only include work profile information.
+ { # The default application information for a specific DefaultApplicationType.
+ "defaultApplicationSettingAttempts": [ # Output only. Details on the default application setting attempts, in the same order as listed in defaultApplications.
+ { # Details on a default application setting attempt.
+ "attemptOutcome": "A String", # Output only. The outcome of setting the app as the default.
+ "packageName": "A String", # Output only. The package name of the attempted application.
+ },
+ ],
+ "defaultApplicationType": "A String", # Output only. The default application type.
+ "packageName": "A String", # Output only. The package name of the current default application.
+ },
+ ],
"deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy.
"adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
"developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device.
@@ -338,6 +350,9 @@ Method Details
"packageName": "A String", # The package name indicating which app is out of compliance, if applicable.
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
+ "defaultApplicationContext": { # Additional context for non-compliance related to default application settings. # Output only. Additional context for non-compliance related to default application settings. See DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE.
+ "defaultApplicationScope": "A String", # Output only. The scope of non-compliant default application setting.
+ },
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
},
@@ -621,6 +636,18 @@ Method Details
"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled.
"policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification.
},
+ "defaultApplicationInfo": [ # Output only. The default application information for the DefaultApplicationType. This information is only available if defaultApplicationInfoReportingEnabled is true in the device's policy. Available on Android 16 and above.All app types are reported on fully managed devices. DEFAULT_BROWSER, DEFAULT_CALL_REDIRECTION, DEFAULT_CALL_SCREENING and DEFAULT_DIALER types are reported for the work profiles on company-owned devices with a work profile and personally-owned devices. DEFAULT_WALLET is also reported for company-owned devices with a work profile, but will only include work profile information.
+ { # The default application information for a specific DefaultApplicationType.
+ "defaultApplicationSettingAttempts": [ # Output only. Details on the default application setting attempts, in the same order as listed in defaultApplications.
+ { # Details on a default application setting attempt.
+ "attemptOutcome": "A String", # Output only. The outcome of setting the app as the default.
+ "packageName": "A String", # Output only. The package name of the attempted application.
+ },
+ ],
+ "defaultApplicationType": "A String", # Output only. The default application type.
+ "packageName": "A String", # Output only. The package name of the current default application.
+ },
+ ],
"deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy.
"adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
"developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device.
@@ -755,6 +782,9 @@ Method Details
"packageName": "A String", # The package name indicating which app is out of compliance, if applicable.
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
+ "defaultApplicationContext": { # Additional context for non-compliance related to default application settings. # Output only. Additional context for non-compliance related to default application settings. See DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE.
+ "defaultApplicationScope": "A String", # Output only. The scope of non-compliant default application setting.
+ },
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
},
@@ -906,6 +936,18 @@ Method Details
"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled.
"policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification.
},
+ "defaultApplicationInfo": [ # Output only. The default application information for the DefaultApplicationType. This information is only available if defaultApplicationInfoReportingEnabled is true in the device's policy. Available on Android 16 and above.All app types are reported on fully managed devices. DEFAULT_BROWSER, DEFAULT_CALL_REDIRECTION, DEFAULT_CALL_SCREENING and DEFAULT_DIALER types are reported for the work profiles on company-owned devices with a work profile and personally-owned devices. DEFAULT_WALLET is also reported for company-owned devices with a work profile, but will only include work profile information.
+ { # The default application information for a specific DefaultApplicationType.
+ "defaultApplicationSettingAttempts": [ # Output only. Details on the default application setting attempts, in the same order as listed in defaultApplications.
+ { # Details on a default application setting attempt.
+ "attemptOutcome": "A String", # Output only. The outcome of setting the app as the default.
+ "packageName": "A String", # Output only. The package name of the attempted application.
+ },
+ ],
+ "defaultApplicationType": "A String", # Output only. The default application type.
+ "packageName": "A String", # Output only. The package name of the current default application.
+ },
+ ],
"deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy.
"adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
"developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device.
@@ -1040,6 +1082,9 @@ Method Details
"packageName": "A String", # The package name indicating which app is out of compliance, if applicable.
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
+ "defaultApplicationContext": { # Additional context for non-compliance related to default application settings. # Output only. Additional context for non-compliance related to default application settings. See DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE.
+ "defaultApplicationScope": "A String", # Output only. The scope of non-compliant default application setting.
+ },
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
},
@@ -1173,6 +1218,18 @@ Method Details
"commonCriteriaModeStatus": "A String", # Whether Common Criteria Mode is enabled.
"policySignatureVerificationStatus": "A String", # Output only. The status of policy signature verification.
},
+ "defaultApplicationInfo": [ # Output only. The default application information for the DefaultApplicationType. This information is only available if defaultApplicationInfoReportingEnabled is true in the device's policy. Available on Android 16 and above.All app types are reported on fully managed devices. DEFAULT_BROWSER, DEFAULT_CALL_REDIRECTION, DEFAULT_CALL_SCREENING and DEFAULT_DIALER types are reported for the work profiles on company-owned devices with a work profile and personally-owned devices. DEFAULT_WALLET is also reported for company-owned devices with a work profile, but will only include work profile information.
+ { # The default application information for a specific DefaultApplicationType.
+ "defaultApplicationSettingAttempts": [ # Output only. Details on the default application setting attempts, in the same order as listed in defaultApplications.
+ { # Details on a default application setting attempt.
+ "attemptOutcome": "A String", # Output only. The outcome of setting the app as the default.
+ "packageName": "A String", # Output only. The package name of the attempted application.
+ },
+ ],
+ "defaultApplicationType": "A String", # Output only. The default application type.
+ "packageName": "A String", # Output only. The package name of the current default application.
+ },
+ ],
"deviceSettings": { # Information about security related device settings on device. # Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy.
"adbEnabled": True or False, # Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.
"developmentSettingsEnabled": True or False, # Whether developer mode is enabled on the device.
@@ -1307,6 +1364,9 @@ Method Details
"packageName": "A String", # The package name indicating which app is out of compliance, if applicable.
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
+ "defaultApplicationContext": { # Additional context for non-compliance related to default application settings. # Output only. Additional context for non-compliance related to default application settings. See DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE.
+ "defaultApplicationScope": "A String", # Output only. The scope of non-compliant default application setting.
+ },
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE and ONC_WIFI_API_LEVEL
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
},
diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html
index 71f4aa3a8d2..f0e627fc8ce 100644
--- a/docs/dyn/androidmanagement_v1.enterprises.policies.html
+++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html
@@ -147,7 +147,7 @@ Method Details
"contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above.
"developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported.
"googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated).
- "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy.
+ "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot.
"personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name.
"A String",
],
@@ -279,6 +279,19 @@ Method Details
},
"dataRoamingDisabled": True or False, # Whether roaming data services are disabled.
"debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features.
+ "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details.
+ { # The default application setting for a DefaultApplicationType.
+ "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list).
+ "A String",
+ ],
+ "defaultApplicationType": "A String", # Required. The app type to set the default application.
+ "defaultApplications": [ # Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for the defaultApplicationType (e.g. SMS app for DEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts in order to be set as the default.If the defaultApplicationScopes contains SCOPE_FULLY_MANAGED or SCOPE_WORK_PROFILE, the app must have an entry in applications with installType set to a value other than BLOCKED.A NonComplianceDetail with APP_NOT_INSTALLED reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if none of the apps in the list are installed. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).When applying to SCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile.
+ { # Information about the application to be set as the default.
+ "packageName": "A String", # Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid.
+ },
+ ],
+ },
+ ],
"defaultPermissionPolicy": "A String", # The default permission policy for runtime permission requests.
"deviceConnectivityManagement": { # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more.
"apnPolicy": { # Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. # Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details.
@@ -567,6 +580,7 @@ Method Details
},
"applicationReportsEnabled": True or False, # Whether app reports are enabled.
"commonCriteriaModeEnabled": True or False, # Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices.
+ "defaultApplicationInfoReportingEnabled": True or False, # Optional. Whether defaultApplicationInfo reporting is enabled.
"deviceSettingsEnabled": True or False, # Whether device settings reporting is enabled.
"displayInfoEnabled": True or False, # Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles.
"hardwareStatusEnabled": True or False, # Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles.
@@ -655,7 +669,7 @@ Method Details
"contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above.
"developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported.
"googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated).
- "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy.
+ "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot.
"personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name.
"A String",
],
@@ -787,6 +801,19 @@ Method Details
},
"dataRoamingDisabled": True or False, # Whether roaming data services are disabled.
"debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features.
+ "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details.
+ { # The default application setting for a DefaultApplicationType.
+ "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list).
+ "A String",
+ ],
+ "defaultApplicationType": "A String", # Required. The app type to set the default application.
+ "defaultApplications": [ # Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for the defaultApplicationType (e.g. SMS app for DEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts in order to be set as the default.If the defaultApplicationScopes contains SCOPE_FULLY_MANAGED or SCOPE_WORK_PROFILE, the app must have an entry in applications with installType set to a value other than BLOCKED.A NonComplianceDetail with APP_NOT_INSTALLED reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if none of the apps in the list are installed. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).When applying to SCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile.
+ { # Information about the application to be set as the default.
+ "packageName": "A String", # Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid.
+ },
+ ],
+ },
+ ],
"defaultPermissionPolicy": "A String", # The default permission policy for runtime permission requests.
"deviceConnectivityManagement": { # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more.
"apnPolicy": { # Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. # Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details.
@@ -1075,6 +1102,7 @@ Method Details
},
"applicationReportsEnabled": True or False, # Whether app reports are enabled.
"commonCriteriaModeEnabled": True or False, # Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices.
+ "defaultApplicationInfoReportingEnabled": True or False, # Optional. Whether defaultApplicationInfo reporting is enabled.
"deviceSettingsEnabled": True or False, # Whether device settings reporting is enabled.
"displayInfoEnabled": True or False, # Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles.
"hardwareStatusEnabled": True or False, # Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles.
@@ -1249,7 +1277,7 @@ Method Details
"contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above.
"developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported.
"googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated).
- "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy.
+ "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot.
"personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name.
"A String",
],
@@ -1381,6 +1409,19 @@ Method Details
},
"dataRoamingDisabled": True or False, # Whether roaming data services are disabled.
"debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features.
+ "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details.
+ { # The default application setting for a DefaultApplicationType.
+ "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list).
+ "A String",
+ ],
+ "defaultApplicationType": "A String", # Required. The app type to set the default application.
+ "defaultApplications": [ # Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for the defaultApplicationType (e.g. SMS app for DEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts in order to be set as the default.If the defaultApplicationScopes contains SCOPE_FULLY_MANAGED or SCOPE_WORK_PROFILE, the app must have an entry in applications with installType set to a value other than BLOCKED.A NonComplianceDetail with APP_NOT_INSTALLED reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if none of the apps in the list are installed. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).When applying to SCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile.
+ { # Information about the application to be set as the default.
+ "packageName": "A String", # Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid.
+ },
+ ],
+ },
+ ],
"defaultPermissionPolicy": "A String", # The default permission policy for runtime permission requests.
"deviceConnectivityManagement": { # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more.
"apnPolicy": { # Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. # Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details.
@@ -1669,6 +1710,7 @@ Method Details
},
"applicationReportsEnabled": True or False, # Whether app reports are enabled.
"commonCriteriaModeEnabled": True or False, # Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices.
+ "defaultApplicationInfoReportingEnabled": True or False, # Optional. Whether defaultApplicationInfo reporting is enabled.
"deviceSettingsEnabled": True or False, # Whether device settings reporting is enabled.
"displayInfoEnabled": True or False, # Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles.
"hardwareStatusEnabled": True or False, # Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles.
@@ -1748,7 +1790,7 @@ Method Details
"contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above.
"developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported.
"googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated).
- "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy.
+ "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot.
"personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name.
"A String",
],
@@ -1880,6 +1922,19 @@ Method Details
},
"dataRoamingDisabled": True or False, # Whether roaming data services are disabled.
"debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features.
+ "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details.
+ { # The default application setting for a DefaultApplicationType.
+ "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list).
+ "A String",
+ ],
+ "defaultApplicationType": "A String", # Required. The app type to set the default application.
+ "defaultApplications": [ # Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for the defaultApplicationType (e.g. SMS app for DEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts in order to be set as the default.If the defaultApplicationScopes contains SCOPE_FULLY_MANAGED or SCOPE_WORK_PROFILE, the app must have an entry in applications with installType set to a value other than BLOCKED.A NonComplianceDetail with APP_NOT_INSTALLED reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if none of the apps in the list are installed. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).When applying to SCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile.
+ { # Information about the application to be set as the default.
+ "packageName": "A String", # Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid.
+ },
+ ],
+ },
+ ],
"defaultPermissionPolicy": "A String", # The default permission policy for runtime permission requests.
"deviceConnectivityManagement": { # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more.
"apnPolicy": { # Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. # Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details.
@@ -2168,6 +2223,7 @@ Method Details
},
"applicationReportsEnabled": True or False, # Whether app reports are enabled.
"commonCriteriaModeEnabled": True or False, # Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices.
+ "defaultApplicationInfoReportingEnabled": True or False, # Optional. Whether defaultApplicationInfo reporting is enabled.
"deviceSettingsEnabled": True or False, # Whether device settings reporting is enabled.
"displayInfoEnabled": True or False, # Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles.
"hardwareStatusEnabled": True or False, # Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles.
@@ -2245,7 +2301,7 @@ Method Details
"contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above.
"developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported.
"googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated).
- "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy.
+ "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot.
"personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name.
"A String",
],
@@ -2377,6 +2433,19 @@ Method Details
},
"dataRoamingDisabled": True or False, # Whether roaming data services are disabled.
"debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features.
+ "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details.
+ { # The default application setting for a DefaultApplicationType.
+ "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list).
+ "A String",
+ ],
+ "defaultApplicationType": "A String", # Required. The app type to set the default application.
+ "defaultApplications": [ # Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for the defaultApplicationType (e.g. SMS app for DEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts in order to be set as the default.If the defaultApplicationScopes contains SCOPE_FULLY_MANAGED or SCOPE_WORK_PROFILE, the app must have an entry in applications with installType set to a value other than BLOCKED.A NonComplianceDetail with APP_NOT_INSTALLED reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if none of the apps in the list are installed. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).When applying to SCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile.
+ { # Information about the application to be set as the default.
+ "packageName": "A String", # Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid.
+ },
+ ],
+ },
+ ],
"defaultPermissionPolicy": "A String", # The default permission policy for runtime permission requests.
"deviceConnectivityManagement": { # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more.
"apnPolicy": { # Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. # Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details.
@@ -2665,6 +2734,7 @@ Method Details
},
"applicationReportsEnabled": True or False, # Whether app reports are enabled.
"commonCriteriaModeEnabled": True or False, # Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices.
+ "defaultApplicationInfoReportingEnabled": True or False, # Optional. Whether defaultApplicationInfo reporting is enabled.
"deviceSettingsEnabled": True or False, # Whether device settings reporting is enabled.
"displayInfoEnabled": True or False, # Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles.
"hardwareStatusEnabled": True or False, # Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles.
@@ -2758,7 +2828,7 @@ Method Details
"contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above.
"developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported.
"googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated).
- "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy.
+ "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot.
"personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name.
"A String",
],
@@ -2890,6 +2960,19 @@ Method Details
},
"dataRoamingDisabled": True or False, # Whether roaming data services are disabled.
"debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features.
+ "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details.
+ { # The default application setting for a DefaultApplicationType.
+ "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list).
+ "A String",
+ ],
+ "defaultApplicationType": "A String", # Required. The app type to set the default application.
+ "defaultApplications": [ # Required. The list of applications that can be set as the default app for a given type. This list must not be empty or contain duplicates. The first app in the list that is installed and qualified for the defaultApplicationType (e.g. SMS app for DEFAULT_SMS) is set as the default app. The signing key certificate fingerprint of the app on the device must also match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts in order to be set as the default.If the defaultApplicationScopes contains SCOPE_FULLY_MANAGED or SCOPE_WORK_PROFILE, the app must have an entry in applications with installType set to a value other than BLOCKED.A NonComplianceDetail with APP_NOT_INSTALLED reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if none of the apps in the list are installed. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if at least one app is installed but the policy fails to apply due to other reasons (e.g. the app is not of the right type).When applying to SCOPE_PERSONAL_PROFILE on a company-owned device with a work profile, only pre-installed system apps can be set as the default. A NonComplianceDetail with INVALID_VALUE reason and DEFAULT_APPLICATION_SETTING_FAILED_FOR_SCOPE specific reason is reported if the policy fails to apply to the personal profile.
+ { # Information about the application to be set as the default.
+ "packageName": "A String", # Required. The package name that should be set as the default application. The policy is rejected if the package name is invalid.
+ },
+ ],
+ },
+ ],
"defaultPermissionPolicy": "A String", # The default permission policy for runtime permission requests.
"deviceConnectivityManagement": { # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. # Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more.
"apnPolicy": { # Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. # Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details.
@@ -3178,6 +3261,7 @@ Method Details
},
"applicationReportsEnabled": True or False, # Whether app reports are enabled.
"commonCriteriaModeEnabled": True or False, # Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices.
+ "defaultApplicationInfoReportingEnabled": True or False, # Optional. Whether defaultApplicationInfo reporting is enabled.
"deviceSettingsEnabled": True or False, # Whether device settings reporting is enabled.
"displayInfoEnabled": True or False, # Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles.
"hardwareStatusEnabled": True or False, # Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles.
diff --git a/docs/dyn/baremetalsolution_v2.projects.locations.html b/docs/dyn/baremetalsolution_v2.projects.locations.html
index d78a6b081b1..0ab544dac88 100644
--- a/docs/dyn/baremetalsolution_v2.projects.locations.html
+++ b/docs/dyn/baremetalsolution_v2.projects.locations.html
@@ -170,7 +170,7 @@ Method Details
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
- extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated)
+ extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/bigquerydatapolicy_v2.html b/docs/dyn/bigquerydatapolicy_v2.html
new file mode 100644
index 00000000000..ffe6c6438c5
--- /dev/null
+++ b/docs/dyn/bigquerydatapolicy_v2.html
@@ -0,0 +1,111 @@
+
+
+
+
+Instance Methods
+
+ projects()
+
+Returns the projects Resource.
+
+
+ close()
+Close httplib2 connections.
+
+ new_batch_http_request()
+Create a BatchHttpRequest object based on the discovery document.
+Method Details
+
+
close()
+
Close httplib2 connections.
+
+
new_batch_http_request()
+
Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+
+
Instance Methods
+
+ locations()
+
+Returns the locations Resource.
+
+
+ close()
+Close httplib2 connections.
+Method Details
+
+
close()
+
Close httplib2 connections.
+
Instance Methods
+
+ addGrantees(dataPolicy, body=None, x__xgafv=None)
+Adds new grantees to a data policy. The new grantees will be added to the existing grantees. If the request contains a duplicate grantee, the grantee will be ignored. If the request contains a grantee that already exists, the grantee will be ignored.
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
+Creates a new data policy under a project with the given `data_policy_id` (used as the display name), and data policy type.
+
+ delete(name, x__xgafv=None)
+Deletes the data policy specified by its resource name.
+
+ get(name, x__xgafv=None)
+Gets the data policy specified by its resource name.
+
+ getIamPolicy(resource, body=None, x__xgafv=None)
+Gets the IAM policy for the specified data policy.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+List all of the data policies in the specified parent project.
+
+ list_next()
+Retrieves the next page of results.
+
+ patch(name, allowMissing=None, body=None, updateMask=None, x__xgafv=None)
+Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.
+
+ removeGrantees(dataPolicy, body=None, x__xgafv=None)
+Removes grantees from a data policy. The grantees will be removed from the existing grantees. If the request contains a grantee that does not exist, the grantee will be ignored.
+
+ setIamPolicy(resource, body=None, x__xgafv=None)
+Sets the IAM policy for the specified data policy.
+
+ testIamPermissions(resource, body=None, x__xgafv=None)
+Returns the caller's permission on the specified data policy resource.
+Method Details
+
+
addGrantees(dataPolicy, body=None, x__xgafv=None)
+
Adds new grantees to a data policy. The new grantees will be added to the existing grantees. If the request contains a duplicate grantee, the grantee will be ignored. If the request contains a grantee that already exists, the grantee will be ignored.
+
+Args:
+ dataPolicy: string, Required. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for the AddGrantees method.
+ "grantees": [ # Required. IAM principal that should be granted Fine Grained Access to the underlying data goverened by the data policy. The target data policy is determined by the `data_policy` field. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2). Supported principal types: * User * Group * Service account
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents the label-policy binding.
+ "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+ "predefinedExpression": "A String", # Optional. A predefined masking expression.
+ "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+ },
+ "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+ "dataPolicyType": "A String", # Required. Type of data policy.
+ "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+ "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+ "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+ "version": "A String", # Output only. The version of the Data Policy resource.
+}
+
+
close()
+
Close httplib2 connections.
+
+
create(parent, body=None, x__xgafv=None)
+
Creates a new data policy under a project with the given `data_policy_id` (used as the display name), and data policy type.
+
+Args:
+ parent: string, Required. Resource name of the project that the data policy will belong to. The format is `projects/{project_number}/locations/{location_id}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for the CreateDataPolicy method.
+ "dataPolicy": { # Represents the label-policy binding. # Required. The data policy to create. The `name` field does not need to be provided for the data policy creation.
+ "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+ "predefinedExpression": "A String", # Optional. A predefined masking expression.
+ "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+ },
+ "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+ "dataPolicyType": "A String", # Required. Type of data policy.
+ "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+ "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+ "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+ "version": "A String", # Output only. The version of the Data Policy resource.
+ },
+ "dataPolicyId": "A String", # Required. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents the label-policy binding.
+ "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+ "predefinedExpression": "A String", # Optional. A predefined masking expression.
+ "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+ },
+ "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+ "dataPolicyType": "A String", # Required. Type of data policy.
+ "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+ "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+ "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+ "version": "A String", # Output only. The version of the Data Policy resource.
+}
+
+
delete(name, x__xgafv=None)
+
Deletes the data policy specified by its resource name.
+
+Args:
+ name: string, Required. Resource name of the data policy to delete. Format is `projects/{project_number}/locations/{location_id}/dataPolicies/{id}`. (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 data policy specified by its resource name.
+
+Args:
+ name: string, Required. Resource name of the requested data policy. Format is `projects/{project_number}/locations/{location_id}/dataPolicies/{id}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents the label-policy binding.
+ "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+ "predefinedExpression": "A String", # Optional. A predefined masking expression.
+ "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+ },
+ "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+ "dataPolicyType": "A String", # Required. Type of data policy.
+ "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+ "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+ "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+ "version": "A String", # Output only. The version of the Data Policy resource.
+}
+
+
getIamPolicy(resource, body=None, x__xgafv=None)
+
Gets the IAM policy for the specified data policy.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `GetIamPolicy` method.
+ "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
+ "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
List all of the data policies in the specified parent project.
+
+Args:
+ parent: string, Required. Resource name of the project for which to list data policies. Format is `projects/{project_number}/locations/{location_id}`. (required)
+ filter: string, Optional. Filters the data policies by policy tags that they are associated with. Currently filter only supports "policy_tag" based filtering and OR based predicates. Sample filter can be "policy_tag: projects/1/locations/us/taxonomies/2/policyTags/3". You may also use wildcard such as "policy_tag: projects/1/locations/us/taxonomies/2*". Please note that OR predicates cannot be used with wildcard filters.
+ pageSize: integer, Optional. The maximum number of data policies to return. Must be a value between 1 and 1000. If not set, defaults to 50.
+ pageToken: string, Optional. The `nextPageToken` value returned from a previous list request, if any. If not set, defaults to an empty string.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for the ListDataPolicies method.
+ "dataPolicies": [ # Data policies that belong to the requested project.
+ { # Represents the label-policy binding.
+ "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+ "predefinedExpression": "A String", # Optional. A predefined masking expression.
+ "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+ },
+ "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+ "dataPolicyType": "A String", # Required. Type of data policy.
+ "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+ "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+ "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+ "version": "A String", # Output only. The version of the Data Policy resource.
+ },
+ ],
+ "nextPageToken": "A String", # Token used to retrieve the next page of results, or empty if there are no more results.
+}
+
+
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.
+
+
+
patch(name, allowMissing=None, body=None, updateMask=None, x__xgafv=None)
+
Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.
+
+Args:
+ name: string, Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents the label-policy binding.
+ "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+ "predefinedExpression": "A String", # Optional. A predefined masking expression.
+ "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+ },
+ "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+ "dataPolicyType": "A String", # Required. Type of data policy.
+ "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+ "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+ "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+ "version": "A String", # Output only. The version of the Data Policy resource.
+}
+
+ allowMissing: boolean, Optional. If set to true, and the data policy is not found, a new data policy will be created. In this situation, update_mask is ignored.
+ updateMask: string, Optional. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update. Updates to the `name` and `dataPolicyId` fields are not allowed.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents the label-policy binding.
+ "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+ "predefinedExpression": "A String", # Optional. A predefined masking expression.
+ "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+ },
+ "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+ "dataPolicyType": "A String", # Required. Type of data policy.
+ "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+ "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+ "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+ "version": "A String", # Output only. The version of the Data Policy resource.
+}
+
+
removeGrantees(dataPolicy, body=None, x__xgafv=None)
+
Removes grantees from a data policy. The grantees will be removed from the existing grantees. If the request contains a grantee that does not exist, the grantee will be ignored.
+
+Args:
+ dataPolicy: string, Required. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for the RemoveGrantees method.
+ "grantees": [ # Required. IAM principal that should be revoked from Fine Grained Access to the underlying data goverened by the data policy. The target data policy is determined by the `data_policy` field. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2). Supported principal types: * User * Group * Service account
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents the label-policy binding.
+ "dataMaskingPolicy": { # The policy used to specify data masking rule. # Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.
+ "predefinedExpression": "A String", # Optional. A predefined masking expression.
+ "routine": "A String", # Optional. The name of the BigQuery routine that contains the custom masking routine, in the format of `projects/{project_number}/datasets/{dataset_id}/routines/{routine_id}`.
+ },
+ "dataPolicyId": "A String", # Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.
+ "dataPolicyType": "A String", # Required. Type of data policy.
+ "etag": "A String", # The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.
+ "grantees": [ # Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the [IAM V2 principal syntax](https://cloud.google.com/iam/docs/principal-identifiers#v2) Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
+ "policyTag": "A String", # Output only. Policy tag resource name, in the format of `projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}`. policy_tag is supported only for V1 data policies.
+ "version": "A String", # Output only. The version of the Data Policy resource.
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
+
Sets the IAM policy for the specified data policy.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
testIamPermissions(resource, body=None, x__xgafv=None)
+
Returns the caller's permission on the specified data policy resource.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for `TestIamPermissions` method.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+}
+
Instance Methods
+
+ dataPolicies()
+
+Returns the dataPolicies Resource.
+
+
+ close()
+Close httplib2 connections.
+Method Details
+
+
close()
+
Close httplib2 connections.
+
Method Details
"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features.
"jobType": "A String", # Optional. Which type of jobs will use the reservation.
"name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"state": "A String", # Output only. State of the assignment.
},
],
@@ -213,6 +217,10 @@ Method Details
"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features.
"jobType": "A String", # Optional. Which type of jobs will use the reservation.
"name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"state": "A String", # Output only. State of the assignment.
},
],
diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html
index 5781872d5c4..70343381f8b 100644
--- a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html
+++ b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html
@@ -124,6 +124,10 @@ Method Details
"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features.
"jobType": "A String", # Optional. Which type of jobs will use the reservation.
"name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"state": "A String", # Output only. State of the assignment.
}
@@ -141,6 +145,10 @@ Method Details
"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features.
"jobType": "A String", # Optional. Which type of jobs will use the reservation.
"name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"state": "A String", # Output only. State of the assignment.
}
@@ -234,6 +242,10 @@ Method Details
"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features.
"jobType": "A String", # Optional. Which type of jobs will use the reservation.
"name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"state": "A String", # Output only. State of the assignment.
},
],
@@ -282,6 +294,10 @@ Method Details
"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features.
"jobType": "A String", # Optional. Which type of jobs will use the reservation.
"name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"state": "A String", # Output only. State of the assignment.
}
@@ -300,6 +316,10 @@ Method Details
"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features.
"jobType": "A String", # Optional. Which type of jobs will use the reservation.
"name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"state": "A String", # Output only. State of the assignment.
}
@@ -317,6 +337,10 @@ Method Details
"enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features.
"jobType": "A String", # Optional. Which type of jobs will use the reservation.
"name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"state": "A String", # Output only. State of the assignment.
}
diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html
index 38fe9d256a4..c938890cb7c 100644
--- a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html
+++ b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.html
@@ -160,6 +160,10 @@ Method Details
},
"reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group}
"scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
"slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
"updateTime": "A String", # Output only. Last update time of the reservation.
@@ -207,6 +211,10 @@ Method Details
},
"reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group}
"scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
"slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
"updateTime": "A String", # Output only. Last update time of the reservation.
@@ -285,6 +293,10 @@ Method Details
},
"reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group}
"scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
"slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
"updateTime": "A String", # Output only. Last update time of the reservation.
@@ -338,6 +350,10 @@ Method Details
},
"reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group}
"scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
"slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
"updateTime": "A String", # Output only. Last update time of the reservation.
@@ -444,6 +460,10 @@ Method Details
},
"reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group}
"scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
"slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
"updateTime": "A String", # Output only. Last update time of the reservation.
@@ -508,6 +528,10 @@ Method Details
},
"reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group}
"scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
"slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
"updateTime": "A String", # Output only. Last update time of the reservation.
@@ -555,6 +579,10 @@ Method Details
},
"reservationGroup": "A String", # Optional. The reservation group that this reservation belongs to. You can set this property when you create or update a reservation. Reservations do not need to belong to a reservation group. Format: projects/{project}/locations/{location}/reservationGroups/{reservation_group} or just {reservation_group}
"scalingMode": "A String", # Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
+ "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available.
+ "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.
+ "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.
+ },
"secondaryLocation": "A String", # Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
"slotCapacity": "A String", # Optional. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
"updateTime": "A String", # Output only. Last update time of the reservation.
diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html
index a7c95b11d93..0febadc9089 100644
--- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html
+++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html
@@ -86,6 +86,9 @@ Instance Methods
get(name, x__xgafv=None)
Gets metadata information about the specified schema bundle.
+
+ getIamPolicy(resource, body=None, x__xgafv=None)
+Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.
list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists all schema bundles associated with the specified table.
@@ -95,6 +98,12 @@ Instance Methods
patch(name, body=None, ignoreWarnings=None, updateMask=None, x__xgafv=None)
Updates a schema bundle in the specified table.
+
+ setIamPolicy(resource, body=None, x__xgafv=None)
+Sets the access control policy on a Bigtable resource. Replaces any existing policy.
+
+ testIamPermissions(resource, body=None, x__xgafv=None)
+Returns permissions that the caller has on the specified Bigtable resource.
Method Details
close()
@@ -190,6 +199,62 @@
Method Details
}
+
+
getIamPolicy(resource, body=None, x__xgafv=None)
+
Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `GetIamPolicy` method.
+ "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
+ "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists all schema bundles associated with the specified table.
@@ -288,4 +353,119 @@ Method Details
}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
+
Sets the access control policy on a Bigtable resource. Replaces any existing policy.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
testIamPermissions(resource, body=None, x__xgafv=None)
+
Returns permissions that the caller has on the specified Bigtable resource.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for `TestIamPermissions` method.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+}
+