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
|
@@ -242,6 +242,34 @@
|
|
|
242
242
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
243
243
|
]
|
|
244
244
|
},
|
|
245
|
+
"generateGroundedContent": {
|
|
246
|
+
"description": "Generates grounded content.",
|
|
247
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:generateGroundedContent",
|
|
248
|
+
"httpMethod": "POST",
|
|
249
|
+
"id": "discoveryengine.projects.locations.generateGroundedContent",
|
|
250
|
+
"parameterOrder": [
|
|
251
|
+
"location"
|
|
252
|
+
],
|
|
253
|
+
"parameters": {
|
|
254
|
+
"location": {
|
|
255
|
+
"description": "Required. Location resource. Format: `projects/{project}/locations/{location}`.",
|
|
256
|
+
"location": "path",
|
|
257
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
258
|
+
"required": true,
|
|
259
|
+
"type": "string"
|
|
260
|
+
}
|
|
261
|
+
},
|
|
262
|
+
"path": "v1alpha/{+location}:generateGroundedContent",
|
|
263
|
+
"request": {
|
|
264
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest"
|
|
265
|
+
},
|
|
266
|
+
"response": {
|
|
267
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse"
|
|
268
|
+
},
|
|
269
|
+
"scopes": [
|
|
270
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
271
|
+
]
|
|
272
|
+
},
|
|
245
273
|
"getAclConfig": {
|
|
246
274
|
"description": "Gets the AclConfig.",
|
|
247
275
|
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/aclConfig",
|
|
@@ -292,6 +320,34 @@
|
|
|
292
320
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
293
321
|
]
|
|
294
322
|
},
|
|
323
|
+
"setUpDataConnector": {
|
|
324
|
+
"description": "Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.",
|
|
325
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:setUpDataConnector",
|
|
326
|
+
"httpMethod": "POST",
|
|
327
|
+
"id": "discoveryengine.projects.locations.setUpDataConnector",
|
|
328
|
+
"parameterOrder": [
|
|
329
|
+
"parent"
|
|
330
|
+
],
|
|
331
|
+
"parameters": {
|
|
332
|
+
"parent": {
|
|
333
|
+
"description": "Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`.",
|
|
334
|
+
"location": "path",
|
|
335
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
336
|
+
"required": true,
|
|
337
|
+
"type": "string"
|
|
338
|
+
}
|
|
339
|
+
},
|
|
340
|
+
"path": "v1alpha/{+parent}:setUpDataConnector",
|
|
341
|
+
"request": {
|
|
342
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest"
|
|
343
|
+
},
|
|
344
|
+
"response": {
|
|
345
|
+
"$ref": "GoogleLongrunningOperation"
|
|
346
|
+
},
|
|
347
|
+
"scopes": [
|
|
348
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
349
|
+
]
|
|
350
|
+
},
|
|
295
351
|
"updateAclConfig": {
|
|
296
352
|
"description": "Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.",
|
|
297
353
|
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/aclConfig",
|
|
@@ -443,9 +499,265 @@
|
|
|
443
499
|
}
|
|
444
500
|
},
|
|
445
501
|
"collections": {
|
|
502
|
+
"methods": {
|
|
503
|
+
"delete": {
|
|
504
|
+
"description": "Deletes a Collection.",
|
|
505
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}",
|
|
506
|
+
"httpMethod": "DELETE",
|
|
507
|
+
"id": "discoveryengine.projects.locations.collections.delete",
|
|
508
|
+
"parameterOrder": [
|
|
509
|
+
"name"
|
|
510
|
+
],
|
|
511
|
+
"parameters": {
|
|
512
|
+
"name": {
|
|
513
|
+
"description": "Required. The full resource name of the Collection, in the format of `projects/{project}/locations/{location}/collections/{collection}`.",
|
|
514
|
+
"location": "path",
|
|
515
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$",
|
|
516
|
+
"required": true,
|
|
517
|
+
"type": "string"
|
|
518
|
+
}
|
|
519
|
+
},
|
|
520
|
+
"path": "v1alpha/{+name}",
|
|
521
|
+
"response": {
|
|
522
|
+
"$ref": "GoogleLongrunningOperation"
|
|
523
|
+
},
|
|
524
|
+
"scopes": [
|
|
525
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
526
|
+
]
|
|
527
|
+
},
|
|
528
|
+
"get": {
|
|
529
|
+
"description": "Gets a Collection.",
|
|
530
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}",
|
|
531
|
+
"httpMethod": "GET",
|
|
532
|
+
"id": "discoveryengine.projects.locations.collections.get",
|
|
533
|
+
"parameterOrder": [
|
|
534
|
+
"name"
|
|
535
|
+
],
|
|
536
|
+
"parameters": {
|
|
537
|
+
"name": {
|
|
538
|
+
"description": "Required. The full resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}`.",
|
|
539
|
+
"location": "path",
|
|
540
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$",
|
|
541
|
+
"required": true,
|
|
542
|
+
"type": "string"
|
|
543
|
+
}
|
|
544
|
+
},
|
|
545
|
+
"path": "v1alpha/{+name}",
|
|
546
|
+
"response": {
|
|
547
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCollection"
|
|
548
|
+
},
|
|
549
|
+
"scopes": [
|
|
550
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
551
|
+
]
|
|
552
|
+
},
|
|
553
|
+
"getDataConnector": {
|
|
554
|
+
"description": "Gets the DataConnector. DataConnector is a singleton resource for each Collection.",
|
|
555
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector",
|
|
556
|
+
"httpMethod": "GET",
|
|
557
|
+
"id": "discoveryengine.projects.locations.collections.getDataConnector",
|
|
558
|
+
"parameterOrder": [
|
|
559
|
+
"name"
|
|
560
|
+
],
|
|
561
|
+
"parameters": {
|
|
562
|
+
"name": {
|
|
563
|
+
"description": "Required. Full resource name of DataConnector, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned.",
|
|
564
|
+
"location": "path",
|
|
565
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$",
|
|
566
|
+
"required": true,
|
|
567
|
+
"type": "string"
|
|
568
|
+
}
|
|
569
|
+
},
|
|
570
|
+
"path": "v1alpha/{+name}",
|
|
571
|
+
"response": {
|
|
572
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector"
|
|
573
|
+
},
|
|
574
|
+
"scopes": [
|
|
575
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
576
|
+
]
|
|
577
|
+
},
|
|
578
|
+
"list": {
|
|
579
|
+
"description": "Gets a list of Collections.",
|
|
580
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections",
|
|
581
|
+
"httpMethod": "GET",
|
|
582
|
+
"id": "discoveryengine.projects.locations.collections.list",
|
|
583
|
+
"parameterOrder": [
|
|
584
|
+
"parent"
|
|
585
|
+
],
|
|
586
|
+
"parameters": {
|
|
587
|
+
"filter": {
|
|
588
|
+
"description": "Filter returned collections by associated data connector data sources. For example: `filter = 'data_source:jira confluence'`. If the filter is empty, we return all collections under a project and location.",
|
|
589
|
+
"location": "query",
|
|
590
|
+
"type": "string"
|
|
591
|
+
},
|
|
592
|
+
"pageSize": {
|
|
593
|
+
"description": "The maximum number of Collections to return. The service may return fewer than this value. If unspecified, at most 100 Collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
|
|
594
|
+
"format": "int32",
|
|
595
|
+
"location": "query",
|
|
596
|
+
"type": "integer"
|
|
597
|
+
},
|
|
598
|
+
"pageToken": {
|
|
599
|
+
"description": "A page token, received from a previous CollectionService.ListCollections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CollectionService.ListCollections must match the call that provided the page token.",
|
|
600
|
+
"location": "query",
|
|
601
|
+
"type": "string"
|
|
602
|
+
},
|
|
603
|
+
"parent": {
|
|
604
|
+
"description": "Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}`.",
|
|
605
|
+
"location": "path",
|
|
606
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
607
|
+
"required": true,
|
|
608
|
+
"type": "string"
|
|
609
|
+
}
|
|
610
|
+
},
|
|
611
|
+
"path": "v1alpha/{+parent}/collections",
|
|
612
|
+
"response": {
|
|
613
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaListCollectionsResponse"
|
|
614
|
+
},
|
|
615
|
+
"scopes": [
|
|
616
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
617
|
+
]
|
|
618
|
+
},
|
|
619
|
+
"patch": {
|
|
620
|
+
"description": "Updates a Collection.",
|
|
621
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}",
|
|
622
|
+
"httpMethod": "PATCH",
|
|
623
|
+
"id": "discoveryengine.projects.locations.collections.patch",
|
|
624
|
+
"parameterOrder": [
|
|
625
|
+
"name"
|
|
626
|
+
],
|
|
627
|
+
"parameters": {
|
|
628
|
+
"name": {
|
|
629
|
+
"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.",
|
|
630
|
+
"location": "path",
|
|
631
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$",
|
|
632
|
+
"required": true,
|
|
633
|
+
"type": "string"
|
|
634
|
+
},
|
|
635
|
+
"updateMask": {
|
|
636
|
+
"description": "Optional. The list of fields to be updated.",
|
|
637
|
+
"format": "google-fieldmask",
|
|
638
|
+
"location": "query",
|
|
639
|
+
"type": "string"
|
|
640
|
+
}
|
|
641
|
+
},
|
|
642
|
+
"path": "v1alpha/{+name}",
|
|
643
|
+
"request": {
|
|
644
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCollection"
|
|
645
|
+
},
|
|
646
|
+
"response": {
|
|
647
|
+
"$ref": "GoogleLongrunningOperation"
|
|
648
|
+
},
|
|
649
|
+
"scopes": [
|
|
650
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
651
|
+
]
|
|
652
|
+
},
|
|
653
|
+
"updateDataConnector": {
|
|
654
|
+
"description": "Updates a DataConnector.",
|
|
655
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector",
|
|
656
|
+
"httpMethod": "PATCH",
|
|
657
|
+
"id": "discoveryengine.projects.locations.collections.updateDataConnector",
|
|
658
|
+
"parameterOrder": [
|
|
659
|
+
"name"
|
|
660
|
+
],
|
|
661
|
+
"parameters": {
|
|
662
|
+
"name": {
|
|
663
|
+
"description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.",
|
|
664
|
+
"location": "path",
|
|
665
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$",
|
|
666
|
+
"required": true,
|
|
667
|
+
"type": "string"
|
|
668
|
+
},
|
|
669
|
+
"updateMask": {
|
|
670
|
+
"description": "Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - destination_configs - blocking_reasons Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.",
|
|
671
|
+
"format": "google-fieldmask",
|
|
672
|
+
"location": "query",
|
|
673
|
+
"type": "string"
|
|
674
|
+
}
|
|
675
|
+
},
|
|
676
|
+
"path": "v1alpha/{+name}",
|
|
677
|
+
"request": {
|
|
678
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector"
|
|
679
|
+
},
|
|
680
|
+
"response": {
|
|
681
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector"
|
|
682
|
+
},
|
|
683
|
+
"scopes": [
|
|
684
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
685
|
+
]
|
|
686
|
+
}
|
|
687
|
+
},
|
|
446
688
|
"resources": {
|
|
447
689
|
"dataConnector": {
|
|
690
|
+
"methods": {
|
|
691
|
+
"startConnectorRun": {
|
|
692
|
+
"description": "Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced.",
|
|
693
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector:startConnectorRun",
|
|
694
|
+
"httpMethod": "POST",
|
|
695
|
+
"id": "discoveryengine.projects.locations.collections.dataConnector.startConnectorRun",
|
|
696
|
+
"parameterOrder": [
|
|
697
|
+
"parent"
|
|
698
|
+
],
|
|
699
|
+
"parameters": {
|
|
700
|
+
"parent": {
|
|
701
|
+
"description": "Required. Connector name of the form projects/{project}/locations/{location}/collections/ {collection_id}/dataConnector",
|
|
702
|
+
"location": "path",
|
|
703
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$",
|
|
704
|
+
"required": true,
|
|
705
|
+
"type": "string"
|
|
706
|
+
}
|
|
707
|
+
},
|
|
708
|
+
"path": "v1alpha/{+parent}:startConnectorRun",
|
|
709
|
+
"request": {
|
|
710
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest"
|
|
711
|
+
},
|
|
712
|
+
"response": {
|
|
713
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRun"
|
|
714
|
+
},
|
|
715
|
+
"scopes": [
|
|
716
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
717
|
+
]
|
|
718
|
+
}
|
|
719
|
+
},
|
|
448
720
|
"resources": {
|
|
721
|
+
"connectorRuns": {
|
|
722
|
+
"methods": {
|
|
723
|
+
"list": {
|
|
724
|
+
"description": "Lists the ConnectorRuns of a DataConnector.",
|
|
725
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/connectorRuns",
|
|
726
|
+
"httpMethod": "GET",
|
|
727
|
+
"id": "discoveryengine.projects.locations.collections.dataConnector.connectorRuns.list",
|
|
728
|
+
"parameterOrder": [
|
|
729
|
+
"parent"
|
|
730
|
+
],
|
|
731
|
+
"parameters": {
|
|
732
|
+
"pageSize": {
|
|
733
|
+
"description": "Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.",
|
|
734
|
+
"format": "int32",
|
|
735
|
+
"location": "query",
|
|
736
|
+
"type": "integer"
|
|
737
|
+
},
|
|
738
|
+
"pageToken": {
|
|
739
|
+
"description": "A page token, received from a previous `ListConnectorRuns` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectorRuns` must match the call that provided the page token.",
|
|
740
|
+
"location": "query",
|
|
741
|
+
"type": "string"
|
|
742
|
+
},
|
|
743
|
+
"parent": {
|
|
744
|
+
"description": "Required. The parent DataConnector resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to list ConnectorRuns under this DataConnector, regardless of whether or not this DataConnector exists, a PERMISSION_DENIED error is returned.",
|
|
745
|
+
"location": "path",
|
|
746
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$",
|
|
747
|
+
"required": true,
|
|
748
|
+
"type": "string"
|
|
749
|
+
}
|
|
750
|
+
},
|
|
751
|
+
"path": "v1alpha/{+parent}/connectorRuns",
|
|
752
|
+
"response": {
|
|
753
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse"
|
|
754
|
+
},
|
|
755
|
+
"scopes": [
|
|
756
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
757
|
+
]
|
|
758
|
+
}
|
|
759
|
+
}
|
|
760
|
+
},
|
|
449
761
|
"operations": {
|
|
450
762
|
"methods": {
|
|
451
763
|
"get": {
|
|
@@ -8156,7 +8468,7 @@
|
|
|
8156
8468
|
}
|
|
8157
8469
|
}
|
|
8158
8470
|
},
|
|
8159
|
-
"revision": "
|
|
8471
|
+
"revision": "20241216",
|
|
8160
8472
|
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
8161
8473
|
"schemas": {
|
|
8162
8474
|
"GoogleApiDistribution": {
|
|
@@ -8595,6 +8907,13 @@
|
|
|
8595
8907
|
"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
8596
8908
|
"type": "string"
|
|
8597
8909
|
},
|
|
8910
|
+
"singleRegionKeys": {
|
|
8911
|
+
"description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
|
|
8912
|
+
"items": {
|
|
8913
|
+
"$ref": "GoogleCloudDiscoveryengineV1SingleRegionKey"
|
|
8914
|
+
},
|
|
8915
|
+
"type": "array"
|
|
8916
|
+
},
|
|
8598
8917
|
"state": {
|
|
8599
8918
|
"description": "Output only. State of the CmekConfig.",
|
|
8600
8919
|
"enum": [
|
|
@@ -8977,6 +9296,10 @@
|
|
|
8977
9296
|
],
|
|
8978
9297
|
"type": "string"
|
|
8979
9298
|
},
|
|
9299
|
+
"isInfobotFaqDataStore": {
|
|
9300
|
+
"description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.",
|
|
9301
|
+
"type": "boolean"
|
|
9302
|
+
},
|
|
8980
9303
|
"kmsKeyName": {
|
|
8981
9304
|
"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.",
|
|
8982
9305
|
"type": "string"
|
|
@@ -10271,6 +10594,17 @@
|
|
|
10271
10594
|
},
|
|
10272
10595
|
"type": "object"
|
|
10273
10596
|
},
|
|
10597
|
+
"GoogleCloudDiscoveryengineV1SingleRegionKey": {
|
|
10598
|
+
"description": "Metadata for single-regional CMEKs.",
|
|
10599
|
+
"id": "GoogleCloudDiscoveryengineV1SingleRegionKey",
|
|
10600
|
+
"properties": {
|
|
10601
|
+
"kmsKey": {
|
|
10602
|
+
"description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
|
|
10603
|
+
"type": "string"
|
|
10604
|
+
}
|
|
10605
|
+
},
|
|
10606
|
+
"type": "object"
|
|
10607
|
+
},
|
|
10274
10608
|
"GoogleCloudDiscoveryengineV1SiteVerificationInfo": {
|
|
10275
10609
|
"description": "Verification information for target sites in advanced site search.",
|
|
10276
10610
|
"id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo",
|
|
@@ -10561,7 +10895,27 @@
|
|
|
10561
10895
|
},
|
|
10562
10896
|
"type": "object"
|
|
10563
10897
|
},
|
|
10564
|
-
"
|
|
10898
|
+
"GoogleCloudDiscoveryengineV1alphaActionConfig": {
|
|
10899
|
+
"description": "Informations to support actions on the connector.",
|
|
10900
|
+
"id": "GoogleCloudDiscoveryengineV1alphaActionConfig",
|
|
10901
|
+
"properties": {
|
|
10902
|
+
"actionParams": {
|
|
10903
|
+
"additionalProperties": {
|
|
10904
|
+
"description": "Properties of the object.",
|
|
10905
|
+
"type": "any"
|
|
10906
|
+
},
|
|
10907
|
+
"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.",
|
|
10908
|
+
"type": "object"
|
|
10909
|
+
},
|
|
10910
|
+
"isActionConfigured": {
|
|
10911
|
+
"description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
|
|
10912
|
+
"readOnly": true,
|
|
10913
|
+
"type": "boolean"
|
|
10914
|
+
}
|
|
10915
|
+
},
|
|
10916
|
+
"type": "object"
|
|
10917
|
+
},
|
|
10918
|
+
"GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest": {
|
|
10565
10919
|
"description": "Request message for CompletionService.AdvancedCompleteQuery method. .",
|
|
10566
10920
|
"id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest",
|
|
10567
10921
|
"properties": {
|
|
@@ -12510,6 +12864,13 @@
|
|
|
12510
12864
|
"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
12511
12865
|
"type": "string"
|
|
12512
12866
|
},
|
|
12867
|
+
"singleRegionKeys": {
|
|
12868
|
+
"description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
|
|
12869
|
+
"items": {
|
|
12870
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey"
|
|
12871
|
+
},
|
|
12872
|
+
"type": "array"
|
|
12873
|
+
},
|
|
12513
12874
|
"state": {
|
|
12514
12875
|
"description": "Output only. State of the CmekConfig.",
|
|
12515
12876
|
"enum": [
|
|
@@ -12536,6 +12897,32 @@
|
|
|
12536
12897
|
},
|
|
12537
12898
|
"type": "object"
|
|
12538
12899
|
},
|
|
12900
|
+
"GoogleCloudDiscoveryengineV1alphaCollection": {
|
|
12901
|
+
"description": "Collection is a container for configuring resources and access to a set of DataStores.",
|
|
12902
|
+
"id": "GoogleCloudDiscoveryengineV1alphaCollection",
|
|
12903
|
+
"properties": {
|
|
12904
|
+
"createTime": {
|
|
12905
|
+
"description": "Output only. Timestamp the Collection was created at.",
|
|
12906
|
+
"format": "google-datetime",
|
|
12907
|
+
"readOnly": true,
|
|
12908
|
+
"type": "string"
|
|
12909
|
+
},
|
|
12910
|
+
"dataConnector": {
|
|
12911
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector",
|
|
12912
|
+
"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.",
|
|
12913
|
+
"readOnly": true
|
|
12914
|
+
},
|
|
12915
|
+
"displayName": {
|
|
12916
|
+
"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.",
|
|
12917
|
+
"type": "string"
|
|
12918
|
+
},
|
|
12919
|
+
"name": {
|
|
12920
|
+
"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.",
|
|
12921
|
+
"type": "string"
|
|
12922
|
+
}
|
|
12923
|
+
},
|
|
12924
|
+
"type": "object"
|
|
12925
|
+
},
|
|
12539
12926
|
"GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse": {
|
|
12540
12927
|
"description": "Response message for CompletionService.CompleteQuery method.",
|
|
12541
12928
|
"id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse",
|
|
@@ -12686,6 +13073,186 @@
|
|
|
12686
13073
|
},
|
|
12687
13074
|
"type": "object"
|
|
12688
13075
|
},
|
|
13076
|
+
"GoogleCloudDiscoveryengineV1alphaConnectorRun": {
|
|
13077
|
+
"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. //",
|
|
13078
|
+
"id": "GoogleCloudDiscoveryengineV1alphaConnectorRun",
|
|
13079
|
+
"properties": {
|
|
13080
|
+
"endTime": {
|
|
13081
|
+
"description": "Output only. The time when the connector run ended.",
|
|
13082
|
+
"format": "google-datetime",
|
|
13083
|
+
"readOnly": true,
|
|
13084
|
+
"type": "string"
|
|
13085
|
+
},
|
|
13086
|
+
"entityRuns": {
|
|
13087
|
+
"description": "Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities.",
|
|
13088
|
+
"items": {
|
|
13089
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun"
|
|
13090
|
+
},
|
|
13091
|
+
"readOnly": true,
|
|
13092
|
+
"type": "array"
|
|
13093
|
+
},
|
|
13094
|
+
"errors": {
|
|
13095
|
+
"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.",
|
|
13096
|
+
"items": {
|
|
13097
|
+
"$ref": "GoogleRpcStatus"
|
|
13098
|
+
},
|
|
13099
|
+
"type": "array"
|
|
13100
|
+
},
|
|
13101
|
+
"latestPauseTime": {
|
|
13102
|
+
"description": "Output only. The time when the connector run was most recently paused.",
|
|
13103
|
+
"format": "google-datetime",
|
|
13104
|
+
"readOnly": true,
|
|
13105
|
+
"type": "string"
|
|
13106
|
+
},
|
|
13107
|
+
"name": {
|
|
13108
|
+
"description": "Output only. The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.",
|
|
13109
|
+
"readOnly": true,
|
|
13110
|
+
"type": "string"
|
|
13111
|
+
},
|
|
13112
|
+
"startTime": {
|
|
13113
|
+
"description": "Output only. The time when the connector run started.",
|
|
13114
|
+
"format": "google-datetime",
|
|
13115
|
+
"readOnly": true,
|
|
13116
|
+
"type": "string"
|
|
13117
|
+
},
|
|
13118
|
+
"state": {
|
|
13119
|
+
"description": "Output only. The state of the sync run.",
|
|
13120
|
+
"enum": [
|
|
13121
|
+
"STATE_UNSPECIFIED",
|
|
13122
|
+
"RUNNING",
|
|
13123
|
+
"SUCCEEDED",
|
|
13124
|
+
"FAILED",
|
|
13125
|
+
"OVERRUN",
|
|
13126
|
+
"CANCELLED",
|
|
13127
|
+
"PENDING",
|
|
13128
|
+
"WARNING"
|
|
13129
|
+
],
|
|
13130
|
+
"enumDescriptions": [
|
|
13131
|
+
"Default value.",
|
|
13132
|
+
"The data sync is ongoing.",
|
|
13133
|
+
"The data sync is finished.",
|
|
13134
|
+
"The data sync is failed.",
|
|
13135
|
+
"Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
|
|
13136
|
+
"Data sync was scheduled but has been cancelled.",
|
|
13137
|
+
"Data sync is about to start.",
|
|
13138
|
+
"The data sync completed with non-fatal errors."
|
|
13139
|
+
],
|
|
13140
|
+
"readOnly": true,
|
|
13141
|
+
"type": "string"
|
|
13142
|
+
},
|
|
13143
|
+
"stateUpdateTime": {
|
|
13144
|
+
"description": "Timestamp at which the connector run sync state was last updated.",
|
|
13145
|
+
"format": "google-datetime",
|
|
13146
|
+
"type": "string"
|
|
13147
|
+
},
|
|
13148
|
+
"trigger": {
|
|
13149
|
+
"description": "Output only. The trigger for this ConnectorRun.",
|
|
13150
|
+
"enum": [
|
|
13151
|
+
"TRIGGER_UNSPECIFIED",
|
|
13152
|
+
"SCHEDULER",
|
|
13153
|
+
"INITIALIZATION",
|
|
13154
|
+
"RESUME",
|
|
13155
|
+
"MANUAL"
|
|
13156
|
+
],
|
|
13157
|
+
"enumDescriptions": [
|
|
13158
|
+
"Default value.",
|
|
13159
|
+
"ConnectorRun triggered by scheduler if connector has PERIODIC sync mode.",
|
|
13160
|
+
"ConnectorRun auto triggered by connector initialization.",
|
|
13161
|
+
"ConnectorRun auto triggered by resuming connector.",
|
|
13162
|
+
"ConnectorRun triggered by user manually."
|
|
13163
|
+
],
|
|
13164
|
+
"readOnly": true,
|
|
13165
|
+
"type": "string"
|
|
13166
|
+
}
|
|
13167
|
+
},
|
|
13168
|
+
"type": "object"
|
|
13169
|
+
},
|
|
13170
|
+
"GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun": {
|
|
13171
|
+
"description": "Represents an entity that was synced in this ConnectorRun.",
|
|
13172
|
+
"id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun",
|
|
13173
|
+
"properties": {
|
|
13174
|
+
"entityName": {
|
|
13175
|
+
"description": "The name of the source entity.",
|
|
13176
|
+
"type": "string"
|
|
13177
|
+
},
|
|
13178
|
+
"errorRecordCount": {
|
|
13179
|
+
"description": "The total number of documents failed at sync at any stage (extraction, indexing, etc).",
|
|
13180
|
+
"format": "int64",
|
|
13181
|
+
"type": "string"
|
|
13182
|
+
},
|
|
13183
|
+
"errors": {
|
|
13184
|
+
"description": "The errors from the entity's sync run. Only exist if running into an error state. Contains error code and error message.",
|
|
13185
|
+
"items": {
|
|
13186
|
+
"$ref": "GoogleRpcStatus"
|
|
13187
|
+
},
|
|
13188
|
+
"type": "array"
|
|
13189
|
+
},
|
|
13190
|
+
"extractedRecordCount": {
|
|
13191
|
+
"description": "The number of documents extracted from connector source, ready to be ingested to UCS.",
|
|
13192
|
+
"format": "int64",
|
|
13193
|
+
"type": "string"
|
|
13194
|
+
},
|
|
13195
|
+
"indexedRecordCount": {
|
|
13196
|
+
"description": "The number of documents indexed.",
|
|
13197
|
+
"format": "int64",
|
|
13198
|
+
"type": "string"
|
|
13199
|
+
},
|
|
13200
|
+
"sourceApiRequestCount": {
|
|
13201
|
+
"description": "The number of requests sent to 3p API.",
|
|
13202
|
+
"format": "int64",
|
|
13203
|
+
"type": "string"
|
|
13204
|
+
},
|
|
13205
|
+
"state": {
|
|
13206
|
+
"description": "The state of the entity's sync run.",
|
|
13207
|
+
"enum": [
|
|
13208
|
+
"STATE_UNSPECIFIED",
|
|
13209
|
+
"RUNNING",
|
|
13210
|
+
"SUCCEEDED",
|
|
13211
|
+
"FAILED",
|
|
13212
|
+
"OVERRUN",
|
|
13213
|
+
"CANCELLED",
|
|
13214
|
+
"PENDING",
|
|
13215
|
+
"WARNING"
|
|
13216
|
+
],
|
|
13217
|
+
"enumDescriptions": [
|
|
13218
|
+
"Default value.",
|
|
13219
|
+
"The data sync is ongoing.",
|
|
13220
|
+
"The data sync is finished.",
|
|
13221
|
+
"The data sync is failed.",
|
|
13222
|
+
"Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
|
|
13223
|
+
"Data sync was scheduled but has been cancelled.",
|
|
13224
|
+
"Data sync is about to start.",
|
|
13225
|
+
"The data sync completed with non-fatal errors."
|
|
13226
|
+
],
|
|
13227
|
+
"type": "string"
|
|
13228
|
+
},
|
|
13229
|
+
"stateUpdateTime": {
|
|
13230
|
+
"description": "Timestamp at which the entity sync state was last updated.",
|
|
13231
|
+
"format": "google-datetime",
|
|
13232
|
+
"type": "string"
|
|
13233
|
+
},
|
|
13234
|
+
"statsUpdateTime": {
|
|
13235
|
+
"description": "The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated.",
|
|
13236
|
+
"format": "google-datetime",
|
|
13237
|
+
"type": "string"
|
|
13238
|
+
},
|
|
13239
|
+
"syncType": {
|
|
13240
|
+
"description": "Sync type of this run.",
|
|
13241
|
+
"enum": [
|
|
13242
|
+
"SYNC_TYPE_UNSPECIFIED",
|
|
13243
|
+
"FULL",
|
|
13244
|
+
"INCREMENTAL"
|
|
13245
|
+
],
|
|
13246
|
+
"enumDescriptions": [
|
|
13247
|
+
"Sync type unspecified.",
|
|
13248
|
+
"Sync triggers full sync of all documents.",
|
|
13249
|
+
"Incremental sync of updated documents."
|
|
13250
|
+
],
|
|
13251
|
+
"type": "string"
|
|
13252
|
+
}
|
|
13253
|
+
},
|
|
13254
|
+
"type": "object"
|
|
13255
|
+
},
|
|
12689
13256
|
"GoogleCloudDiscoveryengineV1alphaControl": {
|
|
12690
13257
|
"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`.",
|
|
12691
13258
|
"id": "GoogleCloudDiscoveryengineV1alphaControl",
|
|
@@ -13221,113 +13788,315 @@
|
|
|
13221
13788
|
},
|
|
13222
13789
|
"type": "object"
|
|
13223
13790
|
},
|
|
13224
|
-
"
|
|
13225
|
-
"description": "
|
|
13226
|
-
"id": "
|
|
13791
|
+
"GoogleCloudDiscoveryengineV1alphaDataConnector": {
|
|
13792
|
+
"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. //",
|
|
13793
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDataConnector",
|
|
13227
13794
|
"properties": {
|
|
13228
|
-
"
|
|
13229
|
-
"
|
|
13230
|
-
"
|
|
13231
|
-
},
|
|
13232
|
-
"advancedSiteSearchConfig": {
|
|
13233
|
-
"$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig",
|
|
13234
|
-
"description": "Optional. Configuration for advanced site search."
|
|
13235
|
-
},
|
|
13236
|
-
"billingEstimation": {
|
|
13237
|
-
"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation",
|
|
13238
|
-
"description": "Output only. Data size estimation for billing.",
|
|
13239
|
-
"readOnly": true
|
|
13795
|
+
"actionConfig": {
|
|
13796
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig",
|
|
13797
|
+
"description": "Optional. Action configurations to make the connector support actions."
|
|
13240
13798
|
},
|
|
13241
|
-
"
|
|
13242
|
-
"
|
|
13243
|
-
"
|
|
13244
|
-
"readOnly": true
|
|
13799
|
+
"autoRunDisabled": {
|
|
13800
|
+
"description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.",
|
|
13801
|
+
"type": "boolean"
|
|
13245
13802
|
},
|
|
13246
|
-
"
|
|
13247
|
-
"description": "
|
|
13803
|
+
"blockingReasons": {
|
|
13804
|
+
"description": "Output only. User actions that must be completed before the connector can start syncing data.",
|
|
13805
|
+
"items": {
|
|
13248
13806
|
"enum": [
|
|
13249
|
-
"
|
|
13250
|
-
"
|
|
13251
|
-
"
|
|
13252
|
-
"PUBLIC_WEBSITE",
|
|
13253
|
-
"GOOGLE_WORKSPACE"
|
|
13807
|
+
"BLOCKING_REASON_UNSPECIFIED",
|
|
13808
|
+
"ALLOWLIST_STATIC_IP",
|
|
13809
|
+
"ALLOWLIST_IN_SERVICE_ATTACHMENT"
|
|
13254
13810
|
],
|
|
13255
13811
|
"enumDescriptions": [
|
|
13256
13812
|
"Default value.",
|
|
13257
|
-
"
|
|
13258
|
-
"
|
|
13259
|
-
"The data store is used for public website search.",
|
|
13260
|
-
"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig."
|
|
13813
|
+
"Connector requires customer to allowlist static IPs.",
|
|
13814
|
+
"Connector requires customer to allowlist our project in their service attachment."
|
|
13261
13815
|
],
|
|
13262
13816
|
"type": "string"
|
|
13263
13817
|
},
|
|
13818
|
+
"readOnly": true,
|
|
13819
|
+
"type": "array"
|
|
13820
|
+
},
|
|
13264
13821
|
"createTime": {
|
|
13265
|
-
"description": "Output only. Timestamp the
|
|
13822
|
+
"description": "Output only. Timestamp the DataConnector was created at.",
|
|
13266
13823
|
"format": "google-datetime",
|
|
13267
13824
|
"readOnly": true,
|
|
13268
13825
|
"type": "string"
|
|
13269
13826
|
},
|
|
13270
|
-
"
|
|
13271
|
-
"description": "
|
|
13272
|
-
"readOnly": true,
|
|
13827
|
+
"dataSource": {
|
|
13828
|
+
"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.",
|
|
13273
13829
|
"type": "string"
|
|
13274
13830
|
},
|
|
13275
|
-
"
|
|
13276
|
-
"description": "
|
|
13277
|
-
"
|
|
13831
|
+
"destinationConfigs": {
|
|
13832
|
+
"description": "Optional. Any target destinations used to connect to third-party services.",
|
|
13833
|
+
"items": {
|
|
13834
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfig"
|
|
13278
13835
|
},
|
|
13279
|
-
"
|
|
13280
|
-
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig",
|
|
13281
|
-
"description": "Configuration for Document understanding and enrichment."
|
|
13836
|
+
"type": "array"
|
|
13282
13837
|
},
|
|
13283
|
-
"
|
|
13284
|
-
"
|
|
13285
|
-
"
|
|
13286
|
-
"
|
|
13838
|
+
"entities": {
|
|
13839
|
+
"description": "List of entities from the connected data source to ingest.",
|
|
13840
|
+
"items": {
|
|
13841
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity"
|
|
13287
13842
|
},
|
|
13288
|
-
"
|
|
13289
|
-
|
|
13290
|
-
"
|
|
13291
|
-
"
|
|
13292
|
-
"
|
|
13293
|
-
"
|
|
13294
|
-
|
|
13295
|
-
|
|
13296
|
-
"
|
|
13297
|
-
|
|
13298
|
-
"
|
|
13299
|
-
"
|
|
13300
|
-
"The
|
|
13301
|
-
|
|
13843
|
+
"type": "array"
|
|
13844
|
+
},
|
|
13845
|
+
"errors": {
|
|
13846
|
+
"description": "Output only. The errors from initialization or from the latest connector run.",
|
|
13847
|
+
"items": {
|
|
13848
|
+
"$ref": "GoogleRpcStatus"
|
|
13849
|
+
},
|
|
13850
|
+
"readOnly": true,
|
|
13851
|
+
"type": "array"
|
|
13852
|
+
},
|
|
13853
|
+
"identityRefreshInterval": {
|
|
13854
|
+
"deprecated": true,
|
|
13855
|
+
"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.",
|
|
13856
|
+
"format": "google-duration",
|
|
13302
13857
|
"type": "string"
|
|
13303
13858
|
},
|
|
13859
|
+
"identityScheduleConfig": {
|
|
13860
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig",
|
|
13861
|
+
"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."
|
|
13862
|
+
},
|
|
13304
13863
|
"kmsKeyName": {
|
|
13305
|
-
"description": "Input only. The KMS key to be used to protect
|
|
13864
|
+
"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.",
|
|
13306
13865
|
"type": "string"
|
|
13307
13866
|
},
|
|
13308
|
-
"
|
|
13309
|
-
"
|
|
13310
|
-
"
|
|
13867
|
+
"lastSyncTime": {
|
|
13868
|
+
"description": "Output only. For periodic connectors only, the last time a data sync was completed.",
|
|
13869
|
+
"format": "google-datetime",
|
|
13870
|
+
"readOnly": true,
|
|
13871
|
+
"type": "string"
|
|
13872
|
+
},
|
|
13873
|
+
"latestPauseTime": {
|
|
13874
|
+
"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.",
|
|
13875
|
+
"format": "google-datetime",
|
|
13876
|
+
"readOnly": true,
|
|
13877
|
+
"type": "string"
|
|
13311
13878
|
},
|
|
13312
13879
|
"name": {
|
|
13313
|
-
"description": "
|
|
13880
|
+
"description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.",
|
|
13881
|
+
"readOnly": true,
|
|
13314
13882
|
"type": "string"
|
|
13315
13883
|
},
|
|
13316
|
-
"
|
|
13317
|
-
"$ref": "
|
|
13318
|
-
"description": "
|
|
13884
|
+
"nextSyncTime": {
|
|
13885
|
+
"$ref": "GoogleTypeDateTime",
|
|
13886
|
+
"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."
|
|
13319
13887
|
},
|
|
13320
|
-
"
|
|
13321
|
-
"
|
|
13322
|
-
"description": "
|
|
13888
|
+
"params": {
|
|
13889
|
+
"additionalProperties": {
|
|
13890
|
+
"description": "Properties of the object.",
|
|
13891
|
+
"type": "any"
|
|
13323
13892
|
},
|
|
13324
|
-
"
|
|
13325
|
-
"
|
|
13326
|
-
|
|
13893
|
+
"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`.",
|
|
13894
|
+
"type": "object"
|
|
13895
|
+
},
|
|
13896
|
+
"privateConnectivityProjectId": {
|
|
13897
|
+
"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.",
|
|
13898
|
+
"readOnly": true,
|
|
13899
|
+
"type": "string"
|
|
13900
|
+
},
|
|
13901
|
+
"refreshInterval": {
|
|
13902
|
+
"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.",
|
|
13903
|
+
"format": "google-duration",
|
|
13904
|
+
"type": "string"
|
|
13905
|
+
},
|
|
13906
|
+
"state": {
|
|
13907
|
+
"description": "Output only. State of the connector.",
|
|
13327
13908
|
"enum": [
|
|
13328
|
-
"
|
|
13329
|
-
"
|
|
13330
|
-
"
|
|
13909
|
+
"STATE_UNSPECIFIED",
|
|
13910
|
+
"CREATING",
|
|
13911
|
+
"ACTIVE",
|
|
13912
|
+
"FAILED",
|
|
13913
|
+
"RUNNING",
|
|
13914
|
+
"WARNING"
|
|
13915
|
+
],
|
|
13916
|
+
"enumDescriptions": [
|
|
13917
|
+
"Default value.",
|
|
13918
|
+
"The connector is being set up.",
|
|
13919
|
+
"The connector is successfully set up and awaiting next sync run.",
|
|
13920
|
+
"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.",
|
|
13921
|
+
"The connector is actively syncing records from the data source.",
|
|
13922
|
+
"The connector has completed a sync run, but encountered non-fatal errors."
|
|
13923
|
+
],
|
|
13924
|
+
"readOnly": true,
|
|
13925
|
+
"type": "string"
|
|
13926
|
+
},
|
|
13927
|
+
"staticIpAddresses": {
|
|
13928
|
+
"description": "Output only. The static IP addresses used by this connector.",
|
|
13929
|
+
"items": {
|
|
13930
|
+
"type": "string"
|
|
13931
|
+
},
|
|
13932
|
+
"readOnly": true,
|
|
13933
|
+
"type": "array"
|
|
13934
|
+
},
|
|
13935
|
+
"staticIpEnabled": {
|
|
13936
|
+
"description": "Optional. Whether customer has enabled static IP addresses for this connector.",
|
|
13937
|
+
"type": "boolean"
|
|
13938
|
+
},
|
|
13939
|
+
"syncMode": {
|
|
13940
|
+
"description": "The data synchronization mode supported by the data connector.",
|
|
13941
|
+
"enum": [
|
|
13942
|
+
"PERIODIC"
|
|
13943
|
+
],
|
|
13944
|
+
"enumDescriptions": [
|
|
13945
|
+
"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."
|
|
13946
|
+
],
|
|
13947
|
+
"type": "string"
|
|
13948
|
+
},
|
|
13949
|
+
"updateTime": {
|
|
13950
|
+
"description": "Output only. Timestamp the DataConnector was last updated.",
|
|
13951
|
+
"format": "google-datetime",
|
|
13952
|
+
"readOnly": true,
|
|
13953
|
+
"type": "string"
|
|
13954
|
+
}
|
|
13955
|
+
},
|
|
13956
|
+
"type": "object"
|
|
13957
|
+
},
|
|
13958
|
+
"GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity": {
|
|
13959
|
+
"description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.",
|
|
13960
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity",
|
|
13961
|
+
"properties": {
|
|
13962
|
+
"dataStore": {
|
|
13963
|
+
"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.",
|
|
13964
|
+
"readOnly": true,
|
|
13965
|
+
"type": "string"
|
|
13966
|
+
},
|
|
13967
|
+
"entityName": {
|
|
13968
|
+
"description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`",
|
|
13969
|
+
"type": "string"
|
|
13970
|
+
},
|
|
13971
|
+
"keyPropertyMappings": {
|
|
13972
|
+
"additionalProperties": {
|
|
13973
|
+
"type": "string"
|
|
13974
|
+
},
|
|
13975
|
+
"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.",
|
|
13976
|
+
"type": "object"
|
|
13977
|
+
},
|
|
13978
|
+
"params": {
|
|
13979
|
+
"additionalProperties": {
|
|
13980
|
+
"description": "Properties of the object.",
|
|
13981
|
+
"type": "any"
|
|
13982
|
+
},
|
|
13983
|
+
"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.",
|
|
13984
|
+
"type": "object"
|
|
13985
|
+
}
|
|
13986
|
+
},
|
|
13987
|
+
"type": "object"
|
|
13988
|
+
},
|
|
13989
|
+
"GoogleCloudDiscoveryengineV1alphaDataStore": {
|
|
13990
|
+
"description": "DataStore captures global settings and configs at the DataStore level.",
|
|
13991
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDataStore",
|
|
13992
|
+
"properties": {
|
|
13993
|
+
"aclEnabled": {
|
|
13994
|
+
"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.",
|
|
13995
|
+
"type": "boolean"
|
|
13996
|
+
},
|
|
13997
|
+
"advancedSiteSearchConfig": {
|
|
13998
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig",
|
|
13999
|
+
"description": "Optional. Configuration for advanced site search."
|
|
14000
|
+
},
|
|
14001
|
+
"billingEstimation": {
|
|
14002
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation",
|
|
14003
|
+
"description": "Output only. Data size estimation for billing.",
|
|
14004
|
+
"readOnly": true
|
|
14005
|
+
},
|
|
14006
|
+
"cmekConfig": {
|
|
14007
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig",
|
|
14008
|
+
"description": "Output only. CMEK-related information for the DataStore.",
|
|
14009
|
+
"readOnly": true
|
|
14010
|
+
},
|
|
14011
|
+
"contentConfig": {
|
|
14012
|
+
"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.",
|
|
14013
|
+
"enum": [
|
|
14014
|
+
"CONTENT_CONFIG_UNSPECIFIED",
|
|
14015
|
+
"NO_CONTENT",
|
|
14016
|
+
"CONTENT_REQUIRED",
|
|
14017
|
+
"PUBLIC_WEBSITE",
|
|
14018
|
+
"GOOGLE_WORKSPACE"
|
|
14019
|
+
],
|
|
14020
|
+
"enumDescriptions": [
|
|
14021
|
+
"Default value.",
|
|
14022
|
+
"Only contains documents without any Document.content.",
|
|
14023
|
+
"Only contains documents with Document.content.",
|
|
14024
|
+
"The data store is used for public website search.",
|
|
14025
|
+
"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig."
|
|
14026
|
+
],
|
|
14027
|
+
"type": "string"
|
|
14028
|
+
},
|
|
14029
|
+
"createTime": {
|
|
14030
|
+
"description": "Output only. Timestamp the DataStore was created at.",
|
|
14031
|
+
"format": "google-datetime",
|
|
14032
|
+
"readOnly": true,
|
|
14033
|
+
"type": "string"
|
|
14034
|
+
},
|
|
14035
|
+
"defaultSchemaId": {
|
|
14036
|
+
"description": "Output only. The id of the default Schema asscociated to this data store.",
|
|
14037
|
+
"readOnly": true,
|
|
14038
|
+
"type": "string"
|
|
14039
|
+
},
|
|
14040
|
+
"displayName": {
|
|
14041
|
+
"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.",
|
|
14042
|
+
"type": "string"
|
|
14043
|
+
},
|
|
14044
|
+
"documentProcessingConfig": {
|
|
14045
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig",
|
|
14046
|
+
"description": "Configuration for Document understanding and enrichment."
|
|
14047
|
+
},
|
|
14048
|
+
"idpConfig": {
|
|
14049
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig",
|
|
14050
|
+
"description": "Output only. Data store level identity provider config.",
|
|
14051
|
+
"readOnly": true
|
|
14052
|
+
},
|
|
14053
|
+
"industryVertical": {
|
|
14054
|
+
"description": "Immutable. The industry vertical that the data store registers.",
|
|
14055
|
+
"enum": [
|
|
14056
|
+
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
14057
|
+
"GENERIC",
|
|
14058
|
+
"MEDIA",
|
|
14059
|
+
"HEALTHCARE_FHIR"
|
|
14060
|
+
],
|
|
14061
|
+
"enumDescriptions": [
|
|
14062
|
+
"Value used when unset.",
|
|
14063
|
+
"The generic vertical for documents that are not specific to any industry vertical.",
|
|
14064
|
+
"The media industry vertical.",
|
|
14065
|
+
"The healthcare FHIR vertical."
|
|
14066
|
+
],
|
|
14067
|
+
"type": "string"
|
|
14068
|
+
},
|
|
14069
|
+
"isInfobotFaqDataStore": {
|
|
14070
|
+
"description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.",
|
|
14071
|
+
"type": "boolean"
|
|
14072
|
+
},
|
|
14073
|
+
"kmsKeyName": {
|
|
14074
|
+
"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.",
|
|
14075
|
+
"type": "string"
|
|
14076
|
+
},
|
|
14077
|
+
"languageInfo": {
|
|
14078
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo",
|
|
14079
|
+
"description": "Language info for DataStore."
|
|
14080
|
+
},
|
|
14081
|
+
"name": {
|
|
14082
|
+
"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.",
|
|
14083
|
+
"type": "string"
|
|
14084
|
+
},
|
|
14085
|
+
"naturalLanguageQueryUnderstandingConfig": {
|
|
14086
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig",
|
|
14087
|
+
"description": "Optional. Configuration for Natural Language Query Understanding."
|
|
14088
|
+
},
|
|
14089
|
+
"servingConfigDataStore": {
|
|
14090
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore",
|
|
14091
|
+
"description": "Optional. Stores serving config at DataStore level."
|
|
14092
|
+
},
|
|
14093
|
+
"solutionTypes": {
|
|
14094
|
+
"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.",
|
|
14095
|
+
"items": {
|
|
14096
|
+
"enum": [
|
|
14097
|
+
"SOLUTION_TYPE_UNSPECIFIED",
|
|
14098
|
+
"SOLUTION_TYPE_RECOMMENDATION",
|
|
14099
|
+
"SOLUTION_TYPE_SEARCH",
|
|
13331
14100
|
"SOLUTION_TYPE_CHAT",
|
|
13332
14101
|
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
13333
14102
|
],
|
|
@@ -13416,6 +14185,23 @@
|
|
|
13416
14185
|
},
|
|
13417
14186
|
"type": "object"
|
|
13418
14187
|
},
|
|
14188
|
+
"GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata": {
|
|
14189
|
+
"description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
14190
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata",
|
|
14191
|
+
"properties": {
|
|
14192
|
+
"createTime": {
|
|
14193
|
+
"description": "Operation create time.",
|
|
14194
|
+
"format": "google-datetime",
|
|
14195
|
+
"type": "string"
|
|
14196
|
+
},
|
|
14197
|
+
"updateTime": {
|
|
14198
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
14199
|
+
"format": "google-datetime",
|
|
14200
|
+
"type": "string"
|
|
14201
|
+
}
|
|
14202
|
+
},
|
|
14203
|
+
"type": "object"
|
|
14204
|
+
},
|
|
13419
14205
|
"GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": {
|
|
13420
14206
|
"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
13421
14207
|
"id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata",
|
|
@@ -13512,6 +14298,48 @@
|
|
|
13512
14298
|
},
|
|
13513
14299
|
"type": "object"
|
|
13514
14300
|
},
|
|
14301
|
+
"GoogleCloudDiscoveryengineV1alphaDestinationConfig": {
|
|
14302
|
+
"description": "Defines target endpoints used to connect to third-party sources.",
|
|
14303
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig",
|
|
14304
|
+
"properties": {
|
|
14305
|
+
"destinations": {
|
|
14306
|
+
"description": "Optional. The destinations for the corresponding key.",
|
|
14307
|
+
"items": {
|
|
14308
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination"
|
|
14309
|
+
},
|
|
14310
|
+
"type": "array"
|
|
14311
|
+
},
|
|
14312
|
+
"key": {
|
|
14313
|
+
"description": "Optional. Unique destination identifier that is supported by the connector.",
|
|
14314
|
+
"type": "string"
|
|
14315
|
+
},
|
|
14316
|
+
"params": {
|
|
14317
|
+
"additionalProperties": {
|
|
14318
|
+
"description": "Properties of the object.",
|
|
14319
|
+
"type": "any"
|
|
14320
|
+
},
|
|
14321
|
+
"description": "Optional. Additional parameters for this destination config.",
|
|
14322
|
+
"type": "object"
|
|
14323
|
+
}
|
|
14324
|
+
},
|
|
14325
|
+
"type": "object"
|
|
14326
|
+
},
|
|
14327
|
+
"GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination": {
|
|
14328
|
+
"description": "Defines a target endpoint",
|
|
14329
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination",
|
|
14330
|
+
"properties": {
|
|
14331
|
+
"host": {
|
|
14332
|
+
"description": "Publicly routable host.",
|
|
14333
|
+
"type": "string"
|
|
14334
|
+
},
|
|
14335
|
+
"port": {
|
|
14336
|
+
"description": "Optional. Target port number accepted by the destination.",
|
|
14337
|
+
"format": "int32",
|
|
14338
|
+
"type": "integer"
|
|
14339
|
+
}
|
|
14340
|
+
},
|
|
14341
|
+
"type": "object"
|
|
14342
|
+
},
|
|
13515
14343
|
"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": {
|
|
13516
14344
|
"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
13517
14345
|
"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata",
|
|
@@ -13568,7 +14396,7 @@
|
|
|
13568
14396
|
},
|
|
13569
14397
|
"indexStatus": {
|
|
13570
14398
|
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus",
|
|
13571
|
-
"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,
|
|
14399
|
+
"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.",
|
|
13572
14400
|
"readOnly": true
|
|
13573
14401
|
},
|
|
13574
14402
|
"indexTime": {
|
|
@@ -13671,6 +14499,10 @@
|
|
|
13671
14499
|
"description": "The time when the document was indexed. If this field is populated, it means the document has been indexed.",
|
|
13672
14500
|
"format": "google-datetime",
|
|
13673
14501
|
"type": "string"
|
|
14502
|
+
},
|
|
14503
|
+
"pendingMessage": {
|
|
14504
|
+
"description": "Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending.",
|
|
14505
|
+
"type": "string"
|
|
13674
14506
|
}
|
|
13675
14507
|
},
|
|
13676
14508
|
"type": "object"
|
|
@@ -14561,99 +15393,488 @@
|
|
|
14561
15393
|
"readOnly": true,
|
|
14562
15394
|
"type": "string"
|
|
14563
15395
|
},
|
|
14564
|
-
"metatagName": {
|
|
14565
|
-
"description": "Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.",
|
|
14566
|
-
"type": "string"
|
|
15396
|
+
"metatagName": {
|
|
15397
|
+
"description": "Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.",
|
|
15398
|
+
"type": "string"
|
|
15399
|
+
},
|
|
15400
|
+
"recsFilterableOption": {
|
|
15401
|
+
"description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.",
|
|
15402
|
+
"enum": [
|
|
15403
|
+
"FILTERABLE_OPTION_UNSPECIFIED",
|
|
15404
|
+
"FILTERABLE_ENABLED",
|
|
15405
|
+
"FILTERABLE_DISABLED"
|
|
15406
|
+
],
|
|
15407
|
+
"enumDescriptions": [
|
|
15408
|
+
"Value used when unset.",
|
|
15409
|
+
"Filterable option enabled for a schema field.",
|
|
15410
|
+
"Filterable option disabled for a schema field."
|
|
15411
|
+
],
|
|
15412
|
+
"type": "string"
|
|
15413
|
+
},
|
|
15414
|
+
"retrievableOption": {
|
|
15415
|
+
"description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.",
|
|
15416
|
+
"enum": [
|
|
15417
|
+
"RETRIEVABLE_OPTION_UNSPECIFIED",
|
|
15418
|
+
"RETRIEVABLE_ENABLED",
|
|
15419
|
+
"RETRIEVABLE_DISABLED"
|
|
15420
|
+
],
|
|
15421
|
+
"enumDescriptions": [
|
|
15422
|
+
"Value used when unset.",
|
|
15423
|
+
"Retrievable option enabled for a schema field.",
|
|
15424
|
+
"Retrievable option disabled for a schema field."
|
|
15425
|
+
],
|
|
15426
|
+
"type": "string"
|
|
15427
|
+
},
|
|
15428
|
+
"schemaOrgPaths": {
|
|
15429
|
+
"description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished",
|
|
15430
|
+
"items": {
|
|
15431
|
+
"type": "string"
|
|
15432
|
+
},
|
|
15433
|
+
"type": "array"
|
|
15434
|
+
},
|
|
15435
|
+
"searchableOption": {
|
|
15436
|
+
"description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.",
|
|
15437
|
+
"enum": [
|
|
15438
|
+
"SEARCHABLE_OPTION_UNSPECIFIED",
|
|
15439
|
+
"SEARCHABLE_ENABLED",
|
|
15440
|
+
"SEARCHABLE_DISABLED"
|
|
15441
|
+
],
|
|
15442
|
+
"enumDescriptions": [
|
|
15443
|
+
"Value used when unset.",
|
|
15444
|
+
"Searchable option enabled for a schema field.",
|
|
15445
|
+
"Searchable option disabled for a schema field."
|
|
15446
|
+
],
|
|
15447
|
+
"type": "string"
|
|
15448
|
+
}
|
|
15449
|
+
},
|
|
15450
|
+
"type": "object"
|
|
15451
|
+
},
|
|
15452
|
+
"GoogleCloudDiscoveryengineV1alphaFirestoreSource": {
|
|
15453
|
+
"description": "Firestore source import data from.",
|
|
15454
|
+
"id": "GoogleCloudDiscoveryengineV1alphaFirestoreSource",
|
|
15455
|
+
"properties": {
|
|
15456
|
+
"collectionId": {
|
|
15457
|
+
"description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.",
|
|
15458
|
+
"type": "string"
|
|
15459
|
+
},
|
|
15460
|
+
"databaseId": {
|
|
15461
|
+
"description": "Required. The Firestore database to copy the data from with a length limit of 256 characters.",
|
|
15462
|
+
"type": "string"
|
|
15463
|
+
},
|
|
15464
|
+
"gcsStagingDir": {
|
|
15465
|
+
"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.",
|
|
15466
|
+
"type": "string"
|
|
15467
|
+
},
|
|
15468
|
+
"projectId": {
|
|
15469
|
+
"description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
|
|
15470
|
+
"type": "string"
|
|
15471
|
+
}
|
|
15472
|
+
},
|
|
15473
|
+
"type": "object"
|
|
15474
|
+
},
|
|
15475
|
+
"GoogleCloudDiscoveryengineV1alphaGcsSource": {
|
|
15476
|
+
"description": "Cloud Storage location for input content.",
|
|
15477
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGcsSource",
|
|
15478
|
+
"properties": {
|
|
15479
|
+
"dataSchema": {
|
|
15480
|
+
"description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.",
|
|
15481
|
+
"type": "string"
|
|
15482
|
+
},
|
|
15483
|
+
"inputUris": {
|
|
15484
|
+
"description": "Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).",
|
|
15485
|
+
"items": {
|
|
15486
|
+
"type": "string"
|
|
15487
|
+
},
|
|
15488
|
+
"type": "array"
|
|
15489
|
+
}
|
|
15490
|
+
},
|
|
15491
|
+
"type": "object"
|
|
15492
|
+
},
|
|
15493
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest": {
|
|
15494
|
+
"description": "Top-level message sent by the client for the `GenerateGroundedContent` method.",
|
|
15495
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest",
|
|
15496
|
+
"properties": {
|
|
15497
|
+
"contents": {
|
|
15498
|
+
"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.",
|
|
15499
|
+
"items": {
|
|
15500
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent"
|
|
15501
|
+
},
|
|
15502
|
+
"type": "array"
|
|
15503
|
+
},
|
|
15504
|
+
"generationSpec": {
|
|
15505
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec",
|
|
15506
|
+
"description": "Content generation specification."
|
|
15507
|
+
},
|
|
15508
|
+
"groundingSpec": {
|
|
15509
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec",
|
|
15510
|
+
"description": "Grounding specification."
|
|
15511
|
+
},
|
|
15512
|
+
"systemInstruction": {
|
|
15513
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent",
|
|
15514
|
+
"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."
|
|
15515
|
+
},
|
|
15516
|
+
"userLabels": {
|
|
15517
|
+
"additionalProperties": {
|
|
15518
|
+
"type": "string"
|
|
15519
|
+
},
|
|
15520
|
+
"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.",
|
|
15521
|
+
"type": "object"
|
|
15522
|
+
}
|
|
15523
|
+
},
|
|
15524
|
+
"type": "object"
|
|
15525
|
+
},
|
|
15526
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration": {
|
|
15527
|
+
"description": "Describes the options to customize dynamic retrieval.",
|
|
15528
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration",
|
|
15529
|
+
"properties": {
|
|
15530
|
+
"predictor": {
|
|
15531
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor",
|
|
15532
|
+
"description": "Specification for the predictor for dynamic retrieval."
|
|
15533
|
+
}
|
|
15534
|
+
},
|
|
15535
|
+
"type": "object"
|
|
15536
|
+
},
|
|
15537
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor": {
|
|
15538
|
+
"description": "Describes the predictor settings for dynamic retrieval.",
|
|
15539
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor",
|
|
15540
|
+
"properties": {
|
|
15541
|
+
"threshold": {
|
|
15542
|
+
"description": "The value of the threshold. If the predictor will predict a value smaller than this, it would suppress grounding in the source.",
|
|
15543
|
+
"format": "float",
|
|
15544
|
+
"type": "number"
|
|
15545
|
+
},
|
|
15546
|
+
"version": {
|
|
15547
|
+
"description": "The version of the predictor to be used in dynamic retrieval.",
|
|
15548
|
+
"enum": [
|
|
15549
|
+
"VERSION_UNSPECIFIED",
|
|
15550
|
+
"V1_INDEPENDENT"
|
|
15551
|
+
],
|
|
15552
|
+
"enumDescriptions": [
|
|
15553
|
+
"Automatically choose the best version of the retrieval predictor.",
|
|
15554
|
+
"The V1 model which is evaluating each source independently."
|
|
15555
|
+
],
|
|
15556
|
+
"type": "string"
|
|
15557
|
+
}
|
|
15558
|
+
},
|
|
15559
|
+
"type": "object"
|
|
15560
|
+
},
|
|
15561
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec": {
|
|
15562
|
+
"description": "Content generation specification.",
|
|
15563
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec",
|
|
15564
|
+
"properties": {
|
|
15565
|
+
"frequencyPenalty": {
|
|
15566
|
+
"description": "If specified, custom value for frequency penalty will be used.",
|
|
15567
|
+
"format": "float",
|
|
15568
|
+
"type": "number"
|
|
15569
|
+
},
|
|
15570
|
+
"languageCode": {
|
|
15571
|
+
"description": "Language code for content. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).",
|
|
15572
|
+
"type": "string"
|
|
15573
|
+
},
|
|
15574
|
+
"maxOutputTokens": {
|
|
15575
|
+
"description": "If specified, custom value for max output tokens will be used.",
|
|
15576
|
+
"format": "int32",
|
|
15577
|
+
"type": "integer"
|
|
15578
|
+
},
|
|
15579
|
+
"modelId": {
|
|
15580
|
+
"description": "Specifies which Vertex model id to use for generation.",
|
|
15581
|
+
"type": "string"
|
|
15582
|
+
},
|
|
15583
|
+
"presencePenalty": {
|
|
15584
|
+
"description": "If specified, custom value for presence penalty will be used.",
|
|
15585
|
+
"format": "float",
|
|
15586
|
+
"type": "number"
|
|
15587
|
+
},
|
|
15588
|
+
"seed": {
|
|
15589
|
+
"description": "If specified, custom value for the seed will be used.",
|
|
15590
|
+
"format": "int32",
|
|
15591
|
+
"type": "integer"
|
|
15592
|
+
},
|
|
15593
|
+
"temperature": {
|
|
15594
|
+
"description": "If specified, custom value for the temperature will be used.",
|
|
15595
|
+
"format": "float",
|
|
15596
|
+
"type": "number"
|
|
15597
|
+
},
|
|
15598
|
+
"topK": {
|
|
15599
|
+
"description": "If specified, custom value for top-k sampling will be used.",
|
|
15600
|
+
"format": "int32",
|
|
15601
|
+
"type": "integer"
|
|
15602
|
+
},
|
|
15603
|
+
"topP": {
|
|
15604
|
+
"description": "If specified, custom value for nucleus sampling will be used.",
|
|
15605
|
+
"format": "float",
|
|
15606
|
+
"type": "number"
|
|
15607
|
+
}
|
|
15608
|
+
},
|
|
15609
|
+
"type": "object"
|
|
15610
|
+
},
|
|
15611
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource": {
|
|
15612
|
+
"description": "Grounding source.",
|
|
15613
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource",
|
|
15614
|
+
"properties": {
|
|
15615
|
+
"googleSearchSource": {
|
|
15616
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource",
|
|
15617
|
+
"description": "If set, grounding is performed with Google Search."
|
|
15618
|
+
},
|
|
15619
|
+
"inlineSource": {
|
|
15620
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource",
|
|
15621
|
+
"description": "If set, grounding is performed with inline content."
|
|
15622
|
+
},
|
|
15623
|
+
"searchSource": {
|
|
15624
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource",
|
|
15625
|
+
"description": "If set, grounding is performed with Vertex AI Search."
|
|
15626
|
+
}
|
|
15627
|
+
},
|
|
15628
|
+
"type": "object"
|
|
15629
|
+
},
|
|
15630
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource": {
|
|
15631
|
+
"description": "Google Search config parameters.",
|
|
15632
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource",
|
|
15633
|
+
"properties": {
|
|
15634
|
+
"dynamicRetrievalConfig": {
|
|
15635
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration",
|
|
15636
|
+
"description": "Optional. Specifies the dynamic retrieval configuration for the given source."
|
|
15637
|
+
}
|
|
15638
|
+
},
|
|
15639
|
+
"type": "object"
|
|
15640
|
+
},
|
|
15641
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource": {
|
|
15642
|
+
"description": "Message to be used for grounding based on inline content.",
|
|
15643
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource",
|
|
15644
|
+
"properties": {
|
|
15645
|
+
"attributes": {
|
|
15646
|
+
"additionalProperties": {
|
|
15647
|
+
"type": "string"
|
|
15648
|
+
},
|
|
15649
|
+
"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).",
|
|
15650
|
+
"type": "object"
|
|
15651
|
+
},
|
|
15652
|
+
"groundingFacts": {
|
|
15653
|
+
"description": "List of facts to be used for grounding.",
|
|
15654
|
+
"items": {
|
|
15655
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGroundingFact"
|
|
15656
|
+
},
|
|
15657
|
+
"type": "array"
|
|
15658
|
+
}
|
|
15659
|
+
},
|
|
15660
|
+
"type": "object"
|
|
15661
|
+
},
|
|
15662
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource": {
|
|
15663
|
+
"description": "Message to be used for grounding with Vertex AI Search.",
|
|
15664
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource",
|
|
15665
|
+
"properties": {
|
|
15666
|
+
"filter": {
|
|
15667
|
+
"description": "Filter expression to be applied to the search. The syntax is the same as SearchRequest.filter.",
|
|
15668
|
+
"type": "string"
|
|
15669
|
+
},
|
|
15670
|
+
"maxResultCount": {
|
|
15671
|
+
"description": "Number of search results to return. The default value is 10. The maximumm allowed value is 10.",
|
|
15672
|
+
"format": "int32",
|
|
15673
|
+
"type": "integer"
|
|
15674
|
+
},
|
|
15675
|
+
"safeSearch": {
|
|
15676
|
+
"description": "If set, safe search is enabled in Vertex AI Search requests.",
|
|
15677
|
+
"type": "boolean"
|
|
15678
|
+
},
|
|
15679
|
+
"servingConfig": {
|
|
15680
|
+
"description": "The resource name of the Engine to use. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
|
|
15681
|
+
"type": "string"
|
|
15682
|
+
}
|
|
15683
|
+
},
|
|
15684
|
+
"type": "object"
|
|
15685
|
+
},
|
|
15686
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec": {
|
|
15687
|
+
"description": "Grounding specification.",
|
|
15688
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec",
|
|
15689
|
+
"properties": {
|
|
15690
|
+
"groundingSources": {
|
|
15691
|
+
"description": "Grounding sources.",
|
|
15692
|
+
"items": {
|
|
15693
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource"
|
|
15694
|
+
},
|
|
15695
|
+
"type": "array"
|
|
15696
|
+
}
|
|
15697
|
+
},
|
|
15698
|
+
"type": "object"
|
|
15699
|
+
},
|
|
15700
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse": {
|
|
15701
|
+
"description": "Response for the `GenerateGroundedContent` method.",
|
|
15702
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse",
|
|
15703
|
+
"properties": {
|
|
15704
|
+
"candidates": {
|
|
15705
|
+
"description": "Generated candidates.",
|
|
15706
|
+
"items": {
|
|
15707
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate"
|
|
15708
|
+
},
|
|
15709
|
+
"type": "array"
|
|
15710
|
+
}
|
|
15711
|
+
},
|
|
15712
|
+
"type": "object"
|
|
15713
|
+
},
|
|
15714
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate": {
|
|
15715
|
+
"description": "A response candidate generated from the model.",
|
|
15716
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate",
|
|
15717
|
+
"properties": {
|
|
15718
|
+
"content": {
|
|
15719
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent",
|
|
15720
|
+
"description": "Content of the candidate."
|
|
15721
|
+
},
|
|
15722
|
+
"groundingMetadata": {
|
|
15723
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata",
|
|
15724
|
+
"description": "Grounding metadata for the generated content."
|
|
15725
|
+
},
|
|
15726
|
+
"groundingScore": {
|
|
15727
|
+
"description": "The overall grounding score for the candidate, in the range of [0, 1].",
|
|
15728
|
+
"format": "float",
|
|
15729
|
+
"type": "number"
|
|
15730
|
+
},
|
|
15731
|
+
"index": {
|
|
15732
|
+
"description": "Index of the candidate.",
|
|
15733
|
+
"format": "int32",
|
|
15734
|
+
"type": "integer"
|
|
15735
|
+
}
|
|
15736
|
+
},
|
|
15737
|
+
"type": "object"
|
|
15738
|
+
},
|
|
15739
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata": {
|
|
15740
|
+
"description": "Citation for the generated content.",
|
|
15741
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata",
|
|
15742
|
+
"properties": {
|
|
15743
|
+
"groundingSupport": {
|
|
15744
|
+
"description": "GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.",
|
|
15745
|
+
"items": {
|
|
15746
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport"
|
|
15747
|
+
},
|
|
15748
|
+
"type": "array"
|
|
15749
|
+
},
|
|
15750
|
+
"retrievalMetadata": {
|
|
15751
|
+
"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.",
|
|
15752
|
+
"items": {
|
|
15753
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata"
|
|
15754
|
+
},
|
|
15755
|
+
"type": "array"
|
|
15756
|
+
},
|
|
15757
|
+
"searchEntryPoint": {
|
|
15758
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint",
|
|
15759
|
+
"description": "Google search entry for the following-up web searches."
|
|
14567
15760
|
},
|
|
14568
|
-
"
|
|
14569
|
-
"description": "
|
|
14570
|
-
"
|
|
14571
|
-
"
|
|
14572
|
-
"FILTERABLE_ENABLED",
|
|
14573
|
-
"FILTERABLE_DISABLED"
|
|
14574
|
-
],
|
|
14575
|
-
"enumDescriptions": [
|
|
14576
|
-
"Value used when unset.",
|
|
14577
|
-
"Filterable option enabled for a schema field.",
|
|
14578
|
-
"Filterable option disabled for a schema field."
|
|
14579
|
-
],
|
|
14580
|
-
"type": "string"
|
|
15761
|
+
"supportChunks": {
|
|
15762
|
+
"description": "List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.",
|
|
15763
|
+
"items": {
|
|
15764
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaFactChunk"
|
|
14581
15765
|
},
|
|
14582
|
-
"
|
|
14583
|
-
"description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.",
|
|
14584
|
-
"enum": [
|
|
14585
|
-
"RETRIEVABLE_OPTION_UNSPECIFIED",
|
|
14586
|
-
"RETRIEVABLE_ENABLED",
|
|
14587
|
-
"RETRIEVABLE_DISABLED"
|
|
14588
|
-
],
|
|
14589
|
-
"enumDescriptions": [
|
|
14590
|
-
"Value used when unset.",
|
|
14591
|
-
"Retrievable option enabled for a schema field.",
|
|
14592
|
-
"Retrievable option disabled for a schema field."
|
|
14593
|
-
],
|
|
14594
|
-
"type": "string"
|
|
15766
|
+
"type": "array"
|
|
14595
15767
|
},
|
|
14596
|
-
"
|
|
14597
|
-
"description": "
|
|
15768
|
+
"webSearchQueries": {
|
|
15769
|
+
"description": "Web search queries for the following-up web search.",
|
|
14598
15770
|
"items": {
|
|
14599
15771
|
"type": "string"
|
|
14600
15772
|
},
|
|
14601
15773
|
"type": "array"
|
|
15774
|
+
}
|
|
14602
15775
|
},
|
|
14603
|
-
"
|
|
14604
|
-
|
|
15776
|
+
"type": "object"
|
|
15777
|
+
},
|
|
15778
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata": {
|
|
15779
|
+
"description": "Describes the metadata about dynamic retrieval.",
|
|
15780
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata",
|
|
15781
|
+
"properties": {
|
|
15782
|
+
"predictorMetadata": {
|
|
15783
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata",
|
|
15784
|
+
"description": "Metadata for the dynamic retrieval predictor."
|
|
15785
|
+
}
|
|
15786
|
+
},
|
|
15787
|
+
"type": "object"
|
|
15788
|
+
},
|
|
15789
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata": {
|
|
15790
|
+
"description": "Describes the metadata about the dynamic retrieval predictor.",
|
|
15791
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata",
|
|
15792
|
+
"properties": {
|
|
15793
|
+
"prediction": {
|
|
15794
|
+
"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.",
|
|
15795
|
+
"format": "float",
|
|
15796
|
+
"type": "number"
|
|
15797
|
+
},
|
|
15798
|
+
"version": {
|
|
15799
|
+
"description": "The version of the predictor which was used in dynamic retrieval.",
|
|
14605
15800
|
"enum": [
|
|
14606
|
-
"
|
|
14607
|
-
"
|
|
14608
|
-
"SEARCHABLE_DISABLED"
|
|
15801
|
+
"VERSION_UNSPECIFIED",
|
|
15802
|
+
"V1_INDEPENDENT"
|
|
14609
15803
|
],
|
|
14610
15804
|
"enumDescriptions": [
|
|
14611
|
-
"
|
|
14612
|
-
"
|
|
14613
|
-
"Searchable option disabled for a schema field."
|
|
15805
|
+
"Unspecified version, should never be used.",
|
|
15806
|
+
"The V1 model which is evaluating each source independently."
|
|
14614
15807
|
],
|
|
14615
15808
|
"type": "string"
|
|
14616
15809
|
}
|
|
14617
15810
|
},
|
|
14618
15811
|
"type": "object"
|
|
14619
15812
|
},
|
|
14620
|
-
"
|
|
14621
|
-
"description": "
|
|
14622
|
-
"id": "
|
|
15813
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport": {
|
|
15814
|
+
"description": "Grounding info for a claim in the candidate and its support.",
|
|
15815
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport",
|
|
14623
15816
|
"properties": {
|
|
14624
|
-
"
|
|
14625
|
-
"description": "
|
|
15817
|
+
"claimText": {
|
|
15818
|
+
"description": "Text for the claim in the candidate. Always provided when a support is found.",
|
|
14626
15819
|
"type": "string"
|
|
14627
15820
|
},
|
|
14628
|
-
"
|
|
14629
|
-
"description": "
|
|
14630
|
-
"
|
|
15821
|
+
"supportChunkIndices": {
|
|
15822
|
+
"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.",
|
|
15823
|
+
"items": {
|
|
15824
|
+
"format": "int32",
|
|
15825
|
+
"type": "integer"
|
|
14631
15826
|
},
|
|
14632
|
-
"
|
|
14633
|
-
"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.",
|
|
14634
|
-
"type": "string"
|
|
15827
|
+
"type": "array"
|
|
14635
15828
|
},
|
|
14636
|
-
"
|
|
14637
|
-
"description": "
|
|
14638
|
-
"
|
|
15829
|
+
"supportScore": {
|
|
15830
|
+
"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.",
|
|
15831
|
+
"format": "float",
|
|
15832
|
+
"type": "number"
|
|
14639
15833
|
}
|
|
14640
15834
|
},
|
|
14641
15835
|
"type": "object"
|
|
14642
15836
|
},
|
|
14643
|
-
"
|
|
14644
|
-
"description": "
|
|
14645
|
-
"id": "
|
|
15837
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata": {
|
|
15838
|
+
"description": "Describes the metadata associated with a retrieval step.",
|
|
15839
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata",
|
|
14646
15840
|
"properties": {
|
|
14647
|
-
"
|
|
14648
|
-
"
|
|
15841
|
+
"dynamicRetrievalMetadata": {
|
|
15842
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata",
|
|
15843
|
+
"description": "Metadata for dynamic retrieval."
|
|
15844
|
+
},
|
|
15845
|
+
"source": {
|
|
15846
|
+
"description": "Describes the source to which the metadata is referring to.",
|
|
15847
|
+
"enum": [
|
|
15848
|
+
"SOURCE_UNSPECIFIED",
|
|
15849
|
+
"VERTEX_AI_SEARCH",
|
|
15850
|
+
"GOOGLE_SEARCH",
|
|
15851
|
+
"INLINE_CONTENT",
|
|
15852
|
+
"GOOGLE_MAPS"
|
|
15853
|
+
],
|
|
15854
|
+
"enumDescriptions": [
|
|
15855
|
+
"Unspecified source.",
|
|
15856
|
+
"Vertex AI search.",
|
|
15857
|
+
"Google Search.",
|
|
15858
|
+
"User inline provided content.",
|
|
15859
|
+
"Google Maps."
|
|
15860
|
+
],
|
|
14649
15861
|
"type": "string"
|
|
15862
|
+
}
|
|
14650
15863
|
},
|
|
14651
|
-
"
|
|
14652
|
-
|
|
14653
|
-
"
|
|
15864
|
+
"type": "object"
|
|
15865
|
+
},
|
|
15866
|
+
"GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint": {
|
|
15867
|
+
"description": "Google search entry point.",
|
|
15868
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint",
|
|
15869
|
+
"properties": {
|
|
15870
|
+
"renderedContent": {
|
|
15871
|
+
"description": "Web content snippet that can be embedded in a web page or an app webview.",
|
|
14654
15872
|
"type": "string"
|
|
14655
15873
|
},
|
|
14656
|
-
"
|
|
15874
|
+
"sdkBlob": {
|
|
15875
|
+
"description": "Base64 encoded JSON representing array of tuple.",
|
|
15876
|
+
"format": "byte",
|
|
15877
|
+
"type": "string"
|
|
14657
15878
|
}
|
|
14658
15879
|
},
|
|
14659
15880
|
"type": "object"
|
|
@@ -14691,6 +15912,35 @@
|
|
|
14691
15912
|
},
|
|
14692
15913
|
"type": "object"
|
|
14693
15914
|
},
|
|
15915
|
+
"GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent": {
|
|
15916
|
+
"description": "Base structured datatype containing multi-part content of a message.",
|
|
15917
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent",
|
|
15918
|
+
"properties": {
|
|
15919
|
+
"parts": {
|
|
15920
|
+
"description": "Ordered `Parts` that constitute a single message.",
|
|
15921
|
+
"items": {
|
|
15922
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart"
|
|
15923
|
+
},
|
|
15924
|
+
"type": "array"
|
|
15925
|
+
},
|
|
15926
|
+
"role": {
|
|
15927
|
+
"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.",
|
|
15928
|
+
"type": "string"
|
|
15929
|
+
}
|
|
15930
|
+
},
|
|
15931
|
+
"type": "object"
|
|
15932
|
+
},
|
|
15933
|
+
"GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart": {
|
|
15934
|
+
"description": "Single part of content.",
|
|
15935
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart",
|
|
15936
|
+
"properties": {
|
|
15937
|
+
"text": {
|
|
15938
|
+
"description": "Inline text.",
|
|
15939
|
+
"type": "string"
|
|
15940
|
+
}
|
|
15941
|
+
},
|
|
15942
|
+
"type": "object"
|
|
15943
|
+
},
|
|
14694
15944
|
"GoogleCloudDiscoveryengineV1alphaGroundingFact": {
|
|
14695
15945
|
"description": "Grounding Fact.",
|
|
14696
15946
|
"id": "GoogleCloudDiscoveryengineV1alphaGroundingFact",
|
|
@@ -14729,6 +15979,18 @@
|
|
|
14729
15979
|
},
|
|
14730
15980
|
"type": "object"
|
|
14731
15981
|
},
|
|
15982
|
+
"GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig": {
|
|
15983
|
+
"description": "The configuration for the identity data synchronization runs.",
|
|
15984
|
+
"id": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig",
|
|
15985
|
+
"properties": {
|
|
15986
|
+
"refreshInterval": {
|
|
15987
|
+
"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.",
|
|
15988
|
+
"format": "google-duration",
|
|
15989
|
+
"type": "string"
|
|
15990
|
+
}
|
|
15991
|
+
},
|
|
15992
|
+
"type": "object"
|
|
15993
|
+
},
|
|
14732
15994
|
"GoogleCloudDiscoveryengineV1alphaIdpConfig": {
|
|
14733
15995
|
"description": "Identity Provider Config.",
|
|
14734
15996
|
"id": "GoogleCloudDiscoveryengineV1alphaIdpConfig",
|
|
@@ -15330,6 +16592,42 @@
|
|
|
15330
16592
|
},
|
|
15331
16593
|
"type": "object"
|
|
15332
16594
|
},
|
|
16595
|
+
"GoogleCloudDiscoveryengineV1alphaListCollectionsResponse": {
|
|
16596
|
+
"description": "Response message for CollectionService.ListCollections method.",
|
|
16597
|
+
"id": "GoogleCloudDiscoveryengineV1alphaListCollectionsResponse",
|
|
16598
|
+
"properties": {
|
|
16599
|
+
"collections": {
|
|
16600
|
+
"description": "The Collections.",
|
|
16601
|
+
"items": {
|
|
16602
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaCollection"
|
|
16603
|
+
},
|
|
16604
|
+
"type": "array"
|
|
16605
|
+
},
|
|
16606
|
+
"nextPageToken": {
|
|
16607
|
+
"description": "A token that can be sent as ListCollectionsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
|
|
16608
|
+
"type": "string"
|
|
16609
|
+
}
|
|
16610
|
+
},
|
|
16611
|
+
"type": "object"
|
|
16612
|
+
},
|
|
16613
|
+
"GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse": {
|
|
16614
|
+
"description": "Response for DataConnectorService.ListConnectorRuns method.",
|
|
16615
|
+
"id": "GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse",
|
|
16616
|
+
"properties": {
|
|
16617
|
+
"connectorRuns": {
|
|
16618
|
+
"description": "List of ConnectorRuns.",
|
|
16619
|
+
"items": {
|
|
16620
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRun"
|
|
16621
|
+
},
|
|
16622
|
+
"type": "array"
|
|
16623
|
+
},
|
|
16624
|
+
"nextPageToken": {
|
|
16625
|
+
"description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
|
|
16626
|
+
"type": "string"
|
|
16627
|
+
}
|
|
16628
|
+
},
|
|
16629
|
+
"type": "object"
|
|
16630
|
+
},
|
|
15333
16631
|
"GoogleCloudDiscoveryengineV1alphaListControlsResponse": {
|
|
15334
16632
|
"description": "Response for ListControls method.",
|
|
15335
16633
|
"id": "GoogleCloudDiscoveryengineV1alphaListControlsResponse",
|
|
@@ -18502,6 +19800,31 @@
|
|
|
18502
19800
|
},
|
|
18503
19801
|
"type": "object"
|
|
18504
19802
|
},
|
|
19803
|
+
"GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata": {
|
|
19804
|
+
"description": "Metadata for DataConnectorService.SetUpDataConnector method.",
|
|
19805
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata",
|
|
19806
|
+
"properties": {},
|
|
19807
|
+
"type": "object"
|
|
19808
|
+
},
|
|
19809
|
+
"GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest": {
|
|
19810
|
+
"description": "Request for DataConnectorService.SetUpDataConnector method.",
|
|
19811
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest",
|
|
19812
|
+
"properties": {
|
|
19813
|
+
"collectionDisplayName": {
|
|
19814
|
+
"description": "Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.",
|
|
19815
|
+
"type": "string"
|
|
19816
|
+
},
|
|
19817
|
+
"collectionId": {
|
|
19818
|
+
"description": "Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
|
|
19819
|
+
"type": "string"
|
|
19820
|
+
},
|
|
19821
|
+
"dataConnector": {
|
|
19822
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector",
|
|
19823
|
+
"description": "Required. The DataConnector to initialize in the newly created Collection."
|
|
19824
|
+
}
|
|
19825
|
+
},
|
|
19826
|
+
"type": "object"
|
|
19827
|
+
},
|
|
18505
19828
|
"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": {
|
|
18506
19829
|
"description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
18507
19830
|
"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata",
|
|
@@ -18555,6 +19878,17 @@
|
|
|
18555
19878
|
"properties": {},
|
|
18556
19879
|
"type": "object"
|
|
18557
19880
|
},
|
|
19881
|
+
"GoogleCloudDiscoveryengineV1alphaSingleRegionKey": {
|
|
19882
|
+
"description": "Metadata for single-regional CMEKs.",
|
|
19883
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSingleRegionKey",
|
|
19884
|
+
"properties": {
|
|
19885
|
+
"kmsKey": {
|
|
19886
|
+
"description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
|
|
19887
|
+
"type": "string"
|
|
19888
|
+
}
|
|
19889
|
+
},
|
|
19890
|
+
"type": "object"
|
|
19891
|
+
},
|
|
18558
19892
|
"GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": {
|
|
18559
19893
|
"description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.",
|
|
18560
19894
|
"id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine",
|
|
@@ -18643,6 +19977,36 @@
|
|
|
18643
19977
|
},
|
|
18644
19978
|
"type": "object"
|
|
18645
19979
|
},
|
|
19980
|
+
"GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest": {
|
|
19981
|
+
"description": "Request message for DataConnectorService.StartConnectorRun method.",
|
|
19982
|
+
"id": "GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest",
|
|
19983
|
+
"properties": {
|
|
19984
|
+
"entities": {
|
|
19985
|
+
"description": "Specifies which Third Party Connector entities should be synced. If not specified, all entities will be synced.",
|
|
19986
|
+
"items": {
|
|
19987
|
+
"type": "string"
|
|
19988
|
+
},
|
|
19989
|
+
"type": "array"
|
|
19990
|
+
},
|
|
19991
|
+
"healthcareFhirResourceTypes": {
|
|
19992
|
+
"description": "The FHIR resource types to import. The resource types should be a subset of all supported FHIR resource types http://shortn/_J8ymdyOokT. Default to all supported FHIR resource types if empty.",
|
|
19993
|
+
"items": {
|
|
19994
|
+
"type": "string"
|
|
19995
|
+
},
|
|
19996
|
+
"type": "array"
|
|
19997
|
+
},
|
|
19998
|
+
"syncIdentity": {
|
|
19999
|
+
"description": "If true, trigger Identity sync.",
|
|
20000
|
+
"type": "boolean"
|
|
20001
|
+
},
|
|
20002
|
+
"syncSinceTimestamp": {
|
|
20003
|
+
"description": "Timestamp to indicate the point in time from which data should be synced for Streaming/Batch Data Connectors. This field is only utilized for Healthcare Connectors.",
|
|
20004
|
+
"format": "google-datetime",
|
|
20005
|
+
"type": "string"
|
|
20006
|
+
}
|
|
20007
|
+
},
|
|
20008
|
+
"type": "object"
|
|
20009
|
+
},
|
|
18646
20010
|
"GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry": {
|
|
18647
20011
|
"description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.",
|
|
18648
20012
|
"id": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry",
|
|
@@ -18957,6 +20321,23 @@
|
|
|
18957
20321
|
},
|
|
18958
20322
|
"type": "object"
|
|
18959
20323
|
},
|
|
20324
|
+
"GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata": {
|
|
20325
|
+
"description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
20326
|
+
"id": "GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata",
|
|
20327
|
+
"properties": {
|
|
20328
|
+
"createTime": {
|
|
20329
|
+
"description": "Operation create time.",
|
|
20330
|
+
"format": "google-datetime",
|
|
20331
|
+
"type": "string"
|
|
20332
|
+
},
|
|
20333
|
+
"updateTime": {
|
|
20334
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
20335
|
+
"format": "google-datetime",
|
|
20336
|
+
"type": "string"
|
|
20337
|
+
}
|
|
20338
|
+
},
|
|
20339
|
+
"type": "object"
|
|
20340
|
+
},
|
|
18960
20341
|
"GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": {
|
|
18961
20342
|
"description": "Metadata for UpdateSchema LRO.",
|
|
18962
20343
|
"id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata",
|
|
@@ -19240,6 +20621,13 @@
|
|
|
19240
20621
|
"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
19241
20622
|
"type": "string"
|
|
19242
20623
|
},
|
|
20624
|
+
"singleRegionKeys": {
|
|
20625
|
+
"description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
|
|
20626
|
+
"items": {
|
|
20627
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSingleRegionKey"
|
|
20628
|
+
},
|
|
20629
|
+
"type": "array"
|
|
20630
|
+
},
|
|
19243
20631
|
"state": {
|
|
19244
20632
|
"description": "Output only. State of the CmekConfig.",
|
|
19245
20633
|
"enum": [
|
|
@@ -19645,6 +21033,10 @@
|
|
|
19645
21033
|
],
|
|
19646
21034
|
"type": "string"
|
|
19647
21035
|
},
|
|
21036
|
+
"isInfobotFaqDataStore": {
|
|
21037
|
+
"description": "Optional. If set, this DataStore is an Infobot FAQ DataStore.",
|
|
21038
|
+
"type": "boolean"
|
|
21039
|
+
},
|
|
19648
21040
|
"kmsKeyName": {
|
|
19649
21041
|
"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.",
|
|
19650
21042
|
"type": "string"
|
|
@@ -21579,6 +22971,17 @@
|
|
|
21579
22971
|
},
|
|
21580
22972
|
"type": "object"
|
|
21581
22973
|
},
|
|
22974
|
+
"GoogleCloudDiscoveryengineV1betaSingleRegionKey": {
|
|
22975
|
+
"description": "Metadata for single-regional CMEKs.",
|
|
22976
|
+
"id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey",
|
|
22977
|
+
"properties": {
|
|
22978
|
+
"kmsKey": {
|
|
22979
|
+
"description": "Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
|
|
22980
|
+
"type": "string"
|
|
22981
|
+
}
|
|
22982
|
+
},
|
|
22983
|
+
"type": "object"
|
|
22984
|
+
},
|
|
21582
22985
|
"GoogleCloudDiscoveryengineV1betaSiteVerificationInfo": {
|
|
21583
22986
|
"description": "Verification information for target sites in advanced site search.",
|
|
21584
22987
|
"id": "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo",
|
|
@@ -22138,6 +23541,57 @@
|
|
|
22138
23541
|
},
|
|
22139
23542
|
"type": "object"
|
|
22140
23543
|
},
|
|
23544
|
+
"GoogleTypeDateTime": {
|
|
23545
|
+
"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.",
|
|
23546
|
+
"id": "GoogleTypeDateTime",
|
|
23547
|
+
"properties": {
|
|
23548
|
+
"day": {
|
|
23549
|
+
"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.",
|
|
23550
|
+
"format": "int32",
|
|
23551
|
+
"type": "integer"
|
|
23552
|
+
},
|
|
23553
|
+
"hours": {
|
|
23554
|
+
"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.",
|
|
23555
|
+
"format": "int32",
|
|
23556
|
+
"type": "integer"
|
|
23557
|
+
},
|
|
23558
|
+
"minutes": {
|
|
23559
|
+
"description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.",
|
|
23560
|
+
"format": "int32",
|
|
23561
|
+
"type": "integer"
|
|
23562
|
+
},
|
|
23563
|
+
"month": {
|
|
23564
|
+
"description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.",
|
|
23565
|
+
"format": "int32",
|
|
23566
|
+
"type": "integer"
|
|
23567
|
+
},
|
|
23568
|
+
"nanos": {
|
|
23569
|
+
"description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.",
|
|
23570
|
+
"format": "int32",
|
|
23571
|
+
"type": "integer"
|
|
23572
|
+
},
|
|
23573
|
+
"seconds": {
|
|
23574
|
+
"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.",
|
|
23575
|
+
"format": "int32",
|
|
23576
|
+
"type": "integer"
|
|
23577
|
+
},
|
|
23578
|
+
"timeZone": {
|
|
23579
|
+
"$ref": "GoogleTypeTimeZone",
|
|
23580
|
+
"description": "Time zone."
|
|
23581
|
+
},
|
|
23582
|
+
"utcOffset": {
|
|
23583
|
+
"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 }.",
|
|
23584
|
+
"format": "google-duration",
|
|
23585
|
+
"type": "string"
|
|
23586
|
+
},
|
|
23587
|
+
"year": {
|
|
23588
|
+
"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.",
|
|
23589
|
+
"format": "int32",
|
|
23590
|
+
"type": "integer"
|
|
23591
|
+
}
|
|
23592
|
+
},
|
|
23593
|
+
"type": "object"
|
|
23594
|
+
},
|
|
22141
23595
|
"GoogleTypeExpr": {
|
|
22142
23596
|
"description": "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.",
|
|
22143
23597
|
"id": "GoogleTypeExpr",
|
|
@@ -22160,6 +23614,21 @@
|
|
|
22160
23614
|
}
|
|
22161
23615
|
},
|
|
22162
23616
|
"type": "object"
|
|
23617
|
+
},
|
|
23618
|
+
"GoogleTypeTimeZone": {
|
|
23619
|
+
"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
|
|
23620
|
+
"id": "GoogleTypeTimeZone",
|
|
23621
|
+
"properties": {
|
|
23622
|
+
"id": {
|
|
23623
|
+
"description": "IANA Time Zone Database time zone. For example \"America/New_York\".",
|
|
23624
|
+
"type": "string"
|
|
23625
|
+
},
|
|
23626
|
+
"version": {
|
|
23627
|
+
"description": "Optional. IANA Time Zone Database version number. For example \"2019a\".",
|
|
23628
|
+
"type": "string"
|
|
23629
|
+
}
|
|
23630
|
+
},
|
|
23631
|
+
"type": "object"
|
|
22163
23632
|
}
|
|
22164
23633
|
},
|
|
22165
23634
|
"servicePath": "",
|