google-api-python-client 2.156.0__py2.py3-none-any.whl → 2.158.0__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {google_api_python_client-2.156.0.dist-info → google_api_python_client-2.158.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.156.0.dist-info → google_api_python_client-2.158.0.dist-info}/RECORD +62 -61
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +2 -2
- googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json +55 -1
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +2 -2
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +33 -4
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +74 -2
- googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +29 -1
- googleapiclient/discovery_cache/documents/androidenterprise.v1.json +5 -60
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +10 -6
- googleapiclient/discovery_cache/documents/apigee.v1.json +32 -1
- googleapiclient/discovery_cache/documents/areainsights.v1.json +402 -0
- googleapiclient/discovery_cache/documents/bigquery.v2.json +15 -15
- googleapiclient/discovery_cache/documents/chat.v1.json +64 -17
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +151 -2
- googleapiclient/discovery_cache/documents/cloudsupport.v2.json +1 -1
- googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +1 -1
- googleapiclient/discovery_cache/documents/connectors.v1.json +1 -16
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +144 -1
- googleapiclient/discovery_cache/documents/content.v2.1.json +38 -1
- googleapiclient/discovery_cache/documents/css.v1.json +35 -1
- googleapiclient/discovery_cache/documents/datamigration.v1.json +42 -8
- googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +3 -3
- googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +3 -3
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +234 -1
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +183 -2
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +230 -1
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +253 -1
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +1346 -244
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +1609 -140
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +1173 -71
- googleapiclient/discovery_cache/documents/dlp.v2.json +13 -3
- googleapiclient/discovery_cache/documents/firebase.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +42 -1
- googleapiclient/discovery_cache/documents/jobs.v3.json +10 -10
- googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json +10 -10
- googleapiclient/discovery_cache/documents/jobs.v4.json +30 -12
- googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +38 -1
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +34 -2
- googleapiclient/discovery_cache/documents/monitoring.v1.json +35 -1
- googleapiclient/discovery_cache/documents/places.v1.json +2 -2
- googleapiclient/discovery_cache/documents/pubsub.v1.json +2 -2
- googleapiclient/discovery_cache/documents/retail.v2.json +35 -30
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +35 -30
- googleapiclient/discovery_cache/documents/retail.v2beta.json +35 -30
- googleapiclient/discovery_cache/documents/run.v2.json +6 -1
- googleapiclient/discovery_cache/documents/runtimeconfig.v1.json +2 -2
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +5 -1
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +14 -6
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +14 -6
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +1 -2
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +1 -2
- googleapiclient/discovery_cache/documents/testing.v1.json +2 -2
- googleapiclient/discovery_cache/documents/texttospeech.v1.json +5 -3
- googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +5 -3
- googleapiclient/discovery_cache/documents/translate.v3.json +10 -2
- googleapiclient/discovery_cache/documents/translate.v3beta1.json +7 -3
- googleapiclient/discovery_cache/documents/youtube.v3.json +2 -2
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.156.0.dist-info → google_api_python_client-2.158.0.dist-info}/LICENSE +0 -0
- {google_api_python_client-2.156.0.dist-info → google_api_python_client-2.158.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.156.0.dist-info → google_api_python_client-2.158.0.dist-info}/top_level.txt +0 -0
|
@@ -160,6 +160,36 @@
|
|
|
160
160
|
},
|
|
161
161
|
"resources": {
|
|
162
162
|
"locations": {
|
|
163
|
+
"methods": {
|
|
164
|
+
"generateGroundedContent": {
|
|
165
|
+
"description": "Generates grounded content.",
|
|
166
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:generateGroundedContent",
|
|
167
|
+
"httpMethod": "POST",
|
|
168
|
+
"id": "discoveryengine.projects.locations.generateGroundedContent",
|
|
169
|
+
"parameterOrder": [
|
|
170
|
+
"location"
|
|
171
|
+
],
|
|
172
|
+
"parameters": {
|
|
173
|
+
"location": {
|
|
174
|
+
"description": "Required. Location resource. Format: `projects/{project}/locations/{location}`.",
|
|
175
|
+
"location": "path",
|
|
176
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
177
|
+
"required": true,
|
|
178
|
+
"type": "string"
|
|
179
|
+
}
|
|
180
|
+
},
|
|
181
|
+
"path": "v1beta/{+location}:generateGroundedContent",
|
|
182
|
+
"request": {
|
|
183
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest"
|
|
184
|
+
},
|
|
185
|
+
"response": {
|
|
186
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse"
|
|
187
|
+
},
|
|
188
|
+
"scopes": [
|
|
189
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
190
|
+
]
|
|
191
|
+
}
|
|
192
|
+
},
|
|
163
193
|
"resources": {
|
|
164
194
|
"collections": {
|
|
165
195
|
"resources": {
|
|
@@ -7354,7 +7384,7 @@
|
|
|
7354
7384
|
}
|
|
7355
7385
|
}
|
|
7356
7386
|
},
|
|
7357
|
-
"revision": "
|
|
7387
|
+
"revision": "20241216",
|
|
7358
7388
|
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
7359
7389
|
"schemas": {
|
|
7360
7390
|
"GoogleApiDistribution": {
|
|
@@ -7793,6 +7823,13 @@
|
|
|
7793
7823
|
"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
7794
7824
|
"type": "string"
|
|
7795
7825
|
},
|
|
7826
|
+
"singleRegionKeys": {
|
|
7827
|
+
"description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
|
|
7828
|
+
"items": {
|
|
7829
|
+
"$ref": "GoogleCloudDiscoveryengineV1SingleRegionKey"
|
|
7830
|
+
},
|
|
7831
|
+
"type": "array"
|
|
7832
|
+
},
|
|
7796
7833
|
"state": {
|
|
7797
7834
|
"description": "Output only. State of the CmekConfig.",
|
|
7798
7835
|
"enum": [
|
|
@@ -8175,6 +8212,10 @@
|
|
|
8175
8212
|
],
|
|
8176
8213
|
"type": "string"
|
|
8177
8214
|
},
|
|
8215
|
+
"isInfobotFaqDataStore": {
|
|
8216
|
+
"description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.",
|
|
8217
|
+
"type": "boolean"
|
|
8218
|
+
},
|
|
8178
8219
|
"kmsKeyName": {
|
|
8179
8220
|
"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.",
|
|
8180
8221
|
"type": "string"
|
|
@@ -9469,6 +9510,17 @@
|
|
|
9469
9510
|
},
|
|
9470
9511
|
"type": "object"
|
|
9471
9512
|
},
|
|
9513
|
+
"GoogleCloudDiscoveryengineV1SingleRegionKey": {
|
|
9514
|
+
"description": "Metadata for single-regional CMEKs.",
|
|
9515
|
+
"id": "GoogleCloudDiscoveryengineV1SingleRegionKey",
|
|
9516
|
+
"properties": {
|
|
9517
|
+
"kmsKey": {
|
|
9518
|
+
"description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
|
|
9519
|
+
"type": "string"
|
|
9520
|
+
}
|
|
9521
|
+
},
|
|
9522
|
+
"type": "object"
|
|
9523
|
+
},
|
|
9472
9524
|
"GoogleCloudDiscoveryengineV1SiteVerificationInfo": {
|
|
9473
9525
|
"description": "Verification information for target sites in advanced site search.",
|
|
9474
9526
|
"id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo",
|
|
@@ -9759,6 +9811,26 @@
|
|
|
9759
9811
|
},
|
|
9760
9812
|
"type": "object"
|
|
9761
9813
|
},
|
|
9814
|
+
"GoogleCloudDiscoveryengineV1alphaActionConfig": {
|
|
9815
|
+
"description": "Informations to support actions on the connector.",
|
|
9816
|
+
"id": "GoogleCloudDiscoveryengineV1alphaActionConfig",
|
|
9817
|
+
"properties": {
|
|
9818
|
+
"actionParams": {
|
|
9819
|
+
"additionalProperties": {
|
|
9820
|
+
"description": "Properties of the object.",
|
|
9821
|
+
"type": "any"
|
|
9822
|
+
},
|
|
9823
|
+
"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.",
|
|
9824
|
+
"type": "object"
|
|
9825
|
+
},
|
|
9826
|
+
"isActionConfigured": {
|
|
9827
|
+
"description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
|
|
9828
|
+
"readOnly": true,
|
|
9829
|
+
"type": "boolean"
|
|
9830
|
+
}
|
|
9831
|
+
},
|
|
9832
|
+
"type": "object"
|
|
9833
|
+
},
|
|
9762
9834
|
"GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig": {
|
|
9763
9835
|
"description": "Configuration data for advance site search.",
|
|
9764
9836
|
"id": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig",
|
|
@@ -10363,6 +10435,13 @@
|
|
|
10363
10435
|
"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
10364
10436
|
"type": "string"
|
|
10365
10437
|
},
|
|
10438
|
+
"singleRegionKeys": {
|
|
10439
|
+
"description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
|
|
10440
|
+
"items": {
|
|
10441
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey"
|
|
10442
|
+
},
|
|
10443
|
+
"type": "array"
|
|
10444
|
+
},
|
|
10366
10445
|
"state": {
|
|
10367
10446
|
"description": "Output only. State of the CmekConfig.",
|
|
10368
10447
|
"enum": [
|
|
@@ -10389,6 +10468,32 @@
|
|
|
10389
10468
|
},
|
|
10390
10469
|
"type": "object"
|
|
10391
10470
|
},
|
|
10471
|
+
"GoogleCloudDiscoveryengineV1alphaCollection": {
|
|
10472
|
+
"description": "Collection is a container for configuring resources and access to a set of DataStores.",
|
|
10473
|
+
"id": "GoogleCloudDiscoveryengineV1alphaCollection",
|
|
10474
|
+
"properties": {
|
|
10475
|
+
"createTime": {
|
|
10476
|
+
"description": "Output only. Timestamp the Collection was created at.",
|
|
10477
|
+
"format": "google-datetime",
|
|
10478
|
+
"readOnly": true,
|
|
10479
|
+
"type": "string"
|
|
10480
|
+
},
|
|
10481
|
+
"dataConnector": {
|
|
10482
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector",
|
|
10483
|
+
"description": "Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnector.GetDataConnector method.",
|
|
10484
|
+
"readOnly": true
|
|
10485
|
+
},
|
|
10486
|
+
"displayName": {
|
|
10487
|
+
"description": "Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
|
|
10488
|
+
"type": "string"
|
|
10489
|
+
},
|
|
10490
|
+
"name": {
|
|
10491
|
+
"description": "Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
10492
|
+
"type": "string"
|
|
10493
|
+
}
|
|
10494
|
+
},
|
|
10495
|
+
"type": "object"
|
|
10496
|
+
},
|
|
10392
10497
|
"GoogleCloudDiscoveryengineV1alphaCondition": {
|
|
10393
10498
|
"description": "Defines circumstances to be checked before allowing a behavior",
|
|
10394
10499
|
"id": "GoogleCloudDiscoveryengineV1alphaCondition",
|
|
@@ -10446,6 +10551,186 @@
|
|
|
10446
10551
|
},
|
|
10447
10552
|
"type": "object"
|
|
10448
10553
|
},
|
|
10554
|
+
"GoogleCloudDiscoveryengineV1alphaConnectorRun": {
|
|
10555
|
+
"description": "A data sync run of DataConnector. After DataConnector is successfully initialized, data syncs are scheduled at DataConnector.refresh_interval. A ConnectorRun represents a data sync either in the past or onging that the moment. //",
|
|
10556
|
+
"id": "GoogleCloudDiscoveryengineV1alphaConnectorRun",
|
|
10557
|
+
"properties": {
|
|
10558
|
+
"endTime": {
|
|
10559
|
+
"description": "Output only. The time when the connector run ended.",
|
|
10560
|
+
"format": "google-datetime",
|
|
10561
|
+
"readOnly": true,
|
|
10562
|
+
"type": "string"
|
|
10563
|
+
},
|
|
10564
|
+
"entityRuns": {
|
|
10565
|
+
"description": "Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities.",
|
|
10566
|
+
"items": {
|
|
10567
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun"
|
|
10568
|
+
},
|
|
10569
|
+
"readOnly": true,
|
|
10570
|
+
"type": "array"
|
|
10571
|
+
},
|
|
10572
|
+
"errors": {
|
|
10573
|
+
"description": "Contains info about errors incurred during the sync. Only exist if running into an error state. Contains error code and error message. Use with the `state` field.",
|
|
10574
|
+
"items": {
|
|
10575
|
+
"$ref": "GoogleRpcStatus"
|
|
10576
|
+
},
|
|
10577
|
+
"type": "array"
|
|
10578
|
+
},
|
|
10579
|
+
"latestPauseTime": {
|
|
10580
|
+
"description": "Output only. The time when the connector run was most recently paused.",
|
|
10581
|
+
"format": "google-datetime",
|
|
10582
|
+
"readOnly": true,
|
|
10583
|
+
"type": "string"
|
|
10584
|
+
},
|
|
10585
|
+
"name": {
|
|
10586
|
+
"description": "Output only. The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.",
|
|
10587
|
+
"readOnly": true,
|
|
10588
|
+
"type": "string"
|
|
10589
|
+
},
|
|
10590
|
+
"startTime": {
|
|
10591
|
+
"description": "Output only. The time when the connector run started.",
|
|
10592
|
+
"format": "google-datetime",
|
|
10593
|
+
"readOnly": true,
|
|
10594
|
+
"type": "string"
|
|
10595
|
+
},
|
|
10596
|
+
"state": {
|
|
10597
|
+
"description": "Output only. The state of the sync run.",
|
|
10598
|
+
"enum": [
|
|
10599
|
+
"STATE_UNSPECIFIED",
|
|
10600
|
+
"RUNNING",
|
|
10601
|
+
"SUCCEEDED",
|
|
10602
|
+
"FAILED",
|
|
10603
|
+
"OVERRUN",
|
|
10604
|
+
"CANCELLED",
|
|
10605
|
+
"PENDING",
|
|
10606
|
+
"WARNING"
|
|
10607
|
+
],
|
|
10608
|
+
"enumDescriptions": [
|
|
10609
|
+
"Default value.",
|
|
10610
|
+
"The data sync is ongoing.",
|
|
10611
|
+
"The data sync is finished.",
|
|
10612
|
+
"The data sync is failed.",
|
|
10613
|
+
"Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
|
|
10614
|
+
"Data sync was scheduled but has been cancelled.",
|
|
10615
|
+
"Data sync is about to start.",
|
|
10616
|
+
"The data sync completed with non-fatal errors."
|
|
10617
|
+
],
|
|
10618
|
+
"readOnly": true,
|
|
10619
|
+
"type": "string"
|
|
10620
|
+
},
|
|
10621
|
+
"stateUpdateTime": {
|
|
10622
|
+
"description": "Timestamp at which the connector run sync state was last updated.",
|
|
10623
|
+
"format": "google-datetime",
|
|
10624
|
+
"type": "string"
|
|
10625
|
+
},
|
|
10626
|
+
"trigger": {
|
|
10627
|
+
"description": "Output only. The trigger for this ConnectorRun.",
|
|
10628
|
+
"enum": [
|
|
10629
|
+
"TRIGGER_UNSPECIFIED",
|
|
10630
|
+
"SCHEDULER",
|
|
10631
|
+
"INITIALIZATION",
|
|
10632
|
+
"RESUME",
|
|
10633
|
+
"MANUAL"
|
|
10634
|
+
],
|
|
10635
|
+
"enumDescriptions": [
|
|
10636
|
+
"Default value.",
|
|
10637
|
+
"ConnectorRun triggered by scheduler if connector has PERIODIC sync mode.",
|
|
10638
|
+
"ConnectorRun auto triggered by connector initialization.",
|
|
10639
|
+
"ConnectorRun auto triggered by resuming connector.",
|
|
10640
|
+
"ConnectorRun triggered by user manually."
|
|
10641
|
+
],
|
|
10642
|
+
"readOnly": true,
|
|
10643
|
+
"type": "string"
|
|
10644
|
+
}
|
|
10645
|
+
},
|
|
10646
|
+
"type": "object"
|
|
10647
|
+
},
|
|
10648
|
+
"GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun": {
|
|
10649
|
+
"description": "Represents an entity that was synced in this ConnectorRun.",
|
|
10650
|
+
"id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun",
|
|
10651
|
+
"properties": {
|
|
10652
|
+
"entityName": {
|
|
10653
|
+
"description": "The name of the source entity.",
|
|
10654
|
+
"type": "string"
|
|
10655
|
+
},
|
|
10656
|
+
"errorRecordCount": {
|
|
10657
|
+
"description": "The total number of documents failed at sync at any stage (extraction, indexing, etc).",
|
|
10658
|
+
"format": "int64",
|
|
10659
|
+
"type": "string"
|
|
10660
|
+
},
|
|
10661
|
+
"errors": {
|
|
10662
|
+
"description": "The errors from the entity's sync run. Only exist if running into an error state. Contains error code and error message.",
|
|
10663
|
+
"items": {
|
|
10664
|
+
"$ref": "GoogleRpcStatus"
|
|
10665
|
+
},
|
|
10666
|
+
"type": "array"
|
|
10667
|
+
},
|
|
10668
|
+
"extractedRecordCount": {
|
|
10669
|
+
"description": "The number of documents extracted from connector source, ready to be ingested to UCS.",
|
|
10670
|
+
"format": "int64",
|
|
10671
|
+
"type": "string"
|
|
10672
|
+
},
|
|
10673
|
+
"indexedRecordCount": {
|
|
10674
|
+
"description": "The number of documents indexed.",
|
|
10675
|
+
"format": "int64",
|
|
10676
|
+
"type": "string"
|
|
10677
|
+
},
|
|
10678
|
+
"sourceApiRequestCount": {
|
|
10679
|
+
"description": "The number of requests sent to 3p API.",
|
|
10680
|
+
"format": "int64",
|
|
10681
|
+
"type": "string"
|
|
10682
|
+
},
|
|
10683
|
+
"state": {
|
|
10684
|
+
"description": "The state of the entity's sync run.",
|
|
10685
|
+
"enum": [
|
|
10686
|
+
"STATE_UNSPECIFIED",
|
|
10687
|
+
"RUNNING",
|
|
10688
|
+
"SUCCEEDED",
|
|
10689
|
+
"FAILED",
|
|
10690
|
+
"OVERRUN",
|
|
10691
|
+
"CANCELLED",
|
|
10692
|
+
"PENDING",
|
|
10693
|
+
"WARNING"
|
|
10694
|
+
],
|
|
10695
|
+
"enumDescriptions": [
|
|
10696
|
+
"Default value.",
|
|
10697
|
+
"The data sync is ongoing.",
|
|
10698
|
+
"The data sync is finished.",
|
|
10699
|
+
"The data sync is failed.",
|
|
10700
|
+
"Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
|
|
10701
|
+
"Data sync was scheduled but has been cancelled.",
|
|
10702
|
+
"Data sync is about to start.",
|
|
10703
|
+
"The data sync completed with non-fatal errors."
|
|
10704
|
+
],
|
|
10705
|
+
"type": "string"
|
|
10706
|
+
},
|
|
10707
|
+
"stateUpdateTime": {
|
|
10708
|
+
"description": "Timestamp at which the entity sync state was last updated.",
|
|
10709
|
+
"format": "google-datetime",
|
|
10710
|
+
"type": "string"
|
|
10711
|
+
},
|
|
10712
|
+
"statsUpdateTime": {
|
|
10713
|
+
"description": "The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated.",
|
|
10714
|
+
"format": "google-datetime",
|
|
10715
|
+
"type": "string"
|
|
10716
|
+
},
|
|
10717
|
+
"syncType": {
|
|
10718
|
+
"description": "Sync type of this run.",
|
|
10719
|
+
"enum": [
|
|
10720
|
+
"SYNC_TYPE_UNSPECIFIED",
|
|
10721
|
+
"FULL",
|
|
10722
|
+
"INCREMENTAL"
|
|
10723
|
+
],
|
|
10724
|
+
"enumDescriptions": [
|
|
10725
|
+
"Sync type unspecified.",
|
|
10726
|
+
"Sync triggers full sync of all documents.",
|
|
10727
|
+
"Incremental sync of updated documents."
|
|
10728
|
+
],
|
|
10729
|
+
"type": "string"
|
|
10730
|
+
}
|
|
10731
|
+
},
|
|
10732
|
+
"type": "object"
|
|
10733
|
+
},
|
|
10449
10734
|
"GoogleCloudDiscoveryengineV1alphaControl": {
|
|
10450
10735
|
"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.",
|
|
10451
10736
|
"id": "GoogleCloudDiscoveryengineV1alphaControl",
|
|
@@ -10719,96 +11004,298 @@
|
|
|
10719
11004
|
},
|
|
10720
11005
|
"type": "object"
|
|
10721
11006
|
},
|
|
10722
|
-
"
|
|
10723
|
-
"description": "
|
|
10724
|
-
"id": "
|
|
11007
|
+
"GoogleCloudDiscoveryengineV1alphaDataConnector": {
|
|
11008
|
+
"description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. //",
|
|
11009
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDataConnector",
|
|
10725
11010
|
"properties": {
|
|
10726
|
-
"
|
|
10727
|
-
"
|
|
10728
|
-
"
|
|
10729
|
-
},
|
|
10730
|
-
"advancedSiteSearchConfig": {
|
|
10731
|
-
"$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig",
|
|
10732
|
-
"description": "Optional. Configuration for advanced site search."
|
|
11011
|
+
"actionConfig": {
|
|
11012
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig",
|
|
11013
|
+
"description": "Optional. Action configurations to make the connector support actions."
|
|
10733
11014
|
},
|
|
10734
|
-
"
|
|
10735
|
-
"
|
|
10736
|
-
"
|
|
10737
|
-
"readOnly": true
|
|
10738
|
-
},
|
|
10739
|
-
"cmekConfig": {
|
|
10740
|
-
"$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig",
|
|
10741
|
-
"description": "Output only. CMEK-related information for the DataStore.",
|
|
10742
|
-
"readOnly": true
|
|
11015
|
+
"autoRunDisabled": {
|
|
11016
|
+
"description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.",
|
|
11017
|
+
"type": "boolean"
|
|
10743
11018
|
},
|
|
10744
|
-
"
|
|
10745
|
-
"description": "
|
|
11019
|
+
"blockingReasons": {
|
|
11020
|
+
"description": "Output only. User actions that must be completed before the connector can start syncing data.",
|
|
11021
|
+
"items": {
|
|
10746
11022
|
"enum": [
|
|
10747
|
-
"
|
|
10748
|
-
"
|
|
10749
|
-
"
|
|
10750
|
-
"PUBLIC_WEBSITE",
|
|
10751
|
-
"GOOGLE_WORKSPACE"
|
|
11023
|
+
"BLOCKING_REASON_UNSPECIFIED",
|
|
11024
|
+
"ALLOWLIST_STATIC_IP",
|
|
11025
|
+
"ALLOWLIST_IN_SERVICE_ATTACHMENT"
|
|
10752
11026
|
],
|
|
10753
11027
|
"enumDescriptions": [
|
|
10754
11028
|
"Default value.",
|
|
10755
|
-
"
|
|
10756
|
-
"
|
|
10757
|
-
"The data store is used for public website search.",
|
|
10758
|
-
"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig."
|
|
11029
|
+
"Connector requires customer to allowlist static IPs.",
|
|
11030
|
+
"Connector requires customer to allowlist our project in their service attachment."
|
|
10759
11031
|
],
|
|
10760
11032
|
"type": "string"
|
|
10761
11033
|
},
|
|
11034
|
+
"readOnly": true,
|
|
11035
|
+
"type": "array"
|
|
11036
|
+
},
|
|
10762
11037
|
"createTime": {
|
|
10763
|
-
"description": "Output only. Timestamp the
|
|
11038
|
+
"description": "Output only. Timestamp the DataConnector was created at.",
|
|
10764
11039
|
"format": "google-datetime",
|
|
10765
11040
|
"readOnly": true,
|
|
10766
11041
|
"type": "string"
|
|
10767
11042
|
},
|
|
10768
|
-
"
|
|
10769
|
-
"description": "
|
|
10770
|
-
"readOnly": true,
|
|
11043
|
+
"dataSource": {
|
|
11044
|
+
"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.",
|
|
10771
11045
|
"type": "string"
|
|
10772
11046
|
},
|
|
10773
|
-
"
|
|
10774
|
-
"description": "
|
|
10775
|
-
"
|
|
11047
|
+
"destinationConfigs": {
|
|
11048
|
+
"description": "Optional. Any target destinations used to connect to third-party services.",
|
|
11049
|
+
"items": {
|
|
11050
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfig"
|
|
10776
11051
|
},
|
|
10777
|
-
"
|
|
10778
|
-
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig",
|
|
10779
|
-
"description": "Configuration for Document understanding and enrichment."
|
|
11052
|
+
"type": "array"
|
|
10780
11053
|
},
|
|
10781
|
-
"
|
|
10782
|
-
"
|
|
10783
|
-
"
|
|
10784
|
-
"
|
|
11054
|
+
"entities": {
|
|
11055
|
+
"description": "List of entities from the connected data source to ingest.",
|
|
11056
|
+
"items": {
|
|
11057
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity"
|
|
10785
11058
|
},
|
|
10786
|
-
"
|
|
10787
|
-
"description": "Immutable. The industry vertical that the data store registers.",
|
|
10788
|
-
"enum": [
|
|
10789
|
-
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
10790
|
-
"GENERIC",
|
|
10791
|
-
"MEDIA",
|
|
10792
|
-
"HEALTHCARE_FHIR"
|
|
10793
|
-
],
|
|
10794
|
-
"enumDescriptions": [
|
|
10795
|
-
"Value used when unset.",
|
|
10796
|
-
"The generic vertical for documents that are not specific to any industry vertical.",
|
|
10797
|
-
"The media industry vertical.",
|
|
10798
|
-
"The healthcare FHIR vertical."
|
|
10799
|
-
],
|
|
10800
|
-
"type": "string"
|
|
11059
|
+
"type": "array"
|
|
10801
11060
|
},
|
|
10802
|
-
"
|
|
10803
|
-
"description": "
|
|
10804
|
-
"
|
|
11061
|
+
"errors": {
|
|
11062
|
+
"description": "Output only. The errors from initialization or from the latest connector run.",
|
|
11063
|
+
"items": {
|
|
11064
|
+
"$ref": "GoogleRpcStatus"
|
|
10805
11065
|
},
|
|
10806
|
-
"
|
|
10807
|
-
"
|
|
10808
|
-
"description": "Language info for DataStore."
|
|
11066
|
+
"readOnly": true,
|
|
11067
|
+
"type": "array"
|
|
10809
11068
|
},
|
|
10810
|
-
"
|
|
10811
|
-
"
|
|
11069
|
+
"identityRefreshInterval": {
|
|
11070
|
+
"deprecated": true,
|
|
11071
|
+
"description": "The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.",
|
|
11072
|
+
"format": "google-duration",
|
|
11073
|
+
"type": "string"
|
|
11074
|
+
},
|
|
11075
|
+
"identityScheduleConfig": {
|
|
11076
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig",
|
|
11077
|
+
"description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector."
|
|
11078
|
+
},
|
|
11079
|
+
"kmsKeyName": {
|
|
11080
|
+
"description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.",
|
|
11081
|
+
"type": "string"
|
|
11082
|
+
},
|
|
11083
|
+
"lastSyncTime": {
|
|
11084
|
+
"description": "Output only. For periodic connectors only, the last time a data sync was completed.",
|
|
11085
|
+
"format": "google-datetime",
|
|
11086
|
+
"readOnly": true,
|
|
11087
|
+
"type": "string"
|
|
11088
|
+
},
|
|
11089
|
+
"latestPauseTime": {
|
|
11090
|
+
"description": "Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.",
|
|
11091
|
+
"format": "google-datetime",
|
|
11092
|
+
"readOnly": true,
|
|
11093
|
+
"type": "string"
|
|
11094
|
+
},
|
|
11095
|
+
"name": {
|
|
11096
|
+
"description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.",
|
|
11097
|
+
"readOnly": true,
|
|
11098
|
+
"type": "string"
|
|
11099
|
+
},
|
|
11100
|
+
"nextSyncTime": {
|
|
11101
|
+
"$ref": "GoogleTypeDateTime",
|
|
11102
|
+
"description": "The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day."
|
|
11103
|
+
},
|
|
11104
|
+
"params": {
|
|
11105
|
+
"additionalProperties": {
|
|
11106
|
+
"description": "Properties of the object.",
|
|
11107
|
+
"type": "any"
|
|
11108
|
+
},
|
|
11109
|
+
"description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.",
|
|
11110
|
+
"type": "object"
|
|
11111
|
+
},
|
|
11112
|
+
"privateConnectivityProjectId": {
|
|
11113
|
+
"description": "Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.",
|
|
11114
|
+
"readOnly": true,
|
|
11115
|
+
"type": "string"
|
|
11116
|
+
},
|
|
11117
|
+
"refreshInterval": {
|
|
11118
|
+
"description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days.",
|
|
11119
|
+
"format": "google-duration",
|
|
11120
|
+
"type": "string"
|
|
11121
|
+
},
|
|
11122
|
+
"state": {
|
|
11123
|
+
"description": "Output only. State of the connector.",
|
|
11124
|
+
"enum": [
|
|
11125
|
+
"STATE_UNSPECIFIED",
|
|
11126
|
+
"CREATING",
|
|
11127
|
+
"ACTIVE",
|
|
11128
|
+
"FAILED",
|
|
11129
|
+
"RUNNING",
|
|
11130
|
+
"WARNING"
|
|
11131
|
+
],
|
|
11132
|
+
"enumDescriptions": [
|
|
11133
|
+
"Default value.",
|
|
11134
|
+
"The connector is being set up.",
|
|
11135
|
+
"The connector is successfully set up and awaiting next sync run.",
|
|
11136
|
+
"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
|
|
11137
|
+
"The connector is actively syncing records from the data source.",
|
|
11138
|
+
"The connector has completed a sync run, but encountered non-fatal errors."
|
|
11139
|
+
],
|
|
11140
|
+
"readOnly": true,
|
|
11141
|
+
"type": "string"
|
|
11142
|
+
},
|
|
11143
|
+
"staticIpAddresses": {
|
|
11144
|
+
"description": "Output only. The static IP addresses used by this connector.",
|
|
11145
|
+
"items": {
|
|
11146
|
+
"type": "string"
|
|
11147
|
+
},
|
|
11148
|
+
"readOnly": true,
|
|
11149
|
+
"type": "array"
|
|
11150
|
+
},
|
|
11151
|
+
"staticIpEnabled": {
|
|
11152
|
+
"description": "Optional. Whether customer has enabled static IP addresses for this connector.",
|
|
11153
|
+
"type": "boolean"
|
|
11154
|
+
},
|
|
11155
|
+
"syncMode": {
|
|
11156
|
+
"description": "The data synchronization mode supported by the data connector.",
|
|
11157
|
+
"enum": [
|
|
11158
|
+
"PERIODIC"
|
|
11159
|
+
],
|
|
11160
|
+
"enumDescriptions": [
|
|
11161
|
+
"The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync."
|
|
11162
|
+
],
|
|
11163
|
+
"type": "string"
|
|
11164
|
+
},
|
|
11165
|
+
"updateTime": {
|
|
11166
|
+
"description": "Output only. Timestamp the DataConnector was last updated.",
|
|
11167
|
+
"format": "google-datetime",
|
|
11168
|
+
"readOnly": true,
|
|
11169
|
+
"type": "string"
|
|
11170
|
+
}
|
|
11171
|
+
},
|
|
11172
|
+
"type": "object"
|
|
11173
|
+
},
|
|
11174
|
+
"GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity": {
|
|
11175
|
+
"description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.",
|
|
11176
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity",
|
|
11177
|
+
"properties": {
|
|
11178
|
+
"dataStore": {
|
|
11179
|
+
"description": "Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.",
|
|
11180
|
+
"readOnly": true,
|
|
11181
|
+
"type": "string"
|
|
11182
|
+
},
|
|
11183
|
+
"entityName": {
|
|
11184
|
+
"description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`",
|
|
11185
|
+
"type": "string"
|
|
11186
|
+
},
|
|
11187
|
+
"keyPropertyMappings": {
|
|
11188
|
+
"additionalProperties": {
|
|
11189
|
+
"type": "string"
|
|
11190
|
+
},
|
|
11191
|
+
"description": "Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.",
|
|
11192
|
+
"type": "object"
|
|
11193
|
+
},
|
|
11194
|
+
"params": {
|
|
11195
|
+
"additionalProperties": {
|
|
11196
|
+
"description": "Properties of the object.",
|
|
11197
|
+
"type": "any"
|
|
11198
|
+
},
|
|
11199
|
+
"description": "The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id.",
|
|
11200
|
+
"type": "object"
|
|
11201
|
+
}
|
|
11202
|
+
},
|
|
11203
|
+
"type": "object"
|
|
11204
|
+
},
|
|
11205
|
+
"GoogleCloudDiscoveryengineV1alphaDataStore": {
|
|
11206
|
+
"description": "DataStore captures global settings and configs at the DataStore level.",
|
|
11207
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDataStore",
|
|
11208
|
+
"properties": {
|
|
11209
|
+
"aclEnabled": {
|
|
11210
|
+
"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.",
|
|
11211
|
+
"type": "boolean"
|
|
11212
|
+
},
|
|
11213
|
+
"advancedSiteSearchConfig": {
|
|
11214
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig",
|
|
11215
|
+
"description": "Optional. Configuration for advanced site search."
|
|
11216
|
+
},
|
|
11217
|
+
"billingEstimation": {
|
|
11218
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation",
|
|
11219
|
+
"description": "Output only. Data size estimation for billing.",
|
|
11220
|
+
"readOnly": true
|
|
11221
|
+
},
|
|
11222
|
+
"cmekConfig": {
|
|
11223
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig",
|
|
11224
|
+
"description": "Output only. CMEK-related information for the DataStore.",
|
|
11225
|
+
"readOnly": true
|
|
11226
|
+
},
|
|
11227
|
+
"contentConfig": {
|
|
11228
|
+
"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.",
|
|
11229
|
+
"enum": [
|
|
11230
|
+
"CONTENT_CONFIG_UNSPECIFIED",
|
|
11231
|
+
"NO_CONTENT",
|
|
11232
|
+
"CONTENT_REQUIRED",
|
|
11233
|
+
"PUBLIC_WEBSITE",
|
|
11234
|
+
"GOOGLE_WORKSPACE"
|
|
11235
|
+
],
|
|
11236
|
+
"enumDescriptions": [
|
|
11237
|
+
"Default value.",
|
|
11238
|
+
"Only contains documents without any Document.content.",
|
|
11239
|
+
"Only contains documents with Document.content.",
|
|
11240
|
+
"The data store is used for public website search.",
|
|
11241
|
+
"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig."
|
|
11242
|
+
],
|
|
11243
|
+
"type": "string"
|
|
11244
|
+
},
|
|
11245
|
+
"createTime": {
|
|
11246
|
+
"description": "Output only. Timestamp the DataStore was created at.",
|
|
11247
|
+
"format": "google-datetime",
|
|
11248
|
+
"readOnly": true,
|
|
11249
|
+
"type": "string"
|
|
11250
|
+
},
|
|
11251
|
+
"defaultSchemaId": {
|
|
11252
|
+
"description": "Output only. The id of the default Schema asscociated to this data store.",
|
|
11253
|
+
"readOnly": true,
|
|
11254
|
+
"type": "string"
|
|
11255
|
+
},
|
|
11256
|
+
"displayName": {
|
|
11257
|
+
"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
|
|
11258
|
+
"type": "string"
|
|
11259
|
+
},
|
|
11260
|
+
"documentProcessingConfig": {
|
|
11261
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig",
|
|
11262
|
+
"description": "Configuration for Document understanding and enrichment."
|
|
11263
|
+
},
|
|
11264
|
+
"idpConfig": {
|
|
11265
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig",
|
|
11266
|
+
"description": "Output only. Data store level identity provider config.",
|
|
11267
|
+
"readOnly": true
|
|
11268
|
+
},
|
|
11269
|
+
"industryVertical": {
|
|
11270
|
+
"description": "Immutable. The industry vertical that the data store registers.",
|
|
11271
|
+
"enum": [
|
|
11272
|
+
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
11273
|
+
"GENERIC",
|
|
11274
|
+
"MEDIA",
|
|
11275
|
+
"HEALTHCARE_FHIR"
|
|
11276
|
+
],
|
|
11277
|
+
"enumDescriptions": [
|
|
11278
|
+
"Value used when unset.",
|
|
11279
|
+
"The generic vertical for documents that are not specific to any industry vertical.",
|
|
11280
|
+
"The media industry vertical.",
|
|
11281
|
+
"The healthcare FHIR vertical."
|
|
11282
|
+
],
|
|
11283
|
+
"type": "string"
|
|
11284
|
+
},
|
|
11285
|
+
"isInfobotFaqDataStore": {
|
|
11286
|
+
"description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.",
|
|
11287
|
+
"type": "boolean"
|
|
11288
|
+
},
|
|
11289
|
+
"kmsKeyName": {
|
|
11290
|
+
"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.",
|
|
11291
|
+
"type": "string"
|
|
11292
|
+
},
|
|
11293
|
+
"languageInfo": {
|
|
11294
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo",
|
|
11295
|
+
"description": "Language info for DataStore."
|
|
11296
|
+
},
|
|
11297
|
+
"name": {
|
|
11298
|
+
"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
10812
11299
|
"type": "string"
|
|
10813
11300
|
},
|
|
10814
11301
|
"naturalLanguageQueryUnderstandingConfig": {
|
|
@@ -10914,6 +11401,23 @@
|
|
|
10914
11401
|
},
|
|
10915
11402
|
"type": "object"
|
|
10916
11403
|
},
|
|
11404
|
+
"GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata": {
|
|
11405
|
+
"description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
11406
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata",
|
|
11407
|
+
"properties": {
|
|
11408
|
+
"createTime": {
|
|
11409
|
+
"description": "Operation create time.",
|
|
11410
|
+
"format": "google-datetime",
|
|
11411
|
+
"type": "string"
|
|
11412
|
+
},
|
|
11413
|
+
"updateTime": {
|
|
11414
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
11415
|
+
"format": "google-datetime",
|
|
11416
|
+
"type": "string"
|
|
11417
|
+
}
|
|
11418
|
+
},
|
|
11419
|
+
"type": "object"
|
|
11420
|
+
},
|
|
10917
11421
|
"GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": {
|
|
10918
11422
|
"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
10919
11423
|
"id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata",
|
|
@@ -11010,6 +11514,48 @@
|
|
|
11010
11514
|
},
|
|
11011
11515
|
"type": "object"
|
|
11012
11516
|
},
|
|
11517
|
+
"GoogleCloudDiscoveryengineV1alphaDestinationConfig": {
|
|
11518
|
+
"description": "Defines target endpoints used to connect to third-party sources.",
|
|
11519
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig",
|
|
11520
|
+
"properties": {
|
|
11521
|
+
"destinations": {
|
|
11522
|
+
"description": "Optional. The destinations for the corresponding key.",
|
|
11523
|
+
"items": {
|
|
11524
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination"
|
|
11525
|
+
},
|
|
11526
|
+
"type": "array"
|
|
11527
|
+
},
|
|
11528
|
+
"key": {
|
|
11529
|
+
"description": "Optional. Unique destination identifier that is supported by the connector.",
|
|
11530
|
+
"type": "string"
|
|
11531
|
+
},
|
|
11532
|
+
"params": {
|
|
11533
|
+
"additionalProperties": {
|
|
11534
|
+
"description": "Properties of the object.",
|
|
11535
|
+
"type": "any"
|
|
11536
|
+
},
|
|
11537
|
+
"description": "Optional. Additional parameters for this destination config.",
|
|
11538
|
+
"type": "object"
|
|
11539
|
+
}
|
|
11540
|
+
},
|
|
11541
|
+
"type": "object"
|
|
11542
|
+
},
|
|
11543
|
+
"GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination": {
|
|
11544
|
+
"description": "Defines a target endpoint",
|
|
11545
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination",
|
|
11546
|
+
"properties": {
|
|
11547
|
+
"host": {
|
|
11548
|
+
"description": "Publicly routable host.",
|
|
11549
|
+
"type": "string"
|
|
11550
|
+
},
|
|
11551
|
+
"port": {
|
|
11552
|
+
"description": "Optional. Target port number accepted by the destination.",
|
|
11553
|
+
"format": "int32",
|
|
11554
|
+
"type": "integer"
|
|
11555
|
+
}
|
|
11556
|
+
},
|
|
11557
|
+
"type": "object"
|
|
11558
|
+
},
|
|
11013
11559
|
"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": {
|
|
11014
11560
|
"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
11015
11561
|
"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata",
|
|
@@ -11796,6 +12342,18 @@
|
|
|
11796
12342
|
},
|
|
11797
12343
|
"type": "object"
|
|
11798
12344
|
},
|
|
12345
|
+
"GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig": {
|
|
12346
|
+
"description": "The configuration for the identity data synchronization runs.",
|
|
12347
|
+
"id": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig",
|
|
12348
|
+
"properties": {
|
|
12349
|
+
"refreshInterval": {
|
|
12350
|
+
"description": "Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.",
|
|
12351
|
+
"format": "google-duration",
|
|
12352
|
+
"type": "string"
|
|
12353
|
+
}
|
|
12354
|
+
},
|
|
12355
|
+
"type": "object"
|
|
12356
|
+
},
|
|
11799
12357
|
"GoogleCloudDiscoveryengineV1alphaIdpConfig": {
|
|
11800
12358
|
"description": "Identity Provider Config.",
|
|
11801
12359
|
"id": "GoogleCloudDiscoveryengineV1alphaIdpConfig",
|
|
@@ -13527,6 +14085,12 @@
|
|
|
13527
14085
|
},
|
|
13528
14086
|
"type": "object"
|
|
13529
14087
|
},
|
|
14088
|
+
"GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata": {
|
|
14089
|
+
"description": "Metadata for DataConnectorService.SetUpDataConnector method.",
|
|
14090
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata",
|
|
14091
|
+
"properties": {},
|
|
14092
|
+
"type": "object"
|
|
14093
|
+
},
|
|
13530
14094
|
"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": {
|
|
13531
14095
|
"description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
13532
14096
|
"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata",
|
|
@@ -13550,6 +14114,17 @@
|
|
|
13550
14114
|
"properties": {},
|
|
13551
14115
|
"type": "object"
|
|
13552
14116
|
},
|
|
14117
|
+
"GoogleCloudDiscoveryengineV1alphaSingleRegionKey": {
|
|
14118
|
+
"description": "Metadata for single-regional CMEKs.",
|
|
14119
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey",
|
|
14120
|
+
"properties": {
|
|
14121
|
+
"kmsKey": {
|
|
14122
|
+
"description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
|
|
14123
|
+
"type": "string"
|
|
14124
|
+
}
|
|
14125
|
+
},
|
|
14126
|
+
"type": "object"
|
|
14127
|
+
},
|
|
13553
14128
|
"GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": {
|
|
13554
14129
|
"description": "Verification information for target sites in advanced site search.",
|
|
13555
14130
|
"id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo",
|
|
@@ -13787,6 +14362,23 @@
|
|
|
13787
14362
|
},
|
|
13788
14363
|
"type": "object"
|
|
13789
14364
|
},
|
|
14365
|
+
"GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata": {
|
|
14366
|
+
"description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
14367
|
+
"id": "GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata",
|
|
14368
|
+
"properties": {
|
|
14369
|
+
"createTime": {
|
|
14370
|
+
"description": "Operation create time.",
|
|
14371
|
+
"format": "google-datetime",
|
|
14372
|
+
"type": "string"
|
|
14373
|
+
},
|
|
14374
|
+
"updateTime": {
|
|
14375
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
14376
|
+
"format": "google-datetime",
|
|
14377
|
+
"type": "string"
|
|
14378
|
+
}
|
|
14379
|
+
},
|
|
14380
|
+
"type": "object"
|
|
14381
|
+
},
|
|
13790
14382
|
"GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": {
|
|
13791
14383
|
"description": "Metadata for UpdateSchema LRO.",
|
|
13792
14384
|
"id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata",
|
|
@@ -15754,8 +16346,15 @@
|
|
|
15754
16346
|
"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
15755
16347
|
"type": "string"
|
|
15756
16348
|
},
|
|
15757
|
-
"
|
|
15758
|
-
"description": "
|
|
16349
|
+
"singleRegionKeys": {
|
|
16350
|
+
"description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
|
|
16351
|
+
"items": {
|
|
16352
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSingleRegionKey"
|
|
16353
|
+
},
|
|
16354
|
+
"type": "array"
|
|
16355
|
+
},
|
|
16356
|
+
"state": {
|
|
16357
|
+
"description": "Output only. State of the CmekConfig.",
|
|
15759
16358
|
"enum": [
|
|
15760
16359
|
"STATE_UNSPECIFIED",
|
|
15761
16360
|
"CREATING",
|
|
@@ -16514,6 +17113,10 @@
|
|
|
16514
17113
|
],
|
|
16515
17114
|
"type": "string"
|
|
16516
17115
|
},
|
|
17116
|
+
"isInfobotFaqDataStore": {
|
|
17117
|
+
"description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.",
|
|
17118
|
+
"type": "boolean"
|
|
17119
|
+
},
|
|
16517
17120
|
"kmsKeyName": {
|
|
16518
17121
|
"description": "Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.",
|
|
16519
17122
|
"type": "string"
|
|
@@ -16751,7 +17354,7 @@
|
|
|
16751
17354
|
},
|
|
16752
17355
|
"indexStatus": {
|
|
16753
17356
|
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentIndexStatus",
|
|
16754
|
-
"description": "Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise,
|
|
17357
|
+
"description": "Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated.",
|
|
16755
17358
|
"readOnly": true
|
|
16756
17359
|
},
|
|
16757
17360
|
"indexTime": {
|
|
@@ -16822,6 +17425,10 @@
|
|
|
16822
17425
|
"description": "The time when the document was indexed. If this field is populated, it means the document has been indexed.",
|
|
16823
17426
|
"format": "google-datetime",
|
|
16824
17427
|
"type": "string"
|
|
17428
|
+
},
|
|
17429
|
+
"pendingMessage": {
|
|
17430
|
+
"description": "Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending.",
|
|
17431
|
+
"type": "string"
|
|
16825
17432
|
}
|
|
16826
17433
|
},
|
|
16827
17434
|
"type": "object"
|
|
@@ -17442,6 +18049,424 @@
|
|
|
17442
18049
|
},
|
|
17443
18050
|
"type": "object"
|
|
17444
18051
|
},
|
|
18052
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest": {
|
|
18053
|
+
"description": "Top-level message sent by the client for the `GenerateGroundedContent` method.",
|
|
18054
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest",
|
|
18055
|
+
"properties": {
|
|
18056
|
+
"contents": {
|
|
18057
|
+
"description": "Content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.",
|
|
18058
|
+
"items": {
|
|
18059
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContent"
|
|
18060
|
+
},
|
|
18061
|
+
"type": "array"
|
|
18062
|
+
},
|
|
18063
|
+
"generationSpec": {
|
|
18064
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec",
|
|
18065
|
+
"description": "Content generation specification."
|
|
18066
|
+
},
|
|
18067
|
+
"groundingSpec": {
|
|
18068
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec",
|
|
18069
|
+
"description": "Grounding specification."
|
|
18070
|
+
},
|
|
18071
|
+
"systemInstruction": {
|
|
18072
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContent",
|
|
18073
|
+
"description": "Content of the system instruction for the current API. These instructions will take priority over any other prompt instructions if the selected model is supporting them."
|
|
18074
|
+
},
|
|
18075
|
+
"userLabels": {
|
|
18076
|
+
"additionalProperties": {
|
|
18077
|
+
"type": "string"
|
|
18078
|
+
},
|
|
18079
|
+
"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.",
|
|
18080
|
+
"type": "object"
|
|
18081
|
+
}
|
|
18082
|
+
},
|
|
18083
|
+
"type": "object"
|
|
18084
|
+
},
|
|
18085
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration": {
|
|
18086
|
+
"description": "Describes the options to customize dynamic retrieval.",
|
|
18087
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration",
|
|
18088
|
+
"properties": {
|
|
18089
|
+
"predictor": {
|
|
18090
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor",
|
|
18091
|
+
"description": "Specification for the predictor for dynamic retrieval."
|
|
18092
|
+
}
|
|
18093
|
+
},
|
|
18094
|
+
"type": "object"
|
|
18095
|
+
},
|
|
18096
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor": {
|
|
18097
|
+
"description": "Describes the predictor settings for dynamic retrieval.",
|
|
18098
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor",
|
|
18099
|
+
"properties": {
|
|
18100
|
+
"threshold": {
|
|
18101
|
+
"description": "The value of the threshold. If the predictor will predict a value smaller than this, it would suppress grounding in the source.",
|
|
18102
|
+
"format": "float",
|
|
18103
|
+
"type": "number"
|
|
18104
|
+
},
|
|
18105
|
+
"version": {
|
|
18106
|
+
"description": "The version of the predictor to be used in dynamic retrieval.",
|
|
18107
|
+
"enum": [
|
|
18108
|
+
"VERSION_UNSPECIFIED",
|
|
18109
|
+
"V1_INDEPENDENT"
|
|
18110
|
+
],
|
|
18111
|
+
"enumDescriptions": [
|
|
18112
|
+
"Automatically choose the best version of the retrieval predictor.",
|
|
18113
|
+
"The V1 model which is evaluating each source independently."
|
|
18114
|
+
],
|
|
18115
|
+
"type": "string"
|
|
18116
|
+
}
|
|
18117
|
+
},
|
|
18118
|
+
"type": "object"
|
|
18119
|
+
},
|
|
18120
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec": {
|
|
18121
|
+
"description": "Content generation specification.",
|
|
18122
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec",
|
|
18123
|
+
"properties": {
|
|
18124
|
+
"frequencyPenalty": {
|
|
18125
|
+
"description": "If specified, custom value for frequency penalty will be used.",
|
|
18126
|
+
"format": "float",
|
|
18127
|
+
"type": "number"
|
|
18128
|
+
},
|
|
18129
|
+
"languageCode": {
|
|
18130
|
+
"description": "Language code for content. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).",
|
|
18131
|
+
"type": "string"
|
|
18132
|
+
},
|
|
18133
|
+
"maxOutputTokens": {
|
|
18134
|
+
"description": "If specified, custom value for max output tokens will be used.",
|
|
18135
|
+
"format": "int32",
|
|
18136
|
+
"type": "integer"
|
|
18137
|
+
},
|
|
18138
|
+
"modelId": {
|
|
18139
|
+
"description": "Specifies which Vertex model id to use for generation.",
|
|
18140
|
+
"type": "string"
|
|
18141
|
+
},
|
|
18142
|
+
"presencePenalty": {
|
|
18143
|
+
"description": "If specified, custom value for presence penalty will be used.",
|
|
18144
|
+
"format": "float",
|
|
18145
|
+
"type": "number"
|
|
18146
|
+
},
|
|
18147
|
+
"seed": {
|
|
18148
|
+
"description": "If specified, custom value for the seed will be used.",
|
|
18149
|
+
"format": "int32",
|
|
18150
|
+
"type": "integer"
|
|
18151
|
+
},
|
|
18152
|
+
"temperature": {
|
|
18153
|
+
"description": "If specified, custom value for the temperature will be used.",
|
|
18154
|
+
"format": "float",
|
|
18155
|
+
"type": "number"
|
|
18156
|
+
},
|
|
18157
|
+
"topK": {
|
|
18158
|
+
"description": "If specified, custom value for top-k sampling will be used.",
|
|
18159
|
+
"format": "int32",
|
|
18160
|
+
"type": "integer"
|
|
18161
|
+
},
|
|
18162
|
+
"topP": {
|
|
18163
|
+
"description": "If specified, custom value for nucleus sampling will be used.",
|
|
18164
|
+
"format": "float",
|
|
18165
|
+
"type": "number"
|
|
18166
|
+
}
|
|
18167
|
+
},
|
|
18168
|
+
"type": "object"
|
|
18169
|
+
},
|
|
18170
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource": {
|
|
18171
|
+
"description": "Grounding source.",
|
|
18172
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource",
|
|
18173
|
+
"properties": {
|
|
18174
|
+
"googleSearchSource": {
|
|
18175
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource",
|
|
18176
|
+
"description": "If set, grounding is performed with Google Search."
|
|
18177
|
+
},
|
|
18178
|
+
"inlineSource": {
|
|
18179
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource",
|
|
18180
|
+
"description": "If set, grounding is performed with inline content."
|
|
18181
|
+
},
|
|
18182
|
+
"searchSource": {
|
|
18183
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource",
|
|
18184
|
+
"description": "If set, grounding is performed with Vertex AI Search."
|
|
18185
|
+
}
|
|
18186
|
+
},
|
|
18187
|
+
"type": "object"
|
|
18188
|
+
},
|
|
18189
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource": {
|
|
18190
|
+
"description": "Google Search config parameters.",
|
|
18191
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource",
|
|
18192
|
+
"properties": {
|
|
18193
|
+
"dynamicRetrievalConfig": {
|
|
18194
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration",
|
|
18195
|
+
"description": "Optional. Specifies the dynamic retrieval configuration for the given source."
|
|
18196
|
+
}
|
|
18197
|
+
},
|
|
18198
|
+
"type": "object"
|
|
18199
|
+
},
|
|
18200
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource": {
|
|
18201
|
+
"description": "Message to be used for grounding based on inline content.",
|
|
18202
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource",
|
|
18203
|
+
"properties": {
|
|
18204
|
+
"attributes": {
|
|
18205
|
+
"additionalProperties": {
|
|
18206
|
+
"type": "string"
|
|
18207
|
+
},
|
|
18208
|
+
"description": "Attributes associated with the content. Common attributes include `source` (indicating where the content was sourced from) and `author` (indicating the author of the content).",
|
|
18209
|
+
"type": "object"
|
|
18210
|
+
},
|
|
18211
|
+
"groundingFacts": {
|
|
18212
|
+
"description": "List of facts to be used for grounding.",
|
|
18213
|
+
"items": {
|
|
18214
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGroundingFact"
|
|
18215
|
+
},
|
|
18216
|
+
"type": "array"
|
|
18217
|
+
}
|
|
18218
|
+
},
|
|
18219
|
+
"type": "object"
|
|
18220
|
+
},
|
|
18221
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource": {
|
|
18222
|
+
"description": "Message to be used for grounding with Vertex AI Search.",
|
|
18223
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource",
|
|
18224
|
+
"properties": {
|
|
18225
|
+
"filter": {
|
|
18226
|
+
"description": "Filter expression to be applied to the search. The syntax is the same as SearchRequest.filter.",
|
|
18227
|
+
"type": "string"
|
|
18228
|
+
},
|
|
18229
|
+
"maxResultCount": {
|
|
18230
|
+
"description": "Number of search results to return. The default value is 10. The maximumm allowed value is 10.",
|
|
18231
|
+
"format": "int32",
|
|
18232
|
+
"type": "integer"
|
|
18233
|
+
},
|
|
18234
|
+
"safeSearch": {
|
|
18235
|
+
"description": "If set, safe search is enabled in Vertex AI Search requests.",
|
|
18236
|
+
"type": "boolean"
|
|
18237
|
+
},
|
|
18238
|
+
"servingConfig": {
|
|
18239
|
+
"description": "The resource name of the Engine to use. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
|
|
18240
|
+
"type": "string"
|
|
18241
|
+
}
|
|
18242
|
+
},
|
|
18243
|
+
"type": "object"
|
|
18244
|
+
},
|
|
18245
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec": {
|
|
18246
|
+
"description": "Grounding specification.",
|
|
18247
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec",
|
|
18248
|
+
"properties": {
|
|
18249
|
+
"groundingSources": {
|
|
18250
|
+
"description": "Grounding sources.",
|
|
18251
|
+
"items": {
|
|
18252
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource"
|
|
18253
|
+
},
|
|
18254
|
+
"type": "array"
|
|
18255
|
+
}
|
|
18256
|
+
},
|
|
18257
|
+
"type": "object"
|
|
18258
|
+
},
|
|
18259
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse": {
|
|
18260
|
+
"description": "Response for the `GenerateGroundedContent` method.",
|
|
18261
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse",
|
|
18262
|
+
"properties": {
|
|
18263
|
+
"candidates": {
|
|
18264
|
+
"description": "Generated candidates.",
|
|
18265
|
+
"items": {
|
|
18266
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate"
|
|
18267
|
+
},
|
|
18268
|
+
"type": "array"
|
|
18269
|
+
}
|
|
18270
|
+
},
|
|
18271
|
+
"type": "object"
|
|
18272
|
+
},
|
|
18273
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate": {
|
|
18274
|
+
"description": "A response candidate generated from the model.",
|
|
18275
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate",
|
|
18276
|
+
"properties": {
|
|
18277
|
+
"content": {
|
|
18278
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContent",
|
|
18279
|
+
"description": "Content of the candidate."
|
|
18280
|
+
},
|
|
18281
|
+
"groundingMetadata": {
|
|
18282
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata",
|
|
18283
|
+
"description": "Grounding metadata for the generated content."
|
|
18284
|
+
},
|
|
18285
|
+
"groundingScore": {
|
|
18286
|
+
"description": "The overall grounding score for the candidate, in the range of [0, 1].",
|
|
18287
|
+
"format": "float",
|
|
18288
|
+
"type": "number"
|
|
18289
|
+
},
|
|
18290
|
+
"index": {
|
|
18291
|
+
"description": "Index of the candidate.",
|
|
18292
|
+
"format": "int32",
|
|
18293
|
+
"type": "integer"
|
|
18294
|
+
}
|
|
18295
|
+
},
|
|
18296
|
+
"type": "object"
|
|
18297
|
+
},
|
|
18298
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata": {
|
|
18299
|
+
"description": "Citation for the generated content.",
|
|
18300
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata",
|
|
18301
|
+
"properties": {
|
|
18302
|
+
"groundingSupport": {
|
|
18303
|
+
"description": "GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.",
|
|
18304
|
+
"items": {
|
|
18305
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport"
|
|
18306
|
+
},
|
|
18307
|
+
"type": "array"
|
|
18308
|
+
},
|
|
18309
|
+
"retrievalMetadata": {
|
|
18310
|
+
"description": "Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.",
|
|
18311
|
+
"items": {
|
|
18312
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata"
|
|
18313
|
+
},
|
|
18314
|
+
"type": "array"
|
|
18315
|
+
},
|
|
18316
|
+
"searchEntryPoint": {
|
|
18317
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint",
|
|
18318
|
+
"description": "Google search entry for the following-up web searches."
|
|
18319
|
+
},
|
|
18320
|
+
"supportChunks": {
|
|
18321
|
+
"description": "List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.",
|
|
18322
|
+
"items": {
|
|
18323
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaFactChunk"
|
|
18324
|
+
},
|
|
18325
|
+
"type": "array"
|
|
18326
|
+
},
|
|
18327
|
+
"webSearchQueries": {
|
|
18328
|
+
"description": "Web search queries for the following-up web search.",
|
|
18329
|
+
"items": {
|
|
18330
|
+
"type": "string"
|
|
18331
|
+
},
|
|
18332
|
+
"type": "array"
|
|
18333
|
+
}
|
|
18334
|
+
},
|
|
18335
|
+
"type": "object"
|
|
18336
|
+
},
|
|
18337
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata": {
|
|
18338
|
+
"description": "Describes the metadata about dynamic retrieval.",
|
|
18339
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata",
|
|
18340
|
+
"properties": {
|
|
18341
|
+
"predictorMetadata": {
|
|
18342
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata",
|
|
18343
|
+
"description": "Metadata for the dynamic retrieval predictor."
|
|
18344
|
+
}
|
|
18345
|
+
},
|
|
18346
|
+
"type": "object"
|
|
18347
|
+
},
|
|
18348
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata": {
|
|
18349
|
+
"description": "Describes the metadata about the dynamic retrieval predictor.",
|
|
18350
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata",
|
|
18351
|
+
"properties": {
|
|
18352
|
+
"prediction": {
|
|
18353
|
+
"description": "The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most. In between values allow to differentiate between different usefulness scores for grounding.",
|
|
18354
|
+
"format": "float",
|
|
18355
|
+
"type": "number"
|
|
18356
|
+
},
|
|
18357
|
+
"version": {
|
|
18358
|
+
"description": "The version of the predictor which was used in dynamic retrieval.",
|
|
18359
|
+
"enum": [
|
|
18360
|
+
"VERSION_UNSPECIFIED",
|
|
18361
|
+
"V1_INDEPENDENT"
|
|
18362
|
+
],
|
|
18363
|
+
"enumDescriptions": [
|
|
18364
|
+
"Unspecified version, should never be used.",
|
|
18365
|
+
"The V1 model which is evaluating each source independently."
|
|
18366
|
+
],
|
|
18367
|
+
"type": "string"
|
|
18368
|
+
}
|
|
18369
|
+
},
|
|
18370
|
+
"type": "object"
|
|
18371
|
+
},
|
|
18372
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport": {
|
|
18373
|
+
"description": "Grounding info for a claim in the candidate and its support.",
|
|
18374
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport",
|
|
18375
|
+
"properties": {
|
|
18376
|
+
"claimText": {
|
|
18377
|
+
"description": "Text for the claim in the candidate. Always provided when a support is found.",
|
|
18378
|
+
"type": "string"
|
|
18379
|
+
},
|
|
18380
|
+
"supportChunkIndices": {
|
|
18381
|
+
"description": "A list of indices (into 'support_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that support_chunks[1], support_chunks[3], support_chunks[4] are the chunks attributed to the claim.",
|
|
18382
|
+
"items": {
|
|
18383
|
+
"format": "int32",
|
|
18384
|
+
"type": "integer"
|
|
18385
|
+
},
|
|
18386
|
+
"type": "array"
|
|
18387
|
+
},
|
|
18388
|
+
"supportScore": {
|
|
18389
|
+
"description": "A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated. Higher value means that the claim is better supported by the chunks.",
|
|
18390
|
+
"format": "float",
|
|
18391
|
+
"type": "number"
|
|
18392
|
+
}
|
|
18393
|
+
},
|
|
18394
|
+
"type": "object"
|
|
18395
|
+
},
|
|
18396
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata": {
|
|
18397
|
+
"description": "Describes the metadata associated with a retrieval step.",
|
|
18398
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata",
|
|
18399
|
+
"properties": {
|
|
18400
|
+
"dynamicRetrievalMetadata": {
|
|
18401
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata",
|
|
18402
|
+
"description": "Metadata for dynamic retrieval."
|
|
18403
|
+
},
|
|
18404
|
+
"source": {
|
|
18405
|
+
"description": "Describes the source to which the metadata is referring to.",
|
|
18406
|
+
"enum": [
|
|
18407
|
+
"SOURCE_UNSPECIFIED",
|
|
18408
|
+
"VERTEX_AI_SEARCH",
|
|
18409
|
+
"GOOGLE_SEARCH",
|
|
18410
|
+
"INLINE_CONTENT",
|
|
18411
|
+
"GOOGLE_MAPS"
|
|
18412
|
+
],
|
|
18413
|
+
"enumDescriptions": [
|
|
18414
|
+
"Unspecified source.",
|
|
18415
|
+
"Vertex AI search.",
|
|
18416
|
+
"Google Search.",
|
|
18417
|
+
"User inline provided content.",
|
|
18418
|
+
"Google Maps."
|
|
18419
|
+
],
|
|
18420
|
+
"type": "string"
|
|
18421
|
+
}
|
|
18422
|
+
},
|
|
18423
|
+
"type": "object"
|
|
18424
|
+
},
|
|
18425
|
+
"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint": {
|
|
18426
|
+
"description": "Google search entry point.",
|
|
18427
|
+
"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint",
|
|
18428
|
+
"properties": {
|
|
18429
|
+
"renderedContent": {
|
|
18430
|
+
"description": "Web content snippet that can be embedded in a web page or an app webview.",
|
|
18431
|
+
"type": "string"
|
|
18432
|
+
},
|
|
18433
|
+
"sdkBlob": {
|
|
18434
|
+
"description": "Base64 encoded JSON representing array of tuple.",
|
|
18435
|
+
"format": "byte",
|
|
18436
|
+
"type": "string"
|
|
18437
|
+
}
|
|
18438
|
+
},
|
|
18439
|
+
"type": "object"
|
|
18440
|
+
},
|
|
18441
|
+
"GoogleCloudDiscoveryengineV1betaGroundedGenerationContent": {
|
|
18442
|
+
"description": "Base structured datatype containing multi-part content of a message.",
|
|
18443
|
+
"id": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContent",
|
|
18444
|
+
"properties": {
|
|
18445
|
+
"parts": {
|
|
18446
|
+
"description": "Ordered `Parts` that constitute a single message.",
|
|
18447
|
+
"items": {
|
|
18448
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart"
|
|
18449
|
+
},
|
|
18450
|
+
"type": "array"
|
|
18451
|
+
},
|
|
18452
|
+
"role": {
|
|
18453
|
+
"description": "Producer of the content. Must be either `user` or `model`. Intended to be used for multi-turn conversations. Otherwise, it can be left unset.",
|
|
18454
|
+
"type": "string"
|
|
18455
|
+
}
|
|
18456
|
+
},
|
|
18457
|
+
"type": "object"
|
|
18458
|
+
},
|
|
18459
|
+
"GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart": {
|
|
18460
|
+
"description": "Single part of content.",
|
|
18461
|
+
"id": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart",
|
|
18462
|
+
"properties": {
|
|
18463
|
+
"text": {
|
|
18464
|
+
"description": "Inline text.",
|
|
18465
|
+
"type": "string"
|
|
18466
|
+
}
|
|
18467
|
+
},
|
|
18468
|
+
"type": "object"
|
|
18469
|
+
},
|
|
17445
18470
|
"GoogleCloudDiscoveryengineV1betaGroundingFact": {
|
|
17446
18471
|
"description": "Grounding Fact.",
|
|
17447
18472
|
"id": "GoogleCloudDiscoveryengineV1betaGroundingFact",
|
|
@@ -20677,6 +21702,17 @@
|
|
|
20677
21702
|
},
|
|
20678
21703
|
"type": "object"
|
|
20679
21704
|
},
|
|
21705
|
+
"GoogleCloudDiscoveryengineV1betaSingleRegionKey": {
|
|
21706
|
+
"description": "Metadata for single-regional CMEKs.",
|
|
21707
|
+
"id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey",
|
|
21708
|
+
"properties": {
|
|
21709
|
+
"kmsKey": {
|
|
21710
|
+
"description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
|
|
21711
|
+
"type": "string"
|
|
21712
|
+
}
|
|
21713
|
+
},
|
|
21714
|
+
"type": "object"
|
|
21715
|
+
},
|
|
20680
21716
|
"GoogleCloudDiscoveryengineV1betaSiteSearchEngine": {
|
|
20681
21717
|
"description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.",
|
|
20682
21718
|
"id": "GoogleCloudDiscoveryengineV1betaSiteSearchEngine",
|
|
@@ -21511,6 +22547,72 @@
|
|
|
21511
22547
|
}
|
|
21512
22548
|
},
|
|
21513
22549
|
"type": "object"
|
|
22550
|
+
},
|
|
22551
|
+
"GoogleTypeDateTime": {
|
|
22552
|
+
"description": "Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.",
|
|
22553
|
+
"id": "GoogleTypeDateTime",
|
|
22554
|
+
"properties": {
|
|
22555
|
+
"day": {
|
|
22556
|
+
"description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.",
|
|
22557
|
+
"format": "int32",
|
|
22558
|
+
"type": "integer"
|
|
22559
|
+
},
|
|
22560
|
+
"hours": {
|
|
22561
|
+
"description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
|
|
22562
|
+
"format": "int32",
|
|
22563
|
+
"type": "integer"
|
|
22564
|
+
},
|
|
22565
|
+
"minutes": {
|
|
22566
|
+
"description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.",
|
|
22567
|
+
"format": "int32",
|
|
22568
|
+
"type": "integer"
|
|
22569
|
+
},
|
|
22570
|
+
"month": {
|
|
22571
|
+
"description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.",
|
|
22572
|
+
"format": "int32",
|
|
22573
|
+
"type": "integer"
|
|
22574
|
+
},
|
|
22575
|
+
"nanos": {
|
|
22576
|
+
"description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.",
|
|
22577
|
+
"format": "int32",
|
|
22578
|
+
"type": "integer"
|
|
22579
|
+
},
|
|
22580
|
+
"seconds": {
|
|
22581
|
+
"description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.",
|
|
22582
|
+
"format": "int32",
|
|
22583
|
+
"type": "integer"
|
|
22584
|
+
},
|
|
22585
|
+
"timeZone": {
|
|
22586
|
+
"$ref": "GoogleTypeTimeZone",
|
|
22587
|
+
"description": "Time zone."
|
|
22588
|
+
},
|
|
22589
|
+
"utcOffset": {
|
|
22590
|
+
"description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.",
|
|
22591
|
+
"format": "google-duration",
|
|
22592
|
+
"type": "string"
|
|
22593
|
+
},
|
|
22594
|
+
"year": {
|
|
22595
|
+
"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.",
|
|
22596
|
+
"format": "int32",
|
|
22597
|
+
"type": "integer"
|
|
22598
|
+
}
|
|
22599
|
+
},
|
|
22600
|
+
"type": "object"
|
|
22601
|
+
},
|
|
22602
|
+
"GoogleTypeTimeZone": {
|
|
22603
|
+
"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
|
|
22604
|
+
"id": "GoogleTypeTimeZone",
|
|
22605
|
+
"properties": {
|
|
22606
|
+
"id": {
|
|
22607
|
+
"description": "IANA Time Zone Database time zone. For example \"America/New_York\".",
|
|
22608
|
+
"type": "string"
|
|
22609
|
+
},
|
|
22610
|
+
"version": {
|
|
22611
|
+
"description": "Optional. IANA Time Zone Database version number. For example \"2019a\".",
|
|
22612
|
+
"type": "string"
|
|
22613
|
+
}
|
|
22614
|
+
},
|
|
22615
|
+
"type": "object"
|
|
21514
22616
|
}
|
|
21515
22617
|
},
|
|
21516
22618
|
"servicePath": "",
|