@googleapis/discoveryengine 24.0.0 → 25.1.0
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.
- package/CHANGELOG.md +18 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +2919 -375
- package/build/v1.js +331 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +3556 -215
- package/build/v1alpha.js +638 -3
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +2020 -45
- package/build/v1beta.js +169 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +3680 -298
- package/v1alpha.ts +5371 -409
- package/v1beta.ts +2659 -270
package/build/v1beta.d.ts
CHANGED
|
@@ -732,6 +732,46 @@ export declare namespace discoveryengine_v1beta {
|
|
|
732
732
|
*/
|
|
733
733
|
functionName?: string | null;
|
|
734
734
|
}
|
|
735
|
+
/**
|
|
736
|
+
* Access Control Configuration.
|
|
737
|
+
*/
|
|
738
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AclConfig {
|
|
739
|
+
/**
|
|
740
|
+
* Identity provider config.
|
|
741
|
+
*/
|
|
742
|
+
idpConfig?: Schema$GoogleCloudDiscoveryengineV1IdpConfig;
|
|
743
|
+
/**
|
|
744
|
+
* Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
745
|
+
*/
|
|
746
|
+
name?: string | null;
|
|
747
|
+
}
|
|
748
|
+
/**
|
|
749
|
+
* Informations to support actions on the connector.
|
|
750
|
+
*/
|
|
751
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ActionConfig {
|
|
752
|
+
/**
|
|
753
|
+
* Optional. Action parameters in structured json format.
|
|
754
|
+
*/
|
|
755
|
+
actionParams?: {
|
|
756
|
+
[key: string]: any;
|
|
757
|
+
} | null;
|
|
758
|
+
/**
|
|
759
|
+
* Output only. The connector contains the necessary parameters and is configured to support actions.
|
|
760
|
+
*/
|
|
761
|
+
isActionConfigured?: boolean | null;
|
|
762
|
+
/**
|
|
763
|
+
* Optional. Action parameters in json string format.
|
|
764
|
+
*/
|
|
765
|
+
jsonActionParams?: string | null;
|
|
766
|
+
/**
|
|
767
|
+
* Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.
|
|
768
|
+
*/
|
|
769
|
+
serviceName?: string | null;
|
|
770
|
+
/**
|
|
771
|
+
* Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.
|
|
772
|
+
*/
|
|
773
|
+
useStaticSecrets?: boolean | null;
|
|
774
|
+
}
|
|
735
775
|
/**
|
|
736
776
|
* Configuration data for advance site search.
|
|
737
777
|
*/
|
|
@@ -745,6 +785,72 @@ export declare namespace discoveryengine_v1beta {
|
|
|
745
785
|
*/
|
|
746
786
|
disableInitialIndex?: boolean | null;
|
|
747
787
|
}
|
|
788
|
+
/**
|
|
789
|
+
* The connector level alert config.
|
|
790
|
+
*/
|
|
791
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfig {
|
|
792
|
+
/**
|
|
793
|
+
* Optional. The enrollment states of each alert.
|
|
794
|
+
*/
|
|
795
|
+
alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment[];
|
|
796
|
+
/**
|
|
797
|
+
* Immutable. The fully qualified resource name of the AlertPolicy.
|
|
798
|
+
*/
|
|
799
|
+
alertPolicyName?: string | null;
|
|
800
|
+
}
|
|
801
|
+
/**
|
|
802
|
+
* The alert enrollment status.
|
|
803
|
+
*/
|
|
804
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment {
|
|
805
|
+
/**
|
|
806
|
+
* Immutable. The id of an alert.
|
|
807
|
+
*/
|
|
808
|
+
alertId?: string | null;
|
|
809
|
+
/**
|
|
810
|
+
* Required. The enrollment status of a customer.
|
|
811
|
+
*/
|
|
812
|
+
enrollState?: string | null;
|
|
813
|
+
}
|
|
814
|
+
/**
|
|
815
|
+
* The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.
|
|
816
|
+
*/
|
|
817
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig {
|
|
818
|
+
/**
|
|
819
|
+
* Optional. The enrollment state of each alert.
|
|
820
|
+
*/
|
|
821
|
+
alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment[];
|
|
822
|
+
/**
|
|
823
|
+
* Immutable. The fully qualified resource name of the AlertPolicy.
|
|
824
|
+
*/
|
|
825
|
+
alertPolicy?: string | null;
|
|
826
|
+
/**
|
|
827
|
+
* Optional. The contact details for each alert policy.
|
|
828
|
+
*/
|
|
829
|
+
contactDetails?: Schema$GoogleCloudDiscoveryengineV1ContactDetails[];
|
|
830
|
+
/**
|
|
831
|
+
* Optional. The language code used for notifications
|
|
832
|
+
*/
|
|
833
|
+
languageCode?: string | null;
|
|
834
|
+
}
|
|
835
|
+
/**
|
|
836
|
+
* The alert enrollment status.
|
|
837
|
+
*/
|
|
838
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment {
|
|
839
|
+
/**
|
|
840
|
+
* Immutable. The id of an alert.
|
|
841
|
+
*/
|
|
842
|
+
alertId?: string | null;
|
|
843
|
+
/**
|
|
844
|
+
* Required. The enrollment status of a customer.
|
|
845
|
+
*/
|
|
846
|
+
enrollState?: string | null;
|
|
847
|
+
/**
|
|
848
|
+
* Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
|
|
849
|
+
*/
|
|
850
|
+
notificationParams?: {
|
|
851
|
+
[key: string]: string;
|
|
852
|
+
} | null;
|
|
853
|
+
}
|
|
748
854
|
/**
|
|
749
855
|
* Access Control Configuration.
|
|
750
856
|
*/
|
|
@@ -763,7 +869,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
763
869
|
*/
|
|
764
870
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaActionConfig {
|
|
765
871
|
/**
|
|
766
|
-
*
|
|
872
|
+
* Optional. Action parameters in structured json format.
|
|
767
873
|
*/
|
|
768
874
|
actionParams?: {
|
|
769
875
|
[key: string]: any;
|
|
@@ -772,6 +878,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
772
878
|
* Output only. The connector contains the necessary parameters and is configured to support actions.
|
|
773
879
|
*/
|
|
774
880
|
isActionConfigured?: boolean | null;
|
|
881
|
+
/**
|
|
882
|
+
* Optional. Action parameters in json string format.
|
|
883
|
+
*/
|
|
884
|
+
jsonActionParams?: string | null;
|
|
775
885
|
/**
|
|
776
886
|
* Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.
|
|
777
887
|
*/
|
|
@@ -820,6 +930,46 @@ export declare namespace discoveryengine_v1beta {
|
|
|
820
930
|
*/
|
|
821
931
|
enrollState?: string | null;
|
|
822
932
|
}
|
|
933
|
+
/**
|
|
934
|
+
* The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.
|
|
935
|
+
*/
|
|
936
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig {
|
|
937
|
+
/**
|
|
938
|
+
* Optional. The enrollment state of each alert.
|
|
939
|
+
*/
|
|
940
|
+
alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment[];
|
|
941
|
+
/**
|
|
942
|
+
* Immutable. The fully qualified resource name of the AlertPolicy.
|
|
943
|
+
*/
|
|
944
|
+
alertPolicy?: string | null;
|
|
945
|
+
/**
|
|
946
|
+
* Optional. The contact details for each alert policy.
|
|
947
|
+
*/
|
|
948
|
+
contactDetails?: Schema$GoogleCloudDiscoveryengineV1alphaContactDetails[];
|
|
949
|
+
/**
|
|
950
|
+
* Optional. The language code used for notifications
|
|
951
|
+
*/
|
|
952
|
+
languageCode?: string | null;
|
|
953
|
+
}
|
|
954
|
+
/**
|
|
955
|
+
* The alert enrollment status.
|
|
956
|
+
*/
|
|
957
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment {
|
|
958
|
+
/**
|
|
959
|
+
* Immutable. The id of an alert.
|
|
960
|
+
*/
|
|
961
|
+
alertId?: string | null;
|
|
962
|
+
/**
|
|
963
|
+
* Required. The enrollment status of a customer.
|
|
964
|
+
*/
|
|
965
|
+
enrollState?: string | null;
|
|
966
|
+
/**
|
|
967
|
+
* Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
|
|
968
|
+
*/
|
|
969
|
+
notificationParams?: {
|
|
970
|
+
[key: string]: string;
|
|
971
|
+
} | null;
|
|
972
|
+
}
|
|
823
973
|
/**
|
|
824
974
|
* Defines an answer.
|
|
825
975
|
*/
|
|
@@ -1234,10 +1384,274 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1234
1384
|
*/
|
|
1235
1385
|
query?: string | null;
|
|
1236
1386
|
}
|
|
1387
|
+
/**
|
|
1388
|
+
* AssistAnswer resource, main part of AssistResponse.
|
|
1389
|
+
*/
|
|
1390
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswer {
|
|
1391
|
+
/**
|
|
1392
|
+
* Reasons for not answering the assist call.
|
|
1393
|
+
*/
|
|
1394
|
+
assistSkippedReasons?: string[] | null;
|
|
1395
|
+
/**
|
|
1396
|
+
* Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.
|
|
1397
|
+
*/
|
|
1398
|
+
customerPolicyEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult;
|
|
1399
|
+
/**
|
|
1400
|
+
* Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/assistAnswers/{assist_answer\}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
1401
|
+
*/
|
|
1402
|
+
name?: string | null;
|
|
1403
|
+
/**
|
|
1404
|
+
* Replies of the assistant.
|
|
1405
|
+
*/
|
|
1406
|
+
replies?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerReply[];
|
|
1407
|
+
/**
|
|
1408
|
+
* State of the answer generation.
|
|
1409
|
+
*/
|
|
1410
|
+
state?: string | null;
|
|
1411
|
+
}
|
|
1412
|
+
/**
|
|
1413
|
+
* Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.
|
|
1414
|
+
*/
|
|
1415
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult {
|
|
1416
|
+
/**
|
|
1417
|
+
* Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query.
|
|
1418
|
+
*/
|
|
1419
|
+
policyResults?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult[];
|
|
1420
|
+
/**
|
|
1421
|
+
* Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.
|
|
1422
|
+
*/
|
|
1423
|
+
verdict?: string | null;
|
|
1424
|
+
}
|
|
1425
|
+
/**
|
|
1426
|
+
* Customer policy enforcement result for the banned phrase policy.
|
|
1427
|
+
*/
|
|
1428
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult {
|
|
1429
|
+
/**
|
|
1430
|
+
* The banned phrases that were found in the query or the answer.
|
|
1431
|
+
*/
|
|
1432
|
+
bannedPhrases?: string[] | null;
|
|
1433
|
+
}
|
|
1434
|
+
/**
|
|
1435
|
+
* Customer policy enforcement result for the Model Armor policy.
|
|
1436
|
+
*/
|
|
1437
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult {
|
|
1438
|
+
/**
|
|
1439
|
+
* The error returned by Model Armor if the policy enforcement failed for some reason.
|
|
1440
|
+
*/
|
|
1441
|
+
error?: Schema$GoogleRpcStatus;
|
|
1442
|
+
/**
|
|
1443
|
+
* The Model Armor violation that was found.
|
|
1444
|
+
*/
|
|
1445
|
+
modelArmorViolation?: string | null;
|
|
1446
|
+
}
|
|
1447
|
+
/**
|
|
1448
|
+
* Customer policy enforcement result for a single policy type.
|
|
1449
|
+
*/
|
|
1450
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult {
|
|
1451
|
+
/**
|
|
1452
|
+
* The policy enforcement result for the banned phrase policy.
|
|
1453
|
+
*/
|
|
1454
|
+
bannedPhraseEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult;
|
|
1455
|
+
/**
|
|
1456
|
+
* The policy enforcement result for the Model Armor policy.
|
|
1457
|
+
*/
|
|
1458
|
+
modelArmorEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult;
|
|
1459
|
+
}
|
|
1460
|
+
/**
|
|
1461
|
+
* One part of the multi-part response of the assist call.
|
|
1462
|
+
*/
|
|
1463
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswerReply {
|
|
1464
|
+
/**
|
|
1465
|
+
* Possibly grounded response text or media from the assistant.
|
|
1466
|
+
*/
|
|
1467
|
+
groundedContent?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent;
|
|
1468
|
+
/**
|
|
1469
|
+
* Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource.
|
|
1470
|
+
*/
|
|
1471
|
+
replyId?: string | null;
|
|
1472
|
+
}
|
|
1473
|
+
/**
|
|
1474
|
+
* Multi-modal content.
|
|
1475
|
+
*/
|
|
1476
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantContent {
|
|
1477
|
+
/**
|
|
1478
|
+
* Result of executing an ExecutableCode.
|
|
1479
|
+
*/
|
|
1480
|
+
codeExecutionResult?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult;
|
|
1481
|
+
/**
|
|
1482
|
+
* Code generated by the model that is meant to be executed.
|
|
1483
|
+
*/
|
|
1484
|
+
executableCode?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode;
|
|
1485
|
+
/**
|
|
1486
|
+
* A file, e.g., an audio summary.
|
|
1487
|
+
*/
|
|
1488
|
+
file?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentFile;
|
|
1489
|
+
/**
|
|
1490
|
+
* Inline binary data.
|
|
1491
|
+
*/
|
|
1492
|
+
inlineData?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentBlob;
|
|
1493
|
+
/**
|
|
1494
|
+
* The producer of the content. Can be "model" or "user".
|
|
1495
|
+
*/
|
|
1496
|
+
role?: string | null;
|
|
1497
|
+
/**
|
|
1498
|
+
* Inline text.
|
|
1499
|
+
*/
|
|
1500
|
+
text?: string | null;
|
|
1501
|
+
/**
|
|
1502
|
+
* Optional. Indicates if the part is thought from the model.
|
|
1503
|
+
*/
|
|
1504
|
+
thought?: boolean | null;
|
|
1505
|
+
}
|
|
1506
|
+
/**
|
|
1507
|
+
* Inline blob.
|
|
1508
|
+
*/
|
|
1509
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentBlob {
|
|
1510
|
+
/**
|
|
1511
|
+
* Required. Raw bytes.
|
|
1512
|
+
*/
|
|
1513
|
+
data?: string | null;
|
|
1514
|
+
/**
|
|
1515
|
+
* Required. The media type (MIME type) of the generated data.
|
|
1516
|
+
*/
|
|
1517
|
+
mimeType?: string | null;
|
|
1518
|
+
}
|
|
1519
|
+
/**
|
|
1520
|
+
* Result of executing ExecutableCode.
|
|
1521
|
+
*/
|
|
1522
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult {
|
|
1523
|
+
/**
|
|
1524
|
+
* Required. Outcome of the code execution.
|
|
1525
|
+
*/
|
|
1526
|
+
outcome?: string | null;
|
|
1527
|
+
/**
|
|
1528
|
+
* Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
|
|
1529
|
+
*/
|
|
1530
|
+
output?: string | null;
|
|
1531
|
+
}
|
|
1532
|
+
/**
|
|
1533
|
+
* Code generated by the model that is meant to be executed by the model.
|
|
1534
|
+
*/
|
|
1535
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode {
|
|
1536
|
+
/**
|
|
1537
|
+
* Required. The code content. Currently only supports Python.
|
|
1538
|
+
*/
|
|
1539
|
+
code?: string | null;
|
|
1540
|
+
}
|
|
1541
|
+
/**
|
|
1542
|
+
* A file, e.g., an audio summary.
|
|
1543
|
+
*/
|
|
1544
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantContentFile {
|
|
1545
|
+
/**
|
|
1546
|
+
* Required. The file ID.
|
|
1547
|
+
*/
|
|
1548
|
+
fileId?: string | null;
|
|
1549
|
+
/**
|
|
1550
|
+
* Required. The media type (MIME type) of the file.
|
|
1551
|
+
*/
|
|
1552
|
+
mimeType?: string | null;
|
|
1553
|
+
}
|
|
1554
|
+
/**
|
|
1555
|
+
* A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding.
|
|
1556
|
+
*/
|
|
1557
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent {
|
|
1558
|
+
/**
|
|
1559
|
+
* The content.
|
|
1560
|
+
*/
|
|
1561
|
+
content?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantContent;
|
|
1562
|
+
/**
|
|
1563
|
+
* Metadata for grounding based on text sources.
|
|
1564
|
+
*/
|
|
1565
|
+
textGroundingMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata;
|
|
1566
|
+
}
|
|
1567
|
+
/**
|
|
1568
|
+
* Grounding details for text sources.
|
|
1569
|
+
*/
|
|
1570
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata {
|
|
1571
|
+
/**
|
|
1572
|
+
* References for the grounded text.
|
|
1573
|
+
*/
|
|
1574
|
+
references?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference[];
|
|
1575
|
+
/**
|
|
1576
|
+
* Grounding information for parts of the text.
|
|
1577
|
+
*/
|
|
1578
|
+
segments?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment[];
|
|
1579
|
+
}
|
|
1580
|
+
/**
|
|
1581
|
+
* Referenced content and related document metadata.
|
|
1582
|
+
*/
|
|
1583
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference {
|
|
1584
|
+
/**
|
|
1585
|
+
* Referenced text content.
|
|
1586
|
+
*/
|
|
1587
|
+
content?: string | null;
|
|
1588
|
+
/**
|
|
1589
|
+
* Document metadata.
|
|
1590
|
+
*/
|
|
1591
|
+
documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata;
|
|
1592
|
+
}
|
|
1593
|
+
/**
|
|
1594
|
+
* Document metadata.
|
|
1595
|
+
*/
|
|
1596
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata {
|
|
1597
|
+
/**
|
|
1598
|
+
* Document resource name.
|
|
1599
|
+
*/
|
|
1600
|
+
document?: string | null;
|
|
1601
|
+
/**
|
|
1602
|
+
* Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.
|
|
1603
|
+
*/
|
|
1604
|
+
domain?: string | null;
|
|
1605
|
+
/**
|
|
1606
|
+
* The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.
|
|
1607
|
+
*/
|
|
1608
|
+
mimeType?: string | null;
|
|
1609
|
+
/**
|
|
1610
|
+
* Page identifier.
|
|
1611
|
+
*/
|
|
1612
|
+
pageIdentifier?: string | null;
|
|
1613
|
+
/**
|
|
1614
|
+
* Title.
|
|
1615
|
+
*/
|
|
1616
|
+
title?: string | null;
|
|
1617
|
+
/**
|
|
1618
|
+
* URI for the document. It may contain a URL that redirects to the actual website.
|
|
1619
|
+
*/
|
|
1620
|
+
uri?: string | null;
|
|
1621
|
+
}
|
|
1622
|
+
/**
|
|
1623
|
+
* Grounding information for a segment of the text.
|
|
1624
|
+
*/
|
|
1625
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment {
|
|
1626
|
+
/**
|
|
1627
|
+
* End of the segment, exclusive.
|
|
1628
|
+
*/
|
|
1629
|
+
endIndex?: string | null;
|
|
1630
|
+
/**
|
|
1631
|
+
* Score for the segment.
|
|
1632
|
+
*/
|
|
1633
|
+
groundingScore?: number | null;
|
|
1634
|
+
/**
|
|
1635
|
+
* References for the segment.
|
|
1636
|
+
*/
|
|
1637
|
+
referenceIndices?: number[] | null;
|
|
1638
|
+
/**
|
|
1639
|
+
* Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one).
|
|
1640
|
+
*/
|
|
1641
|
+
startIndex?: string | null;
|
|
1642
|
+
/**
|
|
1643
|
+
* The text segment itself.
|
|
1644
|
+
*/
|
|
1645
|
+
text?: string | null;
|
|
1646
|
+
}
|
|
1237
1647
|
/**
|
|
1238
1648
|
* The configuration for the BAP connector.
|
|
1239
1649
|
*/
|
|
1240
1650
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaBAPConfig {
|
|
1651
|
+
/**
|
|
1652
|
+
* Optional. The actions enabled on the associated BAP connection.
|
|
1653
|
+
*/
|
|
1654
|
+
enabledActions?: string[] | null;
|
|
1241
1655
|
/**
|
|
1242
1656
|
* Required. The supported connector modes for the associated BAP connection.
|
|
1243
1657
|
*/
|
|
@@ -1515,6 +1929,15 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1515
1929
|
*/
|
|
1516
1930
|
totalCount?: string | null;
|
|
1517
1931
|
}
|
|
1932
|
+
/**
|
|
1933
|
+
* The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
|
|
1934
|
+
*/
|
|
1935
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaContactDetails {
|
|
1936
|
+
/**
|
|
1937
|
+
* Optional. The email address of the contact.
|
|
1938
|
+
*/
|
|
1939
|
+
emailAddress?: string | null;
|
|
1940
|
+
}
|
|
1518
1941
|
/**
|
|
1519
1942
|
* 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`.
|
|
1520
1943
|
*/
|
|
@@ -1823,6 +2246,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1823
2246
|
* Output only. The errors from initialization or from the latest connector run.
|
|
1824
2247
|
*/
|
|
1825
2248
|
errors?: Schema$GoogleRpcStatus[];
|
|
2249
|
+
/**
|
|
2250
|
+
* Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.
|
|
2251
|
+
*/
|
|
2252
|
+
federatedConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig;
|
|
1826
2253
|
/**
|
|
1827
2254
|
* Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.
|
|
1828
2255
|
*/
|
|
@@ -1843,6 +2270,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1843
2270
|
* Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
|
|
1844
2271
|
*/
|
|
1845
2272
|
incrementalSyncDisabled?: boolean | null;
|
|
2273
|
+
/**
|
|
2274
|
+
* Required data connector parameters in json string format.
|
|
2275
|
+
*/
|
|
2276
|
+
jsonParams?: string | null;
|
|
1846
2277
|
/**
|
|
1847
2278
|
* 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.
|
|
1848
2279
|
*/
|
|
@@ -1864,7 +2295,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1864
2295
|
*/
|
|
1865
2296
|
nextSyncTime?: Schema$GoogleTypeDateTime;
|
|
1866
2297
|
/**
|
|
1867
|
-
* Required
|
|
2298
|
+
* Required data connector parameters in structured json format.
|
|
1868
2299
|
*/
|
|
1869
2300
|
params?: {
|
|
1870
2301
|
[key: string]: any;
|
|
@@ -1885,6 +2316,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1885
2316
|
* 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. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
|
|
1886
2317
|
*/
|
|
1887
2318
|
refreshInterval?: string | null;
|
|
2319
|
+
/**
|
|
2320
|
+
* Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.
|
|
2321
|
+
*/
|
|
2322
|
+
removeParamKeys?: string[] | null;
|
|
1888
2323
|
/**
|
|
1889
2324
|
* Output only. State of the connector.
|
|
1890
2325
|
*/
|
|
@@ -1922,11 +2357,36 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1922
2357
|
authParams?: {
|
|
1923
2358
|
[key: string]: any;
|
|
1924
2359
|
} | null;
|
|
2360
|
+
/**
|
|
2361
|
+
* Optional. Any authentication parameters specific to EUA connectors in json string format.
|
|
2362
|
+
*/
|
|
2363
|
+
jsonAuthParams?: string | null;
|
|
1925
2364
|
/**
|
|
1926
2365
|
* Optional. The tenant project the connector is connected to.
|
|
1927
2366
|
*/
|
|
1928
2367
|
tenant?: Schema$GoogleCloudDiscoveryengineV1alphaTenant;
|
|
1929
2368
|
}
|
|
2369
|
+
/**
|
|
2370
|
+
* Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.
|
|
2371
|
+
*/
|
|
2372
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig {
|
|
2373
|
+
/**
|
|
2374
|
+
* Optional. Any additional parameters needed for FEDERATED.
|
|
2375
|
+
*/
|
|
2376
|
+
additionalParams?: {
|
|
2377
|
+
[key: string]: any;
|
|
2378
|
+
} | null;
|
|
2379
|
+
/**
|
|
2380
|
+
* Optional. Any authentication parameters specific to FEDERATED connectors.
|
|
2381
|
+
*/
|
|
2382
|
+
authParams?: {
|
|
2383
|
+
[key: string]: any;
|
|
2384
|
+
} | null;
|
|
2385
|
+
/**
|
|
2386
|
+
* Optional. Any authentication parameters specific to FEDERATED connectors in json string format.
|
|
2387
|
+
*/
|
|
2388
|
+
jsonAuthParams?: string | null;
|
|
2389
|
+
}
|
|
1930
2390
|
/**
|
|
1931
2391
|
* The configuration for realtime sync to store additional params for realtime sync.
|
|
1932
2392
|
*/
|
|
@@ -1973,6 +2433,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1973
2433
|
* Optional. Configuration for `HEALTHCARE_FHIR` vertical.
|
|
1974
2434
|
*/
|
|
1975
2435
|
healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig;
|
|
2436
|
+
/**
|
|
2437
|
+
* The parameters for the entity to facilitate data ingestion in json string format.
|
|
2438
|
+
*/
|
|
2439
|
+
jsonParams?: string | null;
|
|
1976
2440
|
/**
|
|
1977
2441
|
* 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.
|
|
1978
2442
|
*/
|
|
@@ -1980,7 +2444,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
1980
2444
|
[key: string]: string;
|
|
1981
2445
|
} | null;
|
|
1982
2446
|
/**
|
|
1983
|
-
* The parameters for the entity to facilitate data ingestion
|
|
2447
|
+
* The parameters for the entity to facilitate data ingestion in structured json format.
|
|
1984
2448
|
*/
|
|
1985
2449
|
params?: {
|
|
1986
2450
|
[key: string]: any;
|
|
@@ -2010,6 +2474,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2010
2474
|
* Output only. CMEK-related information for the DataStore.
|
|
2011
2475
|
*/
|
|
2012
2476
|
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig;
|
|
2477
|
+
/**
|
|
2478
|
+
* Optional. Configuration for configurable billing approach. See
|
|
2479
|
+
*/
|
|
2480
|
+
configurableBillingApproach?: string | null;
|
|
2013
2481
|
/**
|
|
2014
2482
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
2015
2483
|
*/
|
|
@@ -2263,12 +2731,16 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2263
2731
|
* Optional. The destinations for the corresponding key.
|
|
2264
2732
|
*/
|
|
2265
2733
|
destinations?: Schema$GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination[];
|
|
2734
|
+
/**
|
|
2735
|
+
* Additional parameters for this destination config in json string format.
|
|
2736
|
+
*/
|
|
2737
|
+
jsonParams?: string | null;
|
|
2266
2738
|
/**
|
|
2267
2739
|
* Optional. Unique destination identifier that is supported by the connector.
|
|
2268
2740
|
*/
|
|
2269
2741
|
key?: string | null;
|
|
2270
2742
|
/**
|
|
2271
|
-
* Optional. Additional parameters for this destination config.
|
|
2743
|
+
* Optional. Additional parameters for this destination config in structured json format.
|
|
2272
2744
|
*/
|
|
2273
2745
|
params?: {
|
|
2274
2746
|
[key: string]: any;
|
|
@@ -2440,6 +2912,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2440
2912
|
* Metadata that describes the training and serving parameters of an Engine.
|
|
2441
2913
|
*/
|
|
2442
2914
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine {
|
|
2915
|
+
/**
|
|
2916
|
+
* Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
|
|
2917
|
+
*/
|
|
2918
|
+
appType?: string | null;
|
|
2443
2919
|
/**
|
|
2444
2920
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
2445
2921
|
*/
|
|
@@ -2452,6 +2928,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2452
2928
|
* Common config spec that specifies the metadata of the engine.
|
|
2453
2929
|
*/
|
|
2454
2930
|
commonConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig;
|
|
2931
|
+
/**
|
|
2932
|
+
* Optional. Configuration for configurable billing approach.
|
|
2933
|
+
*/
|
|
2934
|
+
configurableBillingApproach?: string | null;
|
|
2455
2935
|
/**
|
|
2456
2936
|
* Output only. Timestamp the Recommendation Engine was created at.
|
|
2457
2937
|
*/
|
|
@@ -2469,7 +2949,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2469
2949
|
*/
|
|
2470
2950
|
displayName?: string | null;
|
|
2471
2951
|
/**
|
|
2472
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` -
|
|
2952
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
|
|
2473
2953
|
*/
|
|
2474
2954
|
features?: {
|
|
2475
2955
|
[key: string]: string;
|
|
@@ -3160,6 +3640,51 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3160
3640
|
*/
|
|
3161
3641
|
region?: string | null;
|
|
3162
3642
|
}
|
|
3643
|
+
/**
|
|
3644
|
+
* Information about users' licenses.
|
|
3645
|
+
*/
|
|
3646
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig {
|
|
3647
|
+
/**
|
|
3648
|
+
* Optional. The alert policy config for this license config.
|
|
3649
|
+
*/
|
|
3650
|
+
alertPolicyResourceConfig?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig;
|
|
3651
|
+
/**
|
|
3652
|
+
* Optional. Whether the license config should be auto renewed when it reaches the end date.
|
|
3653
|
+
*/
|
|
3654
|
+
autoRenew?: boolean | null;
|
|
3655
|
+
/**
|
|
3656
|
+
* Optional. The planed end date.
|
|
3657
|
+
*/
|
|
3658
|
+
endDate?: Schema$GoogleTypeDate;
|
|
3659
|
+
/**
|
|
3660
|
+
* Optional. Whether the license config is for free trial.
|
|
3661
|
+
*/
|
|
3662
|
+
freeTrial?: boolean | null;
|
|
3663
|
+
/**
|
|
3664
|
+
* Required. Number of licenses purchased.
|
|
3665
|
+
*/
|
|
3666
|
+
licenseCount?: string | null;
|
|
3667
|
+
/**
|
|
3668
|
+
* Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
|
|
3669
|
+
*/
|
|
3670
|
+
name?: string | null;
|
|
3671
|
+
/**
|
|
3672
|
+
* Required. The start date.
|
|
3673
|
+
*/
|
|
3674
|
+
startDate?: Schema$GoogleTypeDate;
|
|
3675
|
+
/**
|
|
3676
|
+
* Output only. The state of the license config.
|
|
3677
|
+
*/
|
|
3678
|
+
state?: string | null;
|
|
3679
|
+
/**
|
|
3680
|
+
* Required. Subscription term.
|
|
3681
|
+
*/
|
|
3682
|
+
subscriptionTerm?: string | null;
|
|
3683
|
+
/**
|
|
3684
|
+
* Required. Subscription tier information for the license config.
|
|
3685
|
+
*/
|
|
3686
|
+
subscriptionTier?: string | null;
|
|
3687
|
+
}
|
|
3163
3688
|
/**
|
|
3164
3689
|
* Request for ListSessions method.
|
|
3165
3690
|
*/
|
|
@@ -3249,6 +3774,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3249
3774
|
* Output only. The timestamp when this project is created.
|
|
3250
3775
|
*/
|
|
3251
3776
|
createTime?: string | null;
|
|
3777
|
+
/**
|
|
3778
|
+
* Optional. Customer provided configurations.
|
|
3779
|
+
*/
|
|
3780
|
+
customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig;
|
|
3252
3781
|
/**
|
|
3253
3782
|
* Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
|
|
3254
3783
|
*/
|
|
@@ -3264,6 +3793,37 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3264
3793
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
|
|
3265
3794
|
} | null;
|
|
3266
3795
|
}
|
|
3796
|
+
/**
|
|
3797
|
+
* Customer provided configurations.
|
|
3798
|
+
*/
|
|
3799
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig {
|
|
3800
|
+
/**
|
|
3801
|
+
* Optional. Configuration for NotebookLM settings.
|
|
3802
|
+
*/
|
|
3803
|
+
notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig;
|
|
3804
|
+
}
|
|
3805
|
+
/**
|
|
3806
|
+
* Configuration for NotebookLM.
|
|
3807
|
+
*/
|
|
3808
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig {
|
|
3809
|
+
/**
|
|
3810
|
+
* Model Armor configuration to be used for sanitizing user prompts and LLM responses.
|
|
3811
|
+
*/
|
|
3812
|
+
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
|
|
3813
|
+
}
|
|
3814
|
+
/**
|
|
3815
|
+
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
|
|
3816
|
+
*/
|
|
3817
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig {
|
|
3818
|
+
/**
|
|
3819
|
+
* Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response.
|
|
3820
|
+
*/
|
|
3821
|
+
responseTemplate?: string | null;
|
|
3822
|
+
/**
|
|
3823
|
+
* Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt.
|
|
3824
|
+
*/
|
|
3825
|
+
userPromptTemplate?: string | null;
|
|
3826
|
+
}
|
|
3267
3827
|
/**
|
|
3268
3828
|
* Metadata about the terms of service.
|
|
3269
3829
|
*/
|
|
@@ -3725,11 +4285,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3725
4285
|
*/
|
|
3726
4286
|
languageCode?: string | null;
|
|
3727
4287
|
/**
|
|
3728
|
-
* Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
|
|
4288
|
+
* Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
|
|
3729
4289
|
*/
|
|
3730
4290
|
naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
3731
4291
|
/**
|
|
3732
|
-
* A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
4292
|
+
* A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
|
|
3733
4293
|
*/
|
|
3734
4294
|
offset?: number | null;
|
|
3735
4295
|
/**
|
|
@@ -3790,6 +4350,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3790
4350
|
* Whether to turn on safe search. This is only supported for website search.
|
|
3791
4351
|
*/
|
|
3792
4352
|
safeSearch?: boolean | null;
|
|
4353
|
+
/**
|
|
4354
|
+
* Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests.
|
|
4355
|
+
*/
|
|
4356
|
+
searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec;
|
|
3793
4357
|
/**
|
|
3794
4358
|
* Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
|
|
3795
4359
|
*/
|
|
@@ -4164,6 +4728,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4164
4728
|
* Specification to enable natural language understanding capabilities for search requests.
|
|
4165
4729
|
*/
|
|
4166
4730
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec {
|
|
4731
|
+
/**
|
|
4732
|
+
* Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
|
|
4733
|
+
*/
|
|
4734
|
+
allowedFieldNames?: string[] | null;
|
|
4167
4735
|
/**
|
|
4168
4736
|
* Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
|
|
4169
4737
|
*/
|
|
@@ -4208,6 +4776,23 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4208
4776
|
*/
|
|
4209
4777
|
returnRelevanceScore?: boolean | null;
|
|
4210
4778
|
}
|
|
4779
|
+
/**
|
|
4780
|
+
* SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.
|
|
4781
|
+
*/
|
|
4782
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec {
|
|
4783
|
+
/**
|
|
4784
|
+
* Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
|
|
4785
|
+
*/
|
|
4786
|
+
disableGenerativeAnswerAddOn?: boolean | null;
|
|
4787
|
+
/**
|
|
4788
|
+
* Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
|
|
4789
|
+
*/
|
|
4790
|
+
disableKpiPersonalizationAddOn?: boolean | null;
|
|
4791
|
+
/**
|
|
4792
|
+
* Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
|
|
4793
|
+
*/
|
|
4794
|
+
disableSemanticAddOn?: boolean | null;
|
|
4795
|
+
}
|
|
4211
4796
|
/**
|
|
4212
4797
|
* Specification for search as you type in search requests.
|
|
4213
4798
|
*/
|
|
@@ -4288,6 +4873,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4288
4873
|
* Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.
|
|
4289
4874
|
*/
|
|
4290
4875
|
detailedAnswer?: Schema$GoogleCloudDiscoveryengineV1alphaAnswer;
|
|
4876
|
+
/**
|
|
4877
|
+
* Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.
|
|
4878
|
+
*/
|
|
4879
|
+
detailedAssistAnswer?: Schema$GoogleCloudDiscoveryengineV1alphaAssistAnswer;
|
|
4291
4880
|
/**
|
|
4292
4881
|
* Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
|
|
4293
4882
|
*/
|
|
@@ -4738,6 +5327,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4738
5327
|
* Optional. List of banned phrases.
|
|
4739
5328
|
*/
|
|
4740
5329
|
bannedPhrases?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase[];
|
|
5330
|
+
/**
|
|
5331
|
+
* Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses.
|
|
5332
|
+
*/
|
|
5333
|
+
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig;
|
|
4741
5334
|
}
|
|
4742
5335
|
/**
|
|
4743
5336
|
* Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused.
|
|
@@ -4756,6 +5349,23 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4756
5349
|
*/
|
|
4757
5350
|
phrase?: string | null;
|
|
4758
5351
|
}
|
|
5352
|
+
/**
|
|
5353
|
+
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.
|
|
5354
|
+
*/
|
|
5355
|
+
export interface Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig {
|
|
5356
|
+
/**
|
|
5357
|
+
* Optional. Defines the failure mode for Model Armor sanitization.
|
|
5358
|
+
*/
|
|
5359
|
+
failureMode?: string | null;
|
|
5360
|
+
/**
|
|
5361
|
+
* Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the assistant response.
|
|
5362
|
+
*/
|
|
5363
|
+
responseTemplate?: string | null;
|
|
5364
|
+
/**
|
|
5365
|
+
* Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the user prompt.
|
|
5366
|
+
*/
|
|
5367
|
+
userPromptTemplate?: string | null;
|
|
5368
|
+
}
|
|
4759
5369
|
/**
|
|
4760
5370
|
* Configuration for the generation of the assistant response.
|
|
4761
5371
|
*/
|
|
@@ -4800,6 +5410,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4800
5410
|
*/
|
|
4801
5411
|
toolInfo?: Schema$GoogleCloudDiscoveryengineV1AssistantToolInfo[];
|
|
4802
5412
|
}
|
|
5413
|
+
/**
|
|
5414
|
+
* The configuration for the BAP connector.
|
|
5415
|
+
*/
|
|
5416
|
+
export interface Schema$GoogleCloudDiscoveryengineV1BAPConfig {
|
|
5417
|
+
/**
|
|
5418
|
+
* Optional. The actions enabled on the associated BAP connection.
|
|
5419
|
+
*/
|
|
5420
|
+
enabledActions?: string[] | null;
|
|
5421
|
+
/**
|
|
5422
|
+
* Required. The supported connector modes for the associated BAP connection.
|
|
5423
|
+
*/
|
|
5424
|
+
supportedConnectorModes?: string[] | null;
|
|
5425
|
+
}
|
|
4803
5426
|
/**
|
|
4804
5427
|
* Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
4805
5428
|
*/
|
|
@@ -4856,6 +5479,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4856
5479
|
*/
|
|
4857
5480
|
userLicenses?: Schema$GoogleCloudDiscoveryengineV1UserLicense[];
|
|
4858
5481
|
}
|
|
5482
|
+
/**
|
|
5483
|
+
* Access Control Configuration.
|
|
5484
|
+
*/
|
|
5485
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAclConfig {
|
|
5486
|
+
/**
|
|
5487
|
+
* Identity provider config.
|
|
5488
|
+
*/
|
|
5489
|
+
idpConfig?: Schema$GoogleCloudDiscoveryengineV1betaIdpConfig;
|
|
5490
|
+
/**
|
|
5491
|
+
* Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
5492
|
+
*/
|
|
5493
|
+
name?: string | null;
|
|
5494
|
+
}
|
|
4859
5495
|
/**
|
|
4860
5496
|
* Request message for CompletionService.AdvancedCompleteQuery method. .
|
|
4861
5497
|
*/
|
|
@@ -5074,6 +5710,46 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5074
5710
|
*/
|
|
5075
5711
|
disableInitialIndex?: boolean | null;
|
|
5076
5712
|
}
|
|
5713
|
+
/**
|
|
5714
|
+
* The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.
|
|
5715
|
+
*/
|
|
5716
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig {
|
|
5717
|
+
/**
|
|
5718
|
+
* Optional. The enrollment state of each alert.
|
|
5719
|
+
*/
|
|
5720
|
+
alertEnrollments?: Schema$GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment[];
|
|
5721
|
+
/**
|
|
5722
|
+
* Immutable. The fully qualified resource name of the AlertPolicy.
|
|
5723
|
+
*/
|
|
5724
|
+
alertPolicy?: string | null;
|
|
5725
|
+
/**
|
|
5726
|
+
* Optional. The contact details for each alert policy.
|
|
5727
|
+
*/
|
|
5728
|
+
contactDetails?: Schema$GoogleCloudDiscoveryengineV1betaContactDetails[];
|
|
5729
|
+
/**
|
|
5730
|
+
* Optional. The language code used for notifications
|
|
5731
|
+
*/
|
|
5732
|
+
languageCode?: string | null;
|
|
5733
|
+
}
|
|
5734
|
+
/**
|
|
5735
|
+
* The alert enrollment status.
|
|
5736
|
+
*/
|
|
5737
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment {
|
|
5738
|
+
/**
|
|
5739
|
+
* Immutable. The id of an alert.
|
|
5740
|
+
*/
|
|
5741
|
+
alertId?: string | null;
|
|
5742
|
+
/**
|
|
5743
|
+
* Required. The enrollment status of a customer.
|
|
5744
|
+
*/
|
|
5745
|
+
enrollState?: string | null;
|
|
5746
|
+
/**
|
|
5747
|
+
* Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
|
|
5748
|
+
*/
|
|
5749
|
+
notificationParams?: {
|
|
5750
|
+
[key: string]: string;
|
|
5751
|
+
} | null;
|
|
5752
|
+
}
|
|
5077
5753
|
/**
|
|
5078
5754
|
* AlloyDB source import data from.
|
|
5079
5755
|
*/
|
|
@@ -6017,6 +6693,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6017
6693
|
* Reasons for not answering the assist call.
|
|
6018
6694
|
*/
|
|
6019
6695
|
assistSkippedReasons?: string[] | null;
|
|
6696
|
+
/**
|
|
6697
|
+
* Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.
|
|
6698
|
+
*/
|
|
6699
|
+
customerPolicyEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResult;
|
|
6020
6700
|
/**
|
|
6021
6701
|
* Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/assistAnswers/{assist_answer\}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
6022
6702
|
*/
|
|
@@ -6030,6 +6710,54 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6030
6710
|
*/
|
|
6031
6711
|
state?: string | null;
|
|
6032
6712
|
}
|
|
6713
|
+
/**
|
|
6714
|
+
* Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.
|
|
6715
|
+
*/
|
|
6716
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResult {
|
|
6717
|
+
/**
|
|
6718
|
+
* Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query.
|
|
6719
|
+
*/
|
|
6720
|
+
policyResults?: Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult[];
|
|
6721
|
+
/**
|
|
6722
|
+
* Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.
|
|
6723
|
+
*/
|
|
6724
|
+
verdict?: string | null;
|
|
6725
|
+
}
|
|
6726
|
+
/**
|
|
6727
|
+
* Customer policy enforcement result for the banned phrase policy.
|
|
6728
|
+
*/
|
|
6729
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult {
|
|
6730
|
+
/**
|
|
6731
|
+
* The banned phrases that were found in the query or the answer.
|
|
6732
|
+
*/
|
|
6733
|
+
bannedPhrases?: string[] | null;
|
|
6734
|
+
}
|
|
6735
|
+
/**
|
|
6736
|
+
* Customer policy enforcement result for the Model Armor policy.
|
|
6737
|
+
*/
|
|
6738
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult {
|
|
6739
|
+
/**
|
|
6740
|
+
* The error returned by Model Armor if the policy enforcement failed for some reason.
|
|
6741
|
+
*/
|
|
6742
|
+
error?: Schema$GoogleRpcStatus;
|
|
6743
|
+
/**
|
|
6744
|
+
* The Model Armor violation that was found.
|
|
6745
|
+
*/
|
|
6746
|
+
modelArmorViolation?: string | null;
|
|
6747
|
+
}
|
|
6748
|
+
/**
|
|
6749
|
+
* Customer policy enforcement result for a single policy type.
|
|
6750
|
+
*/
|
|
6751
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult {
|
|
6752
|
+
/**
|
|
6753
|
+
* The policy enforcement result for the banned phrase policy.
|
|
6754
|
+
*/
|
|
6755
|
+
bannedPhraseEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult;
|
|
6756
|
+
/**
|
|
6757
|
+
* The policy enforcement result for the Model Armor policy.
|
|
6758
|
+
*/
|
|
6759
|
+
modelArmorEnforcementResult?: Schema$GoogleCloudDiscoveryengineV1betaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult;
|
|
6760
|
+
}
|
|
6033
6761
|
/**
|
|
6034
6762
|
* One part of the multi-part response of the assist call.
|
|
6035
6763
|
*/
|
|
@@ -6155,6 +6883,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6155
6883
|
* Optional. List of banned phrases.
|
|
6156
6884
|
*/
|
|
6157
6885
|
bannedPhrases?: Schema$GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicyBannedPhrase[];
|
|
6886
|
+
/**
|
|
6887
|
+
* Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses.
|
|
6888
|
+
*/
|
|
6889
|
+
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicyModelArmorConfig;
|
|
6158
6890
|
}
|
|
6159
6891
|
/**
|
|
6160
6892
|
* Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused.
|
|
@@ -6173,6 +6905,23 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6173
6905
|
*/
|
|
6174
6906
|
phrase?: string | null;
|
|
6175
6907
|
}
|
|
6908
|
+
/**
|
|
6909
|
+
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.
|
|
6910
|
+
*/
|
|
6911
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicyModelArmorConfig {
|
|
6912
|
+
/**
|
|
6913
|
+
* Optional. Defines the failure mode for Model Armor sanitization.
|
|
6914
|
+
*/
|
|
6915
|
+
failureMode?: string | null;
|
|
6916
|
+
/**
|
|
6917
|
+
* Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the assistant response.
|
|
6918
|
+
*/
|
|
6919
|
+
responseTemplate?: string | null;
|
|
6920
|
+
/**
|
|
6921
|
+
* Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project\}/locations/{location\}/templates/{template_id\}` If not specified, no sanitization will be applied to the user prompt.
|
|
6922
|
+
*/
|
|
6923
|
+
userPromptTemplate?: string | null;
|
|
6924
|
+
}
|
|
6176
6925
|
/**
|
|
6177
6926
|
* Configuration for the generation of the assistant response.
|
|
6178
6927
|
*/
|
|
@@ -6246,6 +6995,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6246
6995
|
* Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.
|
|
6247
6996
|
*/
|
|
6248
6997
|
domain?: string | null;
|
|
6998
|
+
/**
|
|
6999
|
+
* The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.
|
|
7000
|
+
*/
|
|
7001
|
+
mimeType?: string | null;
|
|
6249
7002
|
/**
|
|
6250
7003
|
* Page identifier.
|
|
6251
7004
|
*/
|
|
@@ -6967,6 +7720,15 @@ export declare namespace discoveryengine_v1beta {
|
|
|
6967
7720
|
*/
|
|
6968
7721
|
startTime?: string | null;
|
|
6969
7722
|
}
|
|
7723
|
+
/**
|
|
7724
|
+
* The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
|
|
7725
|
+
*/
|
|
7726
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaContactDetails {
|
|
7727
|
+
/**
|
|
7728
|
+
* Optional. The email address of the contact.
|
|
7729
|
+
*/
|
|
7730
|
+
emailAddress?: string | null;
|
|
7731
|
+
}
|
|
6970
7732
|
/**
|
|
6971
7733
|
* 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`.
|
|
6972
7734
|
*/
|
|
@@ -7402,6 +8164,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7402
8164
|
* Output only. CMEK-related information for the DataStore.
|
|
7403
8165
|
*/
|
|
7404
8166
|
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig;
|
|
8167
|
+
/**
|
|
8168
|
+
* Optional. Configuration for configurable billing approach. See
|
|
8169
|
+
*/
|
|
8170
|
+
configurableBillingApproach?: string | null;
|
|
7405
8171
|
/**
|
|
7406
8172
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
7407
8173
|
*/
|
|
@@ -7931,6 +8697,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7931
8697
|
* Metadata that describes the training and serving parameters of an Engine.
|
|
7932
8698
|
*/
|
|
7933
8699
|
export interface Schema$GoogleCloudDiscoveryengineV1betaEngine {
|
|
8700
|
+
/**
|
|
8701
|
+
* Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
|
|
8702
|
+
*/
|
|
8703
|
+
appType?: string | null;
|
|
7934
8704
|
/**
|
|
7935
8705
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
7936
8706
|
*/
|
|
@@ -7943,6 +8713,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7943
8713
|
* Common config spec that specifies the metadata of the engine.
|
|
7944
8714
|
*/
|
|
7945
8715
|
commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig;
|
|
8716
|
+
/**
|
|
8717
|
+
* Optional. Configuration for configurable billing approach.
|
|
8718
|
+
*/
|
|
8719
|
+
configurableBillingApproach?: string | null;
|
|
7946
8720
|
/**
|
|
7947
8721
|
* Output only. Timestamp the Recommendation Engine was created at.
|
|
7948
8722
|
*/
|
|
@@ -7960,7 +8734,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
7960
8734
|
*/
|
|
7961
8735
|
displayName?: string | null;
|
|
7962
8736
|
/**
|
|
7963
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` -
|
|
8737
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
|
|
7964
8738
|
*/
|
|
7965
8739
|
features?: {
|
|
7966
8740
|
[key: string]: string;
|
|
@@ -8391,6 +9165,28 @@ export declare namespace discoveryengine_v1beta {
|
|
|
8391
9165
|
*/
|
|
8392
9166
|
name?: string | null;
|
|
8393
9167
|
}
|
|
9168
|
+
/**
|
|
9169
|
+
* Identity Provider Config.
|
|
9170
|
+
*/
|
|
9171
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaIdpConfig {
|
|
9172
|
+
/**
|
|
9173
|
+
* External Identity provider config.
|
|
9174
|
+
*/
|
|
9175
|
+
externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig;
|
|
9176
|
+
/**
|
|
9177
|
+
* Identity provider type configured.
|
|
9178
|
+
*/
|
|
9179
|
+
idpType?: string | null;
|
|
9180
|
+
}
|
|
9181
|
+
/**
|
|
9182
|
+
* Third party IDP Config.
|
|
9183
|
+
*/
|
|
9184
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig {
|
|
9185
|
+
/**
|
|
9186
|
+
* Workforce pool name. Example: "locations/global/workforcePools/pool_id"
|
|
9187
|
+
*/
|
|
9188
|
+
workforcePoolName?: string | null;
|
|
9189
|
+
}
|
|
8394
9190
|
/**
|
|
8395
9191
|
* Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
8396
9192
|
*/
|
|
@@ -8837,6 +9633,51 @@ export declare namespace discoveryengine_v1beta {
|
|
|
8837
9633
|
*/
|
|
8838
9634
|
region?: string | null;
|
|
8839
9635
|
}
|
|
9636
|
+
/**
|
|
9637
|
+
* Information about users' licenses.
|
|
9638
|
+
*/
|
|
9639
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig {
|
|
9640
|
+
/**
|
|
9641
|
+
* Optional. The alert policy config for this license config.
|
|
9642
|
+
*/
|
|
9643
|
+
alertPolicyResourceConfig?: Schema$GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig;
|
|
9644
|
+
/**
|
|
9645
|
+
* Optional. Whether the license config should be auto renewed when it reaches the end date.
|
|
9646
|
+
*/
|
|
9647
|
+
autoRenew?: boolean | null;
|
|
9648
|
+
/**
|
|
9649
|
+
* Optional. The planed end date.
|
|
9650
|
+
*/
|
|
9651
|
+
endDate?: Schema$GoogleTypeDate;
|
|
9652
|
+
/**
|
|
9653
|
+
* Optional. Whether the license config is for free trial.
|
|
9654
|
+
*/
|
|
9655
|
+
freeTrial?: boolean | null;
|
|
9656
|
+
/**
|
|
9657
|
+
* Required. Number of licenses purchased.
|
|
9658
|
+
*/
|
|
9659
|
+
licenseCount?: string | null;
|
|
9660
|
+
/**
|
|
9661
|
+
* Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
|
|
9662
|
+
*/
|
|
9663
|
+
name?: string | null;
|
|
9664
|
+
/**
|
|
9665
|
+
* Required. The start date.
|
|
9666
|
+
*/
|
|
9667
|
+
startDate?: Schema$GoogleTypeDate;
|
|
9668
|
+
/**
|
|
9669
|
+
* Output only. The state of the license config.
|
|
9670
|
+
*/
|
|
9671
|
+
state?: string | null;
|
|
9672
|
+
/**
|
|
9673
|
+
* Required. Subscription term.
|
|
9674
|
+
*/
|
|
9675
|
+
subscriptionTerm?: string | null;
|
|
9676
|
+
/**
|
|
9677
|
+
* Required. Subscription tier information for the license config.
|
|
9678
|
+
*/
|
|
9679
|
+
subscriptionTier?: string | null;
|
|
9680
|
+
}
|
|
8840
9681
|
/**
|
|
8841
9682
|
* Response message for CmekConfigService.ListCmekConfigs method.
|
|
8842
9683
|
*/
|
|
@@ -9221,6 +10062,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
9221
10062
|
* Output only. The timestamp when this project is created.
|
|
9222
10063
|
*/
|
|
9223
10064
|
createTime?: string | null;
|
|
10065
|
+
/**
|
|
10066
|
+
* Optional. Customer provided configurations.
|
|
10067
|
+
*/
|
|
10068
|
+
customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig;
|
|
9224
10069
|
/**
|
|
9225
10070
|
* Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
|
|
9226
10071
|
*/
|
|
@@ -9236,6 +10081,37 @@ export declare namespace discoveryengine_v1beta {
|
|
|
9236
10081
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms;
|
|
9237
10082
|
} | null;
|
|
9238
10083
|
}
|
|
10084
|
+
/**
|
|
10085
|
+
* Customer provided configurations.
|
|
10086
|
+
*/
|
|
10087
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig {
|
|
10088
|
+
/**
|
|
10089
|
+
* Optional. Configuration for NotebookLM settings.
|
|
10090
|
+
*/
|
|
10091
|
+
notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig;
|
|
10092
|
+
}
|
|
10093
|
+
/**
|
|
10094
|
+
* Configuration for NotebookLM.
|
|
10095
|
+
*/
|
|
10096
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig {
|
|
10097
|
+
/**
|
|
10098
|
+
* Model Armor configuration to be used for sanitizing user prompts and LLM responses.
|
|
10099
|
+
*/
|
|
10100
|
+
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
|
|
10101
|
+
}
|
|
10102
|
+
/**
|
|
10103
|
+
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
|
|
10104
|
+
*/
|
|
10105
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig {
|
|
10106
|
+
/**
|
|
10107
|
+
* Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response.
|
|
10108
|
+
*/
|
|
10109
|
+
responseTemplate?: string | null;
|
|
10110
|
+
/**
|
|
10111
|
+
* Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt.
|
|
10112
|
+
*/
|
|
10113
|
+
userPromptTemplate?: string | null;
|
|
10114
|
+
}
|
|
9239
10115
|
/**
|
|
9240
10116
|
* Metadata about the terms of service.
|
|
9241
10117
|
*/
|
|
@@ -9291,6 +10167,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
9291
10167
|
* Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].
|
|
9292
10168
|
*/
|
|
9293
10169
|
acceptBizQos?: boolean | null;
|
|
10170
|
+
/**
|
|
10171
|
+
* Optional. Indicates if the current request is for Biz edition (= true) or not (= false).
|
|
10172
|
+
*/
|
|
10173
|
+
isBiz?: boolean | null;
|
|
9294
10174
|
}
|
|
9295
10175
|
/**
|
|
9296
10176
|
* Request message for CompletionService.PurgeCompletionSuggestions method.
|
|
@@ -9973,11 +10853,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
9973
10853
|
*/
|
|
9974
10854
|
languageCode?: string | null;
|
|
9975
10855
|
/**
|
|
9976
|
-
* Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
|
|
10856
|
+
* Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
|
|
9977
10857
|
*/
|
|
9978
10858
|
naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
9979
10859
|
/**
|
|
9980
|
-
* A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
10860
|
+
* A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
|
|
9981
10861
|
*/
|
|
9982
10862
|
offset?: number | null;
|
|
9983
10863
|
/**
|
|
@@ -10038,6 +10918,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
10038
10918
|
* Whether to turn on safe search. This is only supported for website search.
|
|
10039
10919
|
*/
|
|
10040
10920
|
safeSearch?: boolean | null;
|
|
10921
|
+
/**
|
|
10922
|
+
* Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests.
|
|
10923
|
+
*/
|
|
10924
|
+
searchAddonSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec;
|
|
10041
10925
|
/**
|
|
10042
10926
|
* Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
|
|
10043
10927
|
*/
|
|
@@ -10408,6 +11292,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
10408
11292
|
* Specification to enable natural language understanding capabilities for search requests.
|
|
10409
11293
|
*/
|
|
10410
11294
|
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec {
|
|
11295
|
+
/**
|
|
11296
|
+
* Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
|
|
11297
|
+
*/
|
|
11298
|
+
allowedFieldNames?: string[] | null;
|
|
10411
11299
|
/**
|
|
10412
11300
|
* Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
|
|
10413
11301
|
*/
|
|
@@ -10452,6 +11340,23 @@ export declare namespace discoveryengine_v1beta {
|
|
|
10452
11340
|
*/
|
|
10453
11341
|
returnRelevanceScore?: boolean | null;
|
|
10454
11342
|
}
|
|
11343
|
+
/**
|
|
11344
|
+
* SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.
|
|
11345
|
+
*/
|
|
11346
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec {
|
|
11347
|
+
/**
|
|
11348
|
+
* Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
|
|
11349
|
+
*/
|
|
11350
|
+
disableGenerativeAnswerAddOn?: boolean | null;
|
|
11351
|
+
/**
|
|
11352
|
+
* Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
|
|
11353
|
+
*/
|
|
11354
|
+
disableKpiPersonalizationAddOn?: boolean | null;
|
|
11355
|
+
/**
|
|
11356
|
+
* Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
|
|
11357
|
+
*/
|
|
11358
|
+
disableSemanticAddOn?: boolean | null;
|
|
11359
|
+
}
|
|
10455
11360
|
/**
|
|
10456
11361
|
* Specification for search as you type in search requests.
|
|
10457
11362
|
*/
|
|
@@ -11212,6 +12117,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
11212
12117
|
* Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.
|
|
11213
12118
|
*/
|
|
11214
12119
|
detailedAnswer?: Schema$GoogleCloudDiscoveryengineV1betaAnswer;
|
|
12120
|
+
/**
|
|
12121
|
+
* Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.
|
|
12122
|
+
*/
|
|
12123
|
+
detailedAssistAnswer?: Schema$GoogleCloudDiscoveryengineV1betaAssistAnswer;
|
|
11215
12124
|
/**
|
|
11216
12125
|
* Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
|
|
11217
12126
|
*/
|
|
@@ -11740,7 +12649,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
11740
12649
|
*/
|
|
11741
12650
|
eventTime?: string | null;
|
|
11742
12651
|
/**
|
|
11743
|
-
* Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans
|
|
12652
|
+
* Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.
|
|
11744
12653
|
*/
|
|
11745
12654
|
eventType?: string | null;
|
|
11746
12655
|
/**
|
|
@@ -11900,6 +12809,23 @@ export declare namespace discoveryengine_v1beta {
|
|
|
11900
12809
|
*/
|
|
11901
12810
|
state?: string | null;
|
|
11902
12811
|
}
|
|
12812
|
+
/**
|
|
12813
|
+
* Collection is a container for configuring resources and access to a set of DataStores.
|
|
12814
|
+
*/
|
|
12815
|
+
export interface Schema$GoogleCloudDiscoveryengineV1Collection {
|
|
12816
|
+
/**
|
|
12817
|
+
* Output only. Timestamp the Collection was created at.
|
|
12818
|
+
*/
|
|
12819
|
+
createTime?: string | null;
|
|
12820
|
+
/**
|
|
12821
|
+
* 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.
|
|
12822
|
+
*/
|
|
12823
|
+
displayName?: string | null;
|
|
12824
|
+
/**
|
|
12825
|
+
* 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.
|
|
12826
|
+
*/
|
|
12827
|
+
name?: string | null;
|
|
12828
|
+
}
|
|
11903
12829
|
/**
|
|
11904
12830
|
* Defines circumstances to be checked before allowing a behavior
|
|
11905
12831
|
*/
|
|
@@ -11943,6 +12869,15 @@ export declare namespace discoveryengine_v1beta {
|
|
|
11943
12869
|
*/
|
|
11944
12870
|
startTime?: string | null;
|
|
11945
12871
|
}
|
|
12872
|
+
/**
|
|
12873
|
+
* The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
|
|
12874
|
+
*/
|
|
12875
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ContactDetails {
|
|
12876
|
+
/**
|
|
12877
|
+
* Optional. The email address of the contact.
|
|
12878
|
+
*/
|
|
12879
|
+
emailAddress?: string | null;
|
|
12880
|
+
}
|
|
11946
12881
|
/**
|
|
11947
12882
|
* 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`.
|
|
11948
12883
|
*/
|
|
@@ -12160,6 +13095,282 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12160
13095
|
*/
|
|
12161
13096
|
updateTime?: string | null;
|
|
12162
13097
|
}
|
|
13098
|
+
/**
|
|
13099
|
+
* 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 DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.
|
|
13100
|
+
*/
|
|
13101
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnector {
|
|
13102
|
+
/**
|
|
13103
|
+
* Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.
|
|
13104
|
+
*/
|
|
13105
|
+
aclEnabled?: boolean | null;
|
|
13106
|
+
/**
|
|
13107
|
+
* Optional. Action configurations to make the connector support actions.
|
|
13108
|
+
*/
|
|
13109
|
+
actionConfig?: Schema$GoogleCloudDiscoveryengineV1ActionConfig;
|
|
13110
|
+
/**
|
|
13111
|
+
* Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.
|
|
13112
|
+
*/
|
|
13113
|
+
actionState?: string | null;
|
|
13114
|
+
/**
|
|
13115
|
+
* Optional. The connector level alert config.
|
|
13116
|
+
*/
|
|
13117
|
+
alertPolicyConfigs?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyConfig[];
|
|
13118
|
+
/**
|
|
13119
|
+
* Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs
|
|
13120
|
+
*/
|
|
13121
|
+
autoRunDisabled?: boolean | null;
|
|
13122
|
+
/**
|
|
13123
|
+
* Optional. The configuration for establishing a BAP connection.
|
|
13124
|
+
*/
|
|
13125
|
+
bapConfig?: Schema$GoogleCloudDiscoveryengineV1BAPConfig;
|
|
13126
|
+
/**
|
|
13127
|
+
* Output only. User actions that must be completed before the connector can start syncing data.
|
|
13128
|
+
*/
|
|
13129
|
+
blockingReasons?: string[] | null;
|
|
13130
|
+
/**
|
|
13131
|
+
* Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
|
|
13132
|
+
*/
|
|
13133
|
+
connectorModes?: string[] | null;
|
|
13134
|
+
/**
|
|
13135
|
+
* Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
|
|
13136
|
+
*/
|
|
13137
|
+
connectorType?: string | null;
|
|
13138
|
+
/**
|
|
13139
|
+
* Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
|
|
13140
|
+
*/
|
|
13141
|
+
createEuaSaas?: boolean | null;
|
|
13142
|
+
/**
|
|
13143
|
+
* Output only. Timestamp the DataConnector was created at.
|
|
13144
|
+
*/
|
|
13145
|
+
createTime?: string | null;
|
|
13146
|
+
/**
|
|
13147
|
+
* Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
|
|
13148
|
+
*/
|
|
13149
|
+
dataSource?: string | null;
|
|
13150
|
+
/**
|
|
13151
|
+
* Optional. Any target destinations used to connect to third-party services.
|
|
13152
|
+
*/
|
|
13153
|
+
destinationConfigs?: Schema$GoogleCloudDiscoveryengineV1DestinationConfig[];
|
|
13154
|
+
/**
|
|
13155
|
+
* Optional. Any params and credentials used specifically for EUA connectors.
|
|
13156
|
+
*/
|
|
13157
|
+
endUserConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig;
|
|
13158
|
+
/**
|
|
13159
|
+
* List of entities from the connected data source to ingest.
|
|
13160
|
+
*/
|
|
13161
|
+
entities?: Schema$GoogleCloudDiscoveryengineV1DataConnectorSourceEntity[];
|
|
13162
|
+
/**
|
|
13163
|
+
* Output only. The errors from initialization or from the latest connector run.
|
|
13164
|
+
*/
|
|
13165
|
+
errors?: Schema$GoogleRpcStatus[];
|
|
13166
|
+
/**
|
|
13167
|
+
* Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.
|
|
13168
|
+
*/
|
|
13169
|
+
federatedConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig;
|
|
13170
|
+
/**
|
|
13171
|
+
* Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.
|
|
13172
|
+
*/
|
|
13173
|
+
hybridIngestionDisabled?: boolean | null;
|
|
13174
|
+
/**
|
|
13175
|
+
* 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.
|
|
13176
|
+
*/
|
|
13177
|
+
identityRefreshInterval?: string | null;
|
|
13178
|
+
/**
|
|
13179
|
+
* 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.
|
|
13180
|
+
*/
|
|
13181
|
+
identityScheduleConfig?: Schema$GoogleCloudDiscoveryengineV1IdentityScheduleConfig;
|
|
13182
|
+
/**
|
|
13183
|
+
* Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
|
|
13184
|
+
*/
|
|
13185
|
+
incrementalRefreshInterval?: string | null;
|
|
13186
|
+
/**
|
|
13187
|
+
* Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
|
|
13188
|
+
*/
|
|
13189
|
+
incrementalSyncDisabled?: boolean | null;
|
|
13190
|
+
/**
|
|
13191
|
+
* Required data connector parameters in json string format.
|
|
13192
|
+
*/
|
|
13193
|
+
jsonParams?: string | null;
|
|
13194
|
+
/**
|
|
13195
|
+
* 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.
|
|
13196
|
+
*/
|
|
13197
|
+
kmsKeyName?: string | null;
|
|
13198
|
+
/**
|
|
13199
|
+
* Output only. For periodic connectors only, the last time a data sync was completed.
|
|
13200
|
+
*/
|
|
13201
|
+
lastSyncTime?: string | null;
|
|
13202
|
+
/**
|
|
13203
|
+
* 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.
|
|
13204
|
+
*/
|
|
13205
|
+
latestPauseTime?: string | null;
|
|
13206
|
+
/**
|
|
13207
|
+
* Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
|
|
13208
|
+
*/
|
|
13209
|
+
name?: string | null;
|
|
13210
|
+
/**
|
|
13211
|
+
* Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.
|
|
13212
|
+
*/
|
|
13213
|
+
nextSyncTime?: Schema$GoogleTypeDateTime;
|
|
13214
|
+
/**
|
|
13215
|
+
* Required data connector parameters in structured json format.
|
|
13216
|
+
*/
|
|
13217
|
+
params?: {
|
|
13218
|
+
[key: string]: any;
|
|
13219
|
+
} | null;
|
|
13220
|
+
/**
|
|
13221
|
+
* Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
|
|
13222
|
+
*/
|
|
13223
|
+
privateConnectivityProjectId?: string | null;
|
|
13224
|
+
/**
|
|
13225
|
+
* Output only. real-time sync state
|
|
13226
|
+
*/
|
|
13227
|
+
realtimeState?: string | null;
|
|
13228
|
+
/**
|
|
13229
|
+
* Optional. The configuration for realtime sync.
|
|
13230
|
+
*/
|
|
13231
|
+
realtimeSyncConfig?: Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig;
|
|
13232
|
+
/**
|
|
13233
|
+
* 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. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
|
|
13234
|
+
*/
|
|
13235
|
+
refreshInterval?: string | null;
|
|
13236
|
+
/**
|
|
13237
|
+
* Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.
|
|
13238
|
+
*/
|
|
13239
|
+
removeParamKeys?: string[] | null;
|
|
13240
|
+
/**
|
|
13241
|
+
* Output only. State of the connector.
|
|
13242
|
+
*/
|
|
13243
|
+
state?: string | null;
|
|
13244
|
+
/**
|
|
13245
|
+
* Output only. The static IP addresses used by this connector.
|
|
13246
|
+
*/
|
|
13247
|
+
staticIpAddresses?: string[] | null;
|
|
13248
|
+
/**
|
|
13249
|
+
* Optional. Whether customer has enabled static IP addresses for this connector.
|
|
13250
|
+
*/
|
|
13251
|
+
staticIpEnabled?: boolean | null;
|
|
13252
|
+
/**
|
|
13253
|
+
* The data synchronization mode supported by the data connector.
|
|
13254
|
+
*/
|
|
13255
|
+
syncMode?: string | null;
|
|
13256
|
+
/**
|
|
13257
|
+
* Output only. Timestamp the DataConnector was last updated.
|
|
13258
|
+
*/
|
|
13259
|
+
updateTime?: string | null;
|
|
13260
|
+
}
|
|
13261
|
+
/**
|
|
13262
|
+
* Any params and credentials used specifically for EUA connectors.
|
|
13263
|
+
*/
|
|
13264
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig {
|
|
13265
|
+
/**
|
|
13266
|
+
* Optional. Any additional parameters needed for EUA.
|
|
13267
|
+
*/
|
|
13268
|
+
additionalParams?: {
|
|
13269
|
+
[key: string]: any;
|
|
13270
|
+
} | null;
|
|
13271
|
+
/**
|
|
13272
|
+
* Optional. Any authentication parameters specific to EUA connectors.
|
|
13273
|
+
*/
|
|
13274
|
+
authParams?: {
|
|
13275
|
+
[key: string]: any;
|
|
13276
|
+
} | null;
|
|
13277
|
+
/**
|
|
13278
|
+
* Optional. Any authentication parameters specific to EUA connectors in json string format.
|
|
13279
|
+
*/
|
|
13280
|
+
jsonAuthParams?: string | null;
|
|
13281
|
+
/**
|
|
13282
|
+
* Optional. The tenant project the connector is connected to.
|
|
13283
|
+
*/
|
|
13284
|
+
tenant?: Schema$GoogleCloudDiscoveryengineV1Tenant;
|
|
13285
|
+
}
|
|
13286
|
+
/**
|
|
13287
|
+
* Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.
|
|
13288
|
+
*/
|
|
13289
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig {
|
|
13290
|
+
/**
|
|
13291
|
+
* Optional. Any additional parameters needed for FEDERATED.
|
|
13292
|
+
*/
|
|
13293
|
+
additionalParams?: {
|
|
13294
|
+
[key: string]: any;
|
|
13295
|
+
} | null;
|
|
13296
|
+
/**
|
|
13297
|
+
* Optional. Any authentication parameters specific to FEDERATED connectors.
|
|
13298
|
+
*/
|
|
13299
|
+
authParams?: {
|
|
13300
|
+
[key: string]: any;
|
|
13301
|
+
} | null;
|
|
13302
|
+
/**
|
|
13303
|
+
* Optional. Any authentication parameters specific to FEDERATED connectors in json string format.
|
|
13304
|
+
*/
|
|
13305
|
+
jsonAuthParams?: string | null;
|
|
13306
|
+
}
|
|
13307
|
+
/**
|
|
13308
|
+
* The configuration for realtime sync to store additional params for realtime sync.
|
|
13309
|
+
*/
|
|
13310
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig {
|
|
13311
|
+
/**
|
|
13312
|
+
* Optional. The ID of the Secret Manager secret used for webhook secret.
|
|
13313
|
+
*/
|
|
13314
|
+
realtimeSyncSecret?: string | null;
|
|
13315
|
+
/**
|
|
13316
|
+
* Optional. Streaming error details.
|
|
13317
|
+
*/
|
|
13318
|
+
streamingError?: Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError;
|
|
13319
|
+
/**
|
|
13320
|
+
* Optional. Webhook url for the connector to specify additional params for realtime sync.
|
|
13321
|
+
*/
|
|
13322
|
+
webhookUri?: string | null;
|
|
13323
|
+
}
|
|
13324
|
+
/**
|
|
13325
|
+
* Streaming error details.
|
|
13326
|
+
*/
|
|
13327
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError {
|
|
13328
|
+
/**
|
|
13329
|
+
* Optional. Error details.
|
|
13330
|
+
*/
|
|
13331
|
+
error?: Schema$GoogleRpcStatus;
|
|
13332
|
+
/**
|
|
13333
|
+
* Optional. Streaming error.
|
|
13334
|
+
*/
|
|
13335
|
+
streamingErrorReason?: string | null;
|
|
13336
|
+
}
|
|
13337
|
+
/**
|
|
13338
|
+
* Represents an entity in the data source. For example, the `Account` object in Salesforce.
|
|
13339
|
+
*/
|
|
13340
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorSourceEntity {
|
|
13341
|
+
/**
|
|
13342
|
+
* Output only. The full resource name of the associated data store for the source entity. Format: `projects/x/locations/x/collections/x/dataStores/x`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.
|
|
13343
|
+
*/
|
|
13344
|
+
dataStore?: string | null;
|
|
13345
|
+
/**
|
|
13346
|
+
* The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`
|
|
13347
|
+
*/
|
|
13348
|
+
entityName?: string | null;
|
|
13349
|
+
/**
|
|
13350
|
+
* Optional. Configuration for `HEALTHCARE_FHIR` vertical.
|
|
13351
|
+
*/
|
|
13352
|
+
healthcareFhirConfig?: Schema$GoogleCloudDiscoveryengineV1HealthcareFhirConfig;
|
|
13353
|
+
/**
|
|
13354
|
+
* The parameters for the entity to facilitate data ingestion in json string format.
|
|
13355
|
+
*/
|
|
13356
|
+
jsonParams?: string | null;
|
|
13357
|
+
/**
|
|
13358
|
+
* 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.
|
|
13359
|
+
*/
|
|
13360
|
+
keyPropertyMappings?: {
|
|
13361
|
+
[key: string]: string;
|
|
13362
|
+
} | null;
|
|
13363
|
+
/**
|
|
13364
|
+
* The parameters for the entity to facilitate data ingestion in structured json format.
|
|
13365
|
+
*/
|
|
13366
|
+
params?: {
|
|
13367
|
+
[key: string]: any;
|
|
13368
|
+
} | null;
|
|
13369
|
+
/**
|
|
13370
|
+
* Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
|
|
13371
|
+
*/
|
|
13372
|
+
startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema;
|
|
13373
|
+
}
|
|
12163
13374
|
/**
|
|
12164
13375
|
* DataStore captures global settings and configs at the DataStore level.
|
|
12165
13376
|
*/
|
|
@@ -12180,6 +13391,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12180
13391
|
* Output only. CMEK-related information for the DataStore.
|
|
12181
13392
|
*/
|
|
12182
13393
|
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig;
|
|
13394
|
+
/**
|
|
13395
|
+
* Optional. Configuration for configurable billing approach. See
|
|
13396
|
+
*/
|
|
13397
|
+
configurableBillingApproach?: string | null;
|
|
12183
13398
|
/**
|
|
12184
13399
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
12185
13400
|
*/
|
|
@@ -12292,6 +13507,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12292
13507
|
*/
|
|
12293
13508
|
updateTime?: string | null;
|
|
12294
13509
|
}
|
|
13510
|
+
/**
|
|
13511
|
+
* Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
13512
|
+
*/
|
|
13513
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DeleteCollectionMetadata {
|
|
13514
|
+
/**
|
|
13515
|
+
* Operation create time.
|
|
13516
|
+
*/
|
|
13517
|
+
createTime?: string | null;
|
|
13518
|
+
/**
|
|
13519
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
13520
|
+
*/
|
|
13521
|
+
updateTime?: string | null;
|
|
13522
|
+
}
|
|
12295
13523
|
/**
|
|
12296
13524
|
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
12297
13525
|
*/
|
|
@@ -12370,6 +13598,42 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12370
13598
|
*/
|
|
12371
13599
|
updateTime?: string | null;
|
|
12372
13600
|
}
|
|
13601
|
+
/**
|
|
13602
|
+
* Defines target endpoints used to connect to third-party sources.
|
|
13603
|
+
*/
|
|
13604
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DestinationConfig {
|
|
13605
|
+
/**
|
|
13606
|
+
* Optional. The destinations for the corresponding key.
|
|
13607
|
+
*/
|
|
13608
|
+
destinations?: Schema$GoogleCloudDiscoveryengineV1DestinationConfigDestination[];
|
|
13609
|
+
/**
|
|
13610
|
+
* Additional parameters for this destination config in json string format.
|
|
13611
|
+
*/
|
|
13612
|
+
jsonParams?: string | null;
|
|
13613
|
+
/**
|
|
13614
|
+
* Optional. Unique destination identifier that is supported by the connector.
|
|
13615
|
+
*/
|
|
13616
|
+
key?: string | null;
|
|
13617
|
+
/**
|
|
13618
|
+
* Optional. Additional parameters for this destination config in structured json format.
|
|
13619
|
+
*/
|
|
13620
|
+
params?: {
|
|
13621
|
+
[key: string]: any;
|
|
13622
|
+
} | null;
|
|
13623
|
+
}
|
|
13624
|
+
/**
|
|
13625
|
+
* Defines a target endpoint
|
|
13626
|
+
*/
|
|
13627
|
+
export interface Schema$GoogleCloudDiscoveryengineV1DestinationConfigDestination {
|
|
13628
|
+
/**
|
|
13629
|
+
* Publicly routable host.
|
|
13630
|
+
*/
|
|
13631
|
+
host?: string | null;
|
|
13632
|
+
/**
|
|
13633
|
+
* Optional. Target port number accepted by the destination.
|
|
13634
|
+
*/
|
|
13635
|
+
port?: number | null;
|
|
13636
|
+
}
|
|
12373
13637
|
/**
|
|
12374
13638
|
* Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
12375
13639
|
*/
|
|
@@ -12523,6 +13787,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12523
13787
|
* Metadata that describes the training and serving parameters of an Engine.
|
|
12524
13788
|
*/
|
|
12525
13789
|
export interface Schema$GoogleCloudDiscoveryengineV1Engine {
|
|
13790
|
+
/**
|
|
13791
|
+
* Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.
|
|
13792
|
+
*/
|
|
13793
|
+
appType?: string | null;
|
|
12526
13794
|
/**
|
|
12527
13795
|
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
12528
13796
|
*/
|
|
@@ -12535,6 +13803,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12535
13803
|
* Common config spec that specifies the metadata of the engine.
|
|
12536
13804
|
*/
|
|
12537
13805
|
commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig;
|
|
13806
|
+
/**
|
|
13807
|
+
* Optional. Configuration for configurable billing approach.
|
|
13808
|
+
*/
|
|
13809
|
+
configurableBillingApproach?: string | null;
|
|
12538
13810
|
/**
|
|
12539
13811
|
* Output only. Timestamp the Recommendation Engine was created at.
|
|
12540
13812
|
*/
|
|
@@ -12552,7 +13824,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12552
13824
|
*/
|
|
12553
13825
|
displayName?: string | null;
|
|
12554
13826
|
/**
|
|
12555
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` -
|
|
13827
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
|
|
12556
13828
|
*/
|
|
12557
13829
|
features?: {
|
|
12558
13830
|
[key: string]: string;
|
|
@@ -12750,6 +14022,41 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12750
14022
|
*/
|
|
12751
14023
|
totalCount?: string | null;
|
|
12752
14024
|
}
|
|
14025
|
+
/**
|
|
14026
|
+
* The configuration for the identity data synchronization runs.
|
|
14027
|
+
*/
|
|
14028
|
+
export interface Schema$GoogleCloudDiscoveryengineV1IdentityScheduleConfig {
|
|
14029
|
+
/**
|
|
14030
|
+
* Optional. 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.
|
|
14031
|
+
*/
|
|
14032
|
+
nextSyncTime?: Schema$GoogleTypeDateTime;
|
|
14033
|
+
/**
|
|
14034
|
+
* 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.
|
|
14035
|
+
*/
|
|
14036
|
+
refreshInterval?: string | null;
|
|
14037
|
+
}
|
|
14038
|
+
/**
|
|
14039
|
+
* Identity Provider Config.
|
|
14040
|
+
*/
|
|
14041
|
+
export interface Schema$GoogleCloudDiscoveryengineV1IdpConfig {
|
|
14042
|
+
/**
|
|
14043
|
+
* External Identity provider config.
|
|
14044
|
+
*/
|
|
14045
|
+
externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig;
|
|
14046
|
+
/**
|
|
14047
|
+
* Identity provider type configured.
|
|
14048
|
+
*/
|
|
14049
|
+
idpType?: string | null;
|
|
14050
|
+
}
|
|
14051
|
+
/**
|
|
14052
|
+
* Third party IDP Config.
|
|
14053
|
+
*/
|
|
14054
|
+
export interface Schema$GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig {
|
|
14055
|
+
/**
|
|
14056
|
+
* Workforce pool name. Example: "locations/global/workforcePools/pool_id"
|
|
14057
|
+
*/
|
|
14058
|
+
workforcePoolName?: string | null;
|
|
14059
|
+
}
|
|
12753
14060
|
/**
|
|
12754
14061
|
* Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
12755
14062
|
*/
|
|
@@ -12912,6 +14219,51 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12912
14219
|
*/
|
|
12913
14220
|
unjoinedEventsCount?: string | null;
|
|
12914
14221
|
}
|
|
14222
|
+
/**
|
|
14223
|
+
* Information about users' licenses.
|
|
14224
|
+
*/
|
|
14225
|
+
export interface Schema$GoogleCloudDiscoveryengineV1LicenseConfig {
|
|
14226
|
+
/**
|
|
14227
|
+
* Optional. The alert policy config for this license config.
|
|
14228
|
+
*/
|
|
14229
|
+
alertPolicyResourceConfig?: Schema$GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig;
|
|
14230
|
+
/**
|
|
14231
|
+
* Optional. Whether the license config should be auto renewed when it reaches the end date.
|
|
14232
|
+
*/
|
|
14233
|
+
autoRenew?: boolean | null;
|
|
14234
|
+
/**
|
|
14235
|
+
* Optional. The planed end date.
|
|
14236
|
+
*/
|
|
14237
|
+
endDate?: Schema$GoogleTypeDate;
|
|
14238
|
+
/**
|
|
14239
|
+
* Optional. Whether the license config is for free trial.
|
|
14240
|
+
*/
|
|
14241
|
+
freeTrial?: boolean | null;
|
|
14242
|
+
/**
|
|
14243
|
+
* Required. Number of licenses purchased.
|
|
14244
|
+
*/
|
|
14245
|
+
licenseCount?: string | null;
|
|
14246
|
+
/**
|
|
14247
|
+
* Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
|
|
14248
|
+
*/
|
|
14249
|
+
name?: string | null;
|
|
14250
|
+
/**
|
|
14251
|
+
* Required. The start date.
|
|
14252
|
+
*/
|
|
14253
|
+
startDate?: Schema$GoogleTypeDate;
|
|
14254
|
+
/**
|
|
14255
|
+
* Output only. The state of the license config.
|
|
14256
|
+
*/
|
|
14257
|
+
state?: string | null;
|
|
14258
|
+
/**
|
|
14259
|
+
* Required. Subscription term.
|
|
14260
|
+
*/
|
|
14261
|
+
subscriptionTerm?: string | null;
|
|
14262
|
+
/**
|
|
14263
|
+
* Required. Subscription tier information for the license config.
|
|
14264
|
+
*/
|
|
14265
|
+
subscriptionTier?: string | null;
|
|
14266
|
+
}
|
|
12915
14267
|
/**
|
|
12916
14268
|
* Metadata and configurations for a Google Cloud project in the service.
|
|
12917
14269
|
*/
|
|
@@ -12920,6 +14272,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12920
14272
|
* Output only. The timestamp when this project is created.
|
|
12921
14273
|
*/
|
|
12922
14274
|
createTime?: string | null;
|
|
14275
|
+
/**
|
|
14276
|
+
* Optional. Customer provided configurations.
|
|
14277
|
+
*/
|
|
14278
|
+
customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig;
|
|
12923
14279
|
/**
|
|
12924
14280
|
* Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
|
|
12925
14281
|
*/
|
|
@@ -12935,6 +14291,37 @@ export declare namespace discoveryengine_v1beta {
|
|
|
12935
14291
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms;
|
|
12936
14292
|
} | null;
|
|
12937
14293
|
}
|
|
14294
|
+
/**
|
|
14295
|
+
* Customer provided configurations.
|
|
14296
|
+
*/
|
|
14297
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig {
|
|
14298
|
+
/**
|
|
14299
|
+
* Optional. Configuration for NotebookLM settings.
|
|
14300
|
+
*/
|
|
14301
|
+
notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig;
|
|
14302
|
+
}
|
|
14303
|
+
/**
|
|
14304
|
+
* Configuration for NotebookLM.
|
|
14305
|
+
*/
|
|
14306
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig {
|
|
14307
|
+
/**
|
|
14308
|
+
* Model Armor configuration to be used for sanitizing user prompts and LLM responses.
|
|
14309
|
+
*/
|
|
14310
|
+
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
|
|
14311
|
+
}
|
|
14312
|
+
/**
|
|
14313
|
+
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
|
|
14314
|
+
*/
|
|
14315
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig {
|
|
14316
|
+
/**
|
|
14317
|
+
* Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the LLM response.
|
|
14318
|
+
*/
|
|
14319
|
+
responseTemplate?: string | null;
|
|
14320
|
+
/**
|
|
14321
|
+
* Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project\}/locations/{location\}/templates/{template_id\} If not specified, no sanitization will be applied to the user prompt.
|
|
14322
|
+
*/
|
|
14323
|
+
userPromptTemplate?: string | null;
|
|
14324
|
+
}
|
|
12938
14325
|
/**
|
|
12939
14326
|
* Metadata about the terms of service.
|
|
12940
14327
|
*/
|
|
@@ -13365,6 +14752,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
13365
14752
|
*/
|
|
13366
14753
|
demotionEventType?: string | null;
|
|
13367
14754
|
}
|
|
14755
|
+
/**
|
|
14756
|
+
* Metadata for DataConnectorService.SetUpDataConnector method.
|
|
14757
|
+
*/
|
|
14758
|
+
export interface Schema$GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata {
|
|
14759
|
+
}
|
|
13368
14760
|
/**
|
|
13369
14761
|
* Metadata for single-regional CMEKs.
|
|
13370
14762
|
*/
|
|
@@ -13467,6 +14859,23 @@ export declare namespace discoveryengine_v1beta {
|
|
|
13467
14859
|
*/
|
|
13468
14860
|
totalRequiredQuota?: string | null;
|
|
13469
14861
|
}
|
|
14862
|
+
/**
|
|
14863
|
+
* Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.
|
|
14864
|
+
*/
|
|
14865
|
+
export interface Schema$GoogleCloudDiscoveryengineV1Tenant {
|
|
14866
|
+
/**
|
|
14867
|
+
* Optional display name for the tenant, e.g. "My Slack Team".
|
|
14868
|
+
*/
|
|
14869
|
+
displayName?: string | null;
|
|
14870
|
+
/**
|
|
14871
|
+
* The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").
|
|
14872
|
+
*/
|
|
14873
|
+
id?: string | null;
|
|
14874
|
+
/**
|
|
14875
|
+
* The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.
|
|
14876
|
+
*/
|
|
14877
|
+
uri?: string | null;
|
|
14878
|
+
}
|
|
13470
14879
|
/**
|
|
13471
14880
|
* Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.
|
|
13472
14881
|
*/
|
|
@@ -13617,6 +15026,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
13617
15026
|
* A list of operations that matches the specified filter in the request.
|
|
13618
15027
|
*/
|
|
13619
15028
|
operations?: Schema$GoogleLongrunningOperation[];
|
|
15029
|
+
/**
|
|
15030
|
+
* Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
|
|
15031
|
+
*/
|
|
15032
|
+
unreachable?: string[] | null;
|
|
13620
15033
|
}
|
|
13621
15034
|
/**
|
|
13622
15035
|
* This resource represents a long-running operation that is the result of a network API call.
|
|
@@ -14039,6 +15452,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14039
15452
|
evaluations: Resource$Projects$Locations$Evaluations;
|
|
14040
15453
|
groundingConfigs: Resource$Projects$Locations$Groundingconfigs;
|
|
14041
15454
|
identityMappingStores: Resource$Projects$Locations$Identitymappingstores;
|
|
15455
|
+
licenseConfigs: Resource$Projects$Locations$Licenseconfigs;
|
|
14042
15456
|
operations: Resource$Projects$Locations$Operations;
|
|
14043
15457
|
podcasts: Resource$Projects$Locations$Podcasts;
|
|
14044
15458
|
rankingConfigs: Resource$Projects$Locations$Rankingconfigs;
|
|
@@ -14046,6 +15460,67 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14046
15460
|
userEvents: Resource$Projects$Locations$Userevents;
|
|
14047
15461
|
userStores: Resource$Projects$Locations$Userstores;
|
|
14048
15462
|
constructor(context: APIRequestContext);
|
|
15463
|
+
/**
|
|
15464
|
+
* Gets the AclConfig.
|
|
15465
|
+
* @example
|
|
15466
|
+
* ```js
|
|
15467
|
+
* // Before running the sample:
|
|
15468
|
+
* // - Enable the API at:
|
|
15469
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
15470
|
+
* // - Login into gcloud by running:
|
|
15471
|
+
* // ```sh
|
|
15472
|
+
* // $ gcloud auth application-default login
|
|
15473
|
+
* // ```
|
|
15474
|
+
* // - Install the npm module by running:
|
|
15475
|
+
* // ```sh
|
|
15476
|
+
* // $ npm install googleapis
|
|
15477
|
+
* // ```
|
|
15478
|
+
*
|
|
15479
|
+
* const {google} = require('googleapis');
|
|
15480
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
15481
|
+
*
|
|
15482
|
+
* async function main() {
|
|
15483
|
+
* const auth = new google.auth.GoogleAuth({
|
|
15484
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15485
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
15486
|
+
* });
|
|
15487
|
+
*
|
|
15488
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
15489
|
+
* const authClient = await auth.getClient();
|
|
15490
|
+
* google.options({auth: authClient});
|
|
15491
|
+
*
|
|
15492
|
+
* // Do the magic
|
|
15493
|
+
* const res = await discoveryengine.projects.locations.getAclConfig({
|
|
15494
|
+
* // Required. Resource name of AclConfig, such as `projects/x/locations/x/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
15495
|
+
* name: 'projects/my-project/locations/my-location/aclConfig',
|
|
15496
|
+
* });
|
|
15497
|
+
* console.log(res.data);
|
|
15498
|
+
*
|
|
15499
|
+
* // Example response
|
|
15500
|
+
* // {
|
|
15501
|
+
* // "idpConfig": {},
|
|
15502
|
+
* // "name": "my_name"
|
|
15503
|
+
* // }
|
|
15504
|
+
* }
|
|
15505
|
+
*
|
|
15506
|
+
* main().catch(e => {
|
|
15507
|
+
* console.error(e);
|
|
15508
|
+
* throw e;
|
|
15509
|
+
* });
|
|
15510
|
+
*
|
|
15511
|
+
* ```
|
|
15512
|
+
*
|
|
15513
|
+
* @param params - Parameters for request
|
|
15514
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15515
|
+
* @param callback - Optional callback that handles the response.
|
|
15516
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15517
|
+
*/
|
|
15518
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15519
|
+
getAclConfig(params?: Params$Resource$Projects$Locations$Getaclconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaAclConfig>>;
|
|
15520
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15521
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAclConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAclConfig>): void;
|
|
15522
|
+
getAclConfig(params: Params$Resource$Projects$Locations$Getaclconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAclConfig>): void;
|
|
15523
|
+
getAclConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAclConfig>): void;
|
|
14049
15524
|
/**
|
|
14050
15525
|
* Gets the CmekConfig.
|
|
14051
15526
|
* @example
|
|
@@ -14288,18 +15763,91 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14288
15763
|
* google.options({auth: authClient});
|
|
14289
15764
|
*
|
|
14290
15765
|
* // Do the magic
|
|
14291
|
-
* const res = await discoveryengine.projects.locations.setDedicatedCrawlRate({
|
|
14292
|
-
* // Required. The location resource where crawl rate management will be performed. Format: `projects/{project\}/locations/{location\}`
|
|
14293
|
-
* location: 'projects/my-project/locations/my-location',
|
|
15766
|
+
* const res = await discoveryengine.projects.locations.setDedicatedCrawlRate({
|
|
15767
|
+
* // Required. The location resource where crawl rate management will be performed. Format: `projects/{project\}/locations/{location\}`
|
|
15768
|
+
* location: 'projects/my-project/locations/my-location',
|
|
15769
|
+
*
|
|
15770
|
+
* // Request body metadata
|
|
15771
|
+
* requestBody: {
|
|
15772
|
+
* // request body parameters
|
|
15773
|
+
* // {
|
|
15774
|
+
* // "crawlRate": 0,
|
|
15775
|
+
* // "crawlRateScope": "my_crawlRateScope",
|
|
15776
|
+
* // "crawlType": "my_crawlType",
|
|
15777
|
+
* // "mode": "my_mode"
|
|
15778
|
+
* // }
|
|
15779
|
+
* },
|
|
15780
|
+
* });
|
|
15781
|
+
* console.log(res.data);
|
|
15782
|
+
*
|
|
15783
|
+
* // Example response
|
|
15784
|
+
* // {
|
|
15785
|
+
* // "done": false,
|
|
15786
|
+
* // "error": {},
|
|
15787
|
+
* // "metadata": {},
|
|
15788
|
+
* // "name": "my_name",
|
|
15789
|
+
* // "response": {}
|
|
15790
|
+
* // }
|
|
15791
|
+
* }
|
|
15792
|
+
*
|
|
15793
|
+
* main().catch(e => {
|
|
15794
|
+
* console.error(e);
|
|
15795
|
+
* throw e;
|
|
15796
|
+
* });
|
|
15797
|
+
*
|
|
15798
|
+
* ```
|
|
15799
|
+
*
|
|
15800
|
+
* @param params - Parameters for request
|
|
15801
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
15802
|
+
* @param callback - Optional callback that handles the response.
|
|
15803
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
15804
|
+
*/
|
|
15805
|
+
setDedicatedCrawlRate(params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15806
|
+
setDedicatedCrawlRate(params?: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
15807
|
+
setDedicatedCrawlRate(params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15808
|
+
setDedicatedCrawlRate(params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15809
|
+
setDedicatedCrawlRate(params: Params$Resource$Projects$Locations$Setdedicatedcrawlrate, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15810
|
+
setDedicatedCrawlRate(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
15811
|
+
/**
|
|
15812
|
+
* 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.
|
|
15813
|
+
* @example
|
|
15814
|
+
* ```js
|
|
15815
|
+
* // Before running the sample:
|
|
15816
|
+
* // - Enable the API at:
|
|
15817
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
15818
|
+
* // - Login into gcloud by running:
|
|
15819
|
+
* // ```sh
|
|
15820
|
+
* // $ gcloud auth application-default login
|
|
15821
|
+
* // ```
|
|
15822
|
+
* // - Install the npm module by running:
|
|
15823
|
+
* // ```sh
|
|
15824
|
+
* // $ npm install googleapis
|
|
15825
|
+
* // ```
|
|
15826
|
+
*
|
|
15827
|
+
* const {google} = require('googleapis');
|
|
15828
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
15829
|
+
*
|
|
15830
|
+
* async function main() {
|
|
15831
|
+
* const auth = new google.auth.GoogleAuth({
|
|
15832
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
15833
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
15834
|
+
* });
|
|
15835
|
+
*
|
|
15836
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
15837
|
+
* const authClient = await auth.getClient();
|
|
15838
|
+
* google.options({auth: authClient});
|
|
15839
|
+
*
|
|
15840
|
+
* // Do the magic
|
|
15841
|
+
* const res = await discoveryengine.projects.locations.updateAclConfig({
|
|
15842
|
+
* // Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
15843
|
+
* name: 'projects/my-project/locations/my-location/aclConfig',
|
|
14294
15844
|
*
|
|
14295
15845
|
* // Request body metadata
|
|
14296
15846
|
* requestBody: {
|
|
14297
15847
|
* // request body parameters
|
|
14298
15848
|
* // {
|
|
14299
|
-
* // "
|
|
14300
|
-
* // "
|
|
14301
|
-
* // "crawlType": "my_crawlType",
|
|
14302
|
-
* // "mode": "my_mode"
|
|
15849
|
+
* // "idpConfig": {},
|
|
15850
|
+
* // "name": "my_name"
|
|
14303
15851
|
* // }
|
|
14304
15852
|
* },
|
|
14305
15853
|
* });
|
|
@@ -14307,11 +15855,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14307
15855
|
*
|
|
14308
15856
|
* // Example response
|
|
14309
15857
|
* // {
|
|
14310
|
-
* // "
|
|
14311
|
-
* // "
|
|
14312
|
-
* // "metadata": {},
|
|
14313
|
-
* // "name": "my_name",
|
|
14314
|
-
* // "response": {}
|
|
15858
|
+
* // "idpConfig": {},
|
|
15859
|
+
* // "name": "my_name"
|
|
14315
15860
|
* // }
|
|
14316
15861
|
* }
|
|
14317
15862
|
*
|
|
@@ -14327,12 +15872,12 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14327
15872
|
* @param callback - Optional callback that handles the response.
|
|
14328
15873
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
14329
15874
|
*/
|
|
14330
|
-
|
|
14331
|
-
|
|
14332
|
-
|
|
14333
|
-
|
|
14334
|
-
|
|
14335
|
-
|
|
15875
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
15876
|
+
updateAclConfig(params?: Params$Resource$Projects$Locations$Updateaclconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaAclConfig>>;
|
|
15877
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
15878
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAclConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAclConfig>): void;
|
|
15879
|
+
updateAclConfig(params: Params$Resource$Projects$Locations$Updateaclconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAclConfig>): void;
|
|
15880
|
+
updateAclConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAclConfig>): void;
|
|
14336
15881
|
/**
|
|
14337
15882
|
* Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.
|
|
14338
15883
|
* @example
|
|
@@ -14415,6 +15960,12 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14415
15960
|
updateCmekConfig(params: Params$Resource$Projects$Locations$Updatecmekconfig, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
14416
15961
|
updateCmekConfig(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
14417
15962
|
}
|
|
15963
|
+
export interface Params$Resource$Projects$Locations$Getaclconfig extends StandardParameters {
|
|
15964
|
+
/**
|
|
15965
|
+
* Required. Resource name of AclConfig, such as `projects/x/locations/x/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
15966
|
+
*/
|
|
15967
|
+
name?: string;
|
|
15968
|
+
}
|
|
14418
15969
|
export interface Params$Resource$Projects$Locations$Getcmekconfig extends StandardParameters {
|
|
14419
15970
|
/**
|
|
14420
15971
|
* Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
@@ -14451,6 +16002,16 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14451
16002
|
*/
|
|
14452
16003
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest;
|
|
14453
16004
|
}
|
|
16005
|
+
export interface Params$Resource$Projects$Locations$Updateaclconfig extends StandardParameters {
|
|
16006
|
+
/**
|
|
16007
|
+
* Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
16008
|
+
*/
|
|
16009
|
+
name?: string;
|
|
16010
|
+
/**
|
|
16011
|
+
* Request body metadata
|
|
16012
|
+
*/
|
|
16013
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAclConfig;
|
|
16014
|
+
}
|
|
14454
16015
|
export interface Params$Resource$Projects$Locations$Updatecmekconfig extends StandardParameters {
|
|
14455
16016
|
/**
|
|
14456
16017
|
* Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`.
|
|
@@ -14897,6 +16458,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14897
16458
|
* pageSize: 'placeholder-value',
|
|
14898
16459
|
* // The standard list page token.
|
|
14899
16460
|
* pageToken: 'placeholder-value',
|
|
16461
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
16462
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
14900
16463
|
* },
|
|
14901
16464
|
* );
|
|
14902
16465
|
* console.log(res.data);
|
|
@@ -14904,7 +16467,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14904
16467
|
* // Example response
|
|
14905
16468
|
* // {
|
|
14906
16469
|
* // "nextPageToken": "my_nextPageToken",
|
|
14907
|
-
* // "operations": []
|
|
16470
|
+
* // "operations": [],
|
|
16471
|
+
* // "unreachable": []
|
|
14908
16472
|
* // }
|
|
14909
16473
|
* }
|
|
14910
16474
|
*
|
|
@@ -14950,6 +16514,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14950
16514
|
* The standard list page token.
|
|
14951
16515
|
*/
|
|
14952
16516
|
pageToken?: string;
|
|
16517
|
+
/**
|
|
16518
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
16519
|
+
*/
|
|
16520
|
+
returnPartialSuccess?: boolean;
|
|
14953
16521
|
}
|
|
14954
16522
|
export class Resource$Projects$Locations$Collections$Datastores {
|
|
14955
16523
|
context: APIRequestContext;
|
|
@@ -15095,6 +16663,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15095
16663
|
* // "advancedSiteSearchConfig": {},
|
|
15096
16664
|
* // "billingEstimation": {},
|
|
15097
16665
|
* // "cmekConfig": {},
|
|
16666
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
15098
16667
|
* // "contentConfig": "my_contentConfig",
|
|
15099
16668
|
* // "createTime": "my_createTime",
|
|
15100
16669
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -15253,6 +16822,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15253
16822
|
* // "advancedSiteSearchConfig": {},
|
|
15254
16823
|
* // "billingEstimation": {},
|
|
15255
16824
|
* // "cmekConfig": {},
|
|
16825
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
15256
16826
|
* // "contentConfig": "my_contentConfig",
|
|
15257
16827
|
* // "createTime": "my_createTime",
|
|
15258
16828
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -15468,6 +17038,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15468
17038
|
* // "advancedSiteSearchConfig": {},
|
|
15469
17039
|
* // "billingEstimation": {},
|
|
15470
17040
|
* // "cmekConfig": {},
|
|
17041
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
15471
17042
|
* // "contentConfig": "my_contentConfig",
|
|
15472
17043
|
* // "createTime": "my_createTime",
|
|
15473
17044
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -15496,6 +17067,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15496
17067
|
* // "advancedSiteSearchConfig": {},
|
|
15497
17068
|
* // "billingEstimation": {},
|
|
15498
17069
|
* // "cmekConfig": {},
|
|
17070
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
15499
17071
|
* // "contentConfig": "my_contentConfig",
|
|
15500
17072
|
* // "createTime": "my_createTime",
|
|
15501
17073
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -16636,6 +18208,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
16636
18208
|
* pageSize: 'placeholder-value',
|
|
16637
18209
|
* // The standard list page token.
|
|
16638
18210
|
* pageToken: 'placeholder-value',
|
|
18211
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
18212
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
16639
18213
|
* },
|
|
16640
18214
|
* );
|
|
16641
18215
|
* console.log(res.data);
|
|
@@ -16643,7 +18217,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
16643
18217
|
* // Example response
|
|
16644
18218
|
* // {
|
|
16645
18219
|
* // "nextPageToken": "my_nextPageToken",
|
|
16646
|
-
* // "operations": []
|
|
18220
|
+
* // "operations": [],
|
|
18221
|
+
* // "unreachable": []
|
|
16647
18222
|
* // }
|
|
16648
18223
|
* }
|
|
16649
18224
|
*
|
|
@@ -16699,6 +18274,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
16699
18274
|
* The standard list page token.
|
|
16700
18275
|
*/
|
|
16701
18276
|
pageToken?: string;
|
|
18277
|
+
/**
|
|
18278
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
18279
|
+
*/
|
|
18280
|
+
returnPartialSuccess?: boolean;
|
|
16702
18281
|
}
|
|
16703
18282
|
export class Resource$Projects$Locations$Collections$Datastores$Completionconfig {
|
|
16704
18283
|
context: APIRequestContext;
|
|
@@ -18142,6 +19721,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
18142
19721
|
* pageSize: 'placeholder-value',
|
|
18143
19722
|
* // The standard list page token.
|
|
18144
19723
|
* pageToken: 'placeholder-value',
|
|
19724
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
19725
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
18145
19726
|
* },
|
|
18146
19727
|
* );
|
|
18147
19728
|
* console.log(res.data);
|
|
@@ -18149,7 +19730,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
18149
19730
|
* // Example response
|
|
18150
19731
|
* // {
|
|
18151
19732
|
* // "nextPageToken": "my_nextPageToken",
|
|
18152
|
-
* // "operations": []
|
|
19733
|
+
* // "operations": [],
|
|
19734
|
+
* // "unreachable": []
|
|
18153
19735
|
* // }
|
|
18154
19736
|
* }
|
|
18155
19737
|
*
|
|
@@ -18195,6 +19777,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
18195
19777
|
* The standard list page token.
|
|
18196
19778
|
*/
|
|
18197
19779
|
pageToken?: string;
|
|
19780
|
+
/**
|
|
19781
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
19782
|
+
*/
|
|
19783
|
+
returnPartialSuccess?: boolean;
|
|
18198
19784
|
}
|
|
18199
19785
|
export class Resource$Projects$Locations$Collections$Datastores$Operations {
|
|
18200
19786
|
context: APIRequestContext;
|
|
@@ -18307,6 +19893,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
18307
19893
|
* pageSize: 'placeholder-value',
|
|
18308
19894
|
* // The standard list page token.
|
|
18309
19895
|
* pageToken: 'placeholder-value',
|
|
19896
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
19897
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
18310
19898
|
* },
|
|
18311
19899
|
* );
|
|
18312
19900
|
* console.log(res.data);
|
|
@@ -18314,7 +19902,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
18314
19902
|
* // Example response
|
|
18315
19903
|
* // {
|
|
18316
19904
|
* // "nextPageToken": "my_nextPageToken",
|
|
18317
|
-
* // "operations": []
|
|
19905
|
+
* // "operations": [],
|
|
19906
|
+
* // "unreachable": []
|
|
18318
19907
|
* // }
|
|
18319
19908
|
* }
|
|
18320
19909
|
*
|
|
@@ -18360,6 +19949,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
18360
19949
|
* The standard list page token.
|
|
18361
19950
|
*/
|
|
18362
19951
|
pageToken?: string;
|
|
19952
|
+
/**
|
|
19953
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
19954
|
+
*/
|
|
19955
|
+
returnPartialSuccess?: boolean;
|
|
18363
19956
|
}
|
|
18364
19957
|
export class Resource$Projects$Locations$Collections$Datastores$Schemas {
|
|
18365
19958
|
context: APIRequestContext;
|
|
@@ -18891,6 +20484,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
18891
20484
|
* pageSize: 'placeholder-value',
|
|
18892
20485
|
* // The standard list page token.
|
|
18893
20486
|
* pageToken: 'placeholder-value',
|
|
20487
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
20488
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
18894
20489
|
* },
|
|
18895
20490
|
* );
|
|
18896
20491
|
* console.log(res.data);
|
|
@@ -18898,7 +20493,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
18898
20493
|
* // Example response
|
|
18899
20494
|
* // {
|
|
18900
20495
|
* // "nextPageToken": "my_nextPageToken",
|
|
18901
|
-
* // "operations": []
|
|
20496
|
+
* // "operations": [],
|
|
20497
|
+
* // "unreachable": []
|
|
18902
20498
|
* // }
|
|
18903
20499
|
* }
|
|
18904
20500
|
*
|
|
@@ -18944,6 +20540,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
18944
20540
|
* The standard list page token.
|
|
18945
20541
|
*/
|
|
18946
20542
|
pageToken?: string;
|
|
20543
|
+
/**
|
|
20544
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
20545
|
+
*/
|
|
20546
|
+
returnPartialSuccess?: boolean;
|
|
18947
20547
|
}
|
|
18948
20548
|
export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs {
|
|
18949
20549
|
context: APIRequestContext;
|
|
@@ -19449,6 +21049,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
19449
21049
|
* // "relevanceScoreSpec": {},
|
|
19450
21050
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
19451
21051
|
* // "safeSearch": false,
|
|
21052
|
+
* // "searchAddonSpec": {},
|
|
19452
21053
|
* // "searchAsYouTypeSpec": {},
|
|
19453
21054
|
* // "servingConfig": "my_servingConfig",
|
|
19454
21055
|
* // "session": "my_session",
|
|
@@ -19571,6 +21172,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
19571
21172
|
* // "relevanceScoreSpec": {},
|
|
19572
21173
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
19573
21174
|
* // "safeSearch": false,
|
|
21175
|
+
* // "searchAddonSpec": {},
|
|
19574
21176
|
* // "searchAsYouTypeSpec": {},
|
|
19575
21177
|
* // "servingConfig": "my_servingConfig",
|
|
19576
21178
|
* // "session": "my_session",
|
|
@@ -20869,6 +22471,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
20869
22471
|
* pageSize: 'placeholder-value',
|
|
20870
22472
|
* // The standard list page token.
|
|
20871
22473
|
* pageToken: 'placeholder-value',
|
|
22474
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
22475
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
20872
22476
|
* },
|
|
20873
22477
|
* );
|
|
20874
22478
|
* console.log(res.data);
|
|
@@ -20876,7 +22480,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
20876
22480
|
* // Example response
|
|
20877
22481
|
* // {
|
|
20878
22482
|
* // "nextPageToken": "my_nextPageToken",
|
|
20879
|
-
* // "operations": []
|
|
22483
|
+
* // "operations": [],
|
|
22484
|
+
* // "unreachable": []
|
|
20880
22485
|
* // }
|
|
20881
22486
|
* }
|
|
20882
22487
|
*
|
|
@@ -20922,6 +22527,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
20922
22527
|
* The standard list page token.
|
|
20923
22528
|
*/
|
|
20924
22529
|
pageToken?: string;
|
|
22530
|
+
/**
|
|
22531
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
22532
|
+
*/
|
|
22533
|
+
returnPartialSuccess?: boolean;
|
|
20925
22534
|
}
|
|
20926
22535
|
export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps {
|
|
20927
22536
|
context: APIRequestContext;
|
|
@@ -21790,6 +23399,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21790
23399
|
* pageSize: 'placeholder-value',
|
|
21791
23400
|
* // The standard list page token.
|
|
21792
23401
|
* pageToken: 'placeholder-value',
|
|
23402
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
23403
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
21793
23404
|
* },
|
|
21794
23405
|
* );
|
|
21795
23406
|
* console.log(res.data);
|
|
@@ -21797,7 +23408,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21797
23408
|
* // Example response
|
|
21798
23409
|
* // {
|
|
21799
23410
|
* // "nextPageToken": "my_nextPageToken",
|
|
21800
|
-
* // "operations": []
|
|
23411
|
+
* // "operations": [],
|
|
23412
|
+
* // "unreachable": []
|
|
21801
23413
|
* // }
|
|
21802
23414
|
* }
|
|
21803
23415
|
*
|
|
@@ -21843,6 +23455,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
21843
23455
|
* The standard list page token.
|
|
21844
23456
|
*/
|
|
21845
23457
|
pageToken?: string;
|
|
23458
|
+
/**
|
|
23459
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
23460
|
+
*/
|
|
23461
|
+
returnPartialSuccess?: boolean;
|
|
21846
23462
|
}
|
|
21847
23463
|
export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries {
|
|
21848
23464
|
context: APIRequestContext;
|
|
@@ -22471,9 +24087,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
22471
24087
|
* requestBody: {
|
|
22472
24088
|
* // request body parameters
|
|
22473
24089
|
* // {
|
|
24090
|
+
* // "appType": "my_appType",
|
|
22474
24091
|
* // "chatEngineConfig": {},
|
|
22475
24092
|
* // "chatEngineMetadata": {},
|
|
22476
24093
|
* // "commonConfig": {},
|
|
24094
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
22477
24095
|
* // "createTime": "my_createTime",
|
|
22478
24096
|
* // "dataStoreIds": [],
|
|
22479
24097
|
* // "disableAnalytics": false,
|
|
@@ -22621,9 +24239,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
22621
24239
|
*
|
|
22622
24240
|
* // Example response
|
|
22623
24241
|
* // {
|
|
24242
|
+
* // "appType": "my_appType",
|
|
22624
24243
|
* // "chatEngineConfig": {},
|
|
22625
24244
|
* // "chatEngineMetadata": {},
|
|
22626
24245
|
* // "commonConfig": {},
|
|
24246
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
22627
24247
|
* // "createTime": "my_createTime",
|
|
22628
24248
|
* // "dataStoreIds": [],
|
|
22629
24249
|
* // "disableAnalytics": false,
|
|
@@ -22767,9 +24387,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
22767
24387
|
* requestBody: {
|
|
22768
24388
|
* // request body parameters
|
|
22769
24389
|
* // {
|
|
24390
|
+
* // "appType": "my_appType",
|
|
22770
24391
|
* // "chatEngineConfig": {},
|
|
22771
24392
|
* // "chatEngineMetadata": {},
|
|
22772
24393
|
* // "commonConfig": {},
|
|
24394
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
22773
24395
|
* // "createTime": "my_createTime",
|
|
22774
24396
|
* // "dataStoreIds": [],
|
|
22775
24397
|
* // "disableAnalytics": false,
|
|
@@ -22788,9 +24410,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
22788
24410
|
*
|
|
22789
24411
|
* // Example response
|
|
22790
24412
|
* // {
|
|
24413
|
+
* // "appType": "my_appType",
|
|
22791
24414
|
* // "chatEngineConfig": {},
|
|
22792
24415
|
* // "chatEngineMetadata": {},
|
|
22793
24416
|
* // "commonConfig": {},
|
|
24417
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
22794
24418
|
* // "createTime": "my_createTime",
|
|
22795
24419
|
* // "dataStoreIds": [],
|
|
22796
24420
|
* // "disableAnalytics": false,
|
|
@@ -22868,9 +24492,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
22868
24492
|
*
|
|
22869
24493
|
* // Example response
|
|
22870
24494
|
* // {
|
|
24495
|
+
* // "appType": "my_appType",
|
|
22871
24496
|
* // "chatEngineConfig": {},
|
|
22872
24497
|
* // "chatEngineMetadata": {},
|
|
22873
24498
|
* // "commonConfig": {},
|
|
24499
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
22874
24500
|
* // "createTime": "my_createTime",
|
|
22875
24501
|
* // "dataStoreIds": [],
|
|
22876
24502
|
* // "disableAnalytics": false,
|
|
@@ -22948,9 +24574,11 @@ export declare namespace discoveryengine_v1beta {
|
|
|
22948
24574
|
*
|
|
22949
24575
|
* // Example response
|
|
22950
24576
|
* // {
|
|
24577
|
+
* // "appType": "my_appType",
|
|
22951
24578
|
* // "chatEngineConfig": {},
|
|
22952
24579
|
* // "chatEngineMetadata": {},
|
|
22953
24580
|
* // "commonConfig": {},
|
|
24581
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
22954
24582
|
* // "createTime": "my_createTime",
|
|
22955
24583
|
* // "dataStoreIds": [],
|
|
22956
24584
|
* // "disableAnalytics": false,
|
|
@@ -24669,6 +26297,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
24669
26297
|
* pageSize: 'placeholder-value',
|
|
24670
26298
|
* // The standard list page token.
|
|
24671
26299
|
* pageToken: 'placeholder-value',
|
|
26300
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
26301
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
24672
26302
|
* },
|
|
24673
26303
|
* );
|
|
24674
26304
|
* console.log(res.data);
|
|
@@ -24676,7 +26306,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
24676
26306
|
* // Example response
|
|
24677
26307
|
* // {
|
|
24678
26308
|
* // "nextPageToken": "my_nextPageToken",
|
|
24679
|
-
* // "operations": []
|
|
26309
|
+
* // "operations": [],
|
|
26310
|
+
* // "unreachable": []
|
|
24680
26311
|
* // }
|
|
24681
26312
|
* }
|
|
24682
26313
|
*
|
|
@@ -24722,6 +26353,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
24722
26353
|
* The standard list page token.
|
|
24723
26354
|
*/
|
|
24724
26355
|
pageToken?: string;
|
|
26356
|
+
/**
|
|
26357
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
26358
|
+
*/
|
|
26359
|
+
returnPartialSuccess?: boolean;
|
|
24725
26360
|
}
|
|
24726
26361
|
export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
|
|
24727
26362
|
context: APIRequestContext;
|
|
@@ -25227,6 +26862,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
25227
26862
|
* // "relevanceScoreSpec": {},
|
|
25228
26863
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
25229
26864
|
* // "safeSearch": false,
|
|
26865
|
+
* // "searchAddonSpec": {},
|
|
25230
26866
|
* // "searchAsYouTypeSpec": {},
|
|
25231
26867
|
* // "servingConfig": "my_servingConfig",
|
|
25232
26868
|
* // "session": "my_session",
|
|
@@ -25349,6 +26985,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
25349
26985
|
* // "relevanceScoreSpec": {},
|
|
25350
26986
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
25351
26987
|
* // "safeSearch": false,
|
|
26988
|
+
* // "searchAddonSpec": {},
|
|
25352
26989
|
* // "searchAsYouTypeSpec": {},
|
|
25353
26990
|
* // "servingConfig": "my_servingConfig",
|
|
25354
26991
|
* // "session": "my_session",
|
|
@@ -26210,13 +27847,16 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26210
27847
|
* pageSize: 'placeholder-value',
|
|
26211
27848
|
* // The standard list page token.
|
|
26212
27849
|
* pageToken: 'placeholder-value',
|
|
27850
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
27851
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
26213
27852
|
* });
|
|
26214
27853
|
* console.log(res.data);
|
|
26215
27854
|
*
|
|
26216
27855
|
* // Example response
|
|
26217
27856
|
* // {
|
|
26218
27857
|
* // "nextPageToken": "my_nextPageToken",
|
|
26219
|
-
* // "operations": []
|
|
27858
|
+
* // "operations": [],
|
|
27859
|
+
* // "unreachable": []
|
|
26220
27860
|
* // }
|
|
26221
27861
|
* }
|
|
26222
27862
|
*
|
|
@@ -26262,6 +27902,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26262
27902
|
* The standard list page token.
|
|
26263
27903
|
*/
|
|
26264
27904
|
pageToken?: string;
|
|
27905
|
+
/**
|
|
27906
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
27907
|
+
*/
|
|
27908
|
+
returnPartialSuccess?: boolean;
|
|
26265
27909
|
}
|
|
26266
27910
|
export class Resource$Projects$Locations$Datastores {
|
|
26267
27911
|
context: APIRequestContext;
|
|
@@ -26403,6 +28047,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26403
28047
|
* // "advancedSiteSearchConfig": {},
|
|
26404
28048
|
* // "billingEstimation": {},
|
|
26405
28049
|
* // "cmekConfig": {},
|
|
28050
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
26406
28051
|
* // "contentConfig": "my_contentConfig",
|
|
26407
28052
|
* // "createTime": "my_createTime",
|
|
26408
28053
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -26559,6 +28204,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26559
28204
|
* // "advancedSiteSearchConfig": {},
|
|
26560
28205
|
* // "billingEstimation": {},
|
|
26561
28206
|
* // "cmekConfig": {},
|
|
28207
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
26562
28208
|
* // "contentConfig": "my_contentConfig",
|
|
26563
28209
|
* // "createTime": "my_createTime",
|
|
26564
28210
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -26769,6 +28415,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26769
28415
|
* // "advancedSiteSearchConfig": {},
|
|
26770
28416
|
* // "billingEstimation": {},
|
|
26771
28417
|
* // "cmekConfig": {},
|
|
28418
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
26772
28419
|
* // "contentConfig": "my_contentConfig",
|
|
26773
28420
|
* // "createTime": "my_createTime",
|
|
26774
28421
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -26797,6 +28444,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26797
28444
|
* // "advancedSiteSearchConfig": {},
|
|
26798
28445
|
* // "billingEstimation": {},
|
|
26799
28446
|
* // "cmekConfig": {},
|
|
28447
|
+
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
26800
28448
|
* // "contentConfig": "my_contentConfig",
|
|
26801
28449
|
* // "createTime": "my_createTime",
|
|
26802
28450
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -27846,6 +29494,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
27846
29494
|
* pageSize: 'placeholder-value',
|
|
27847
29495
|
* // The standard list page token.
|
|
27848
29496
|
* pageToken: 'placeholder-value',
|
|
29497
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
29498
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
27849
29499
|
* },
|
|
27850
29500
|
* );
|
|
27851
29501
|
* console.log(res.data);
|
|
@@ -27853,7 +29503,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
27853
29503
|
* // Example response
|
|
27854
29504
|
* // {
|
|
27855
29505
|
* // "nextPageToken": "my_nextPageToken",
|
|
27856
|
-
* // "operations": []
|
|
29506
|
+
* // "operations": [],
|
|
29507
|
+
* // "unreachable": []
|
|
27857
29508
|
* // }
|
|
27858
29509
|
* }
|
|
27859
29510
|
*
|
|
@@ -27909,6 +29560,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
27909
29560
|
* The standard list page token.
|
|
27910
29561
|
*/
|
|
27911
29562
|
pageToken?: string;
|
|
29563
|
+
/**
|
|
29564
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
29565
|
+
*/
|
|
29566
|
+
returnPartialSuccess?: boolean;
|
|
27912
29567
|
}
|
|
27913
29568
|
export class Resource$Projects$Locations$Datastores$Completionconfig {
|
|
27914
29569
|
context: APIRequestContext;
|
|
@@ -29253,13 +30908,16 @@ export declare namespace discoveryengine_v1beta {
|
|
|
29253
30908
|
* pageSize: 'placeholder-value',
|
|
29254
30909
|
* // The standard list page token.
|
|
29255
30910
|
* pageToken: 'placeholder-value',
|
|
30911
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
30912
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
29256
30913
|
* });
|
|
29257
30914
|
* console.log(res.data);
|
|
29258
30915
|
*
|
|
29259
30916
|
* // Example response
|
|
29260
30917
|
* // {
|
|
29261
30918
|
* // "nextPageToken": "my_nextPageToken",
|
|
29262
|
-
* // "operations": []
|
|
30919
|
+
* // "operations": [],
|
|
30920
|
+
* // "unreachable": []
|
|
29263
30921
|
* // }
|
|
29264
30922
|
* }
|
|
29265
30923
|
*
|
|
@@ -29305,6 +30963,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
29305
30963
|
* The standard list page token.
|
|
29306
30964
|
*/
|
|
29307
30965
|
pageToken?: string;
|
|
30966
|
+
/**
|
|
30967
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
30968
|
+
*/
|
|
30969
|
+
returnPartialSuccess?: boolean;
|
|
29308
30970
|
}
|
|
29309
30971
|
export class Resource$Projects$Locations$Datastores$Operations {
|
|
29310
30972
|
context: APIRequestContext;
|
|
@@ -29414,13 +31076,16 @@ export declare namespace discoveryengine_v1beta {
|
|
|
29414
31076
|
* pageSize: 'placeholder-value',
|
|
29415
31077
|
* // The standard list page token.
|
|
29416
31078
|
* pageToken: 'placeholder-value',
|
|
31079
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
31080
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
29417
31081
|
* });
|
|
29418
31082
|
* console.log(res.data);
|
|
29419
31083
|
*
|
|
29420
31084
|
* // Example response
|
|
29421
31085
|
* // {
|
|
29422
31086
|
* // "nextPageToken": "my_nextPageToken",
|
|
29423
|
-
* // "operations": []
|
|
31087
|
+
* // "operations": [],
|
|
31088
|
+
* // "unreachable": []
|
|
29424
31089
|
* // }
|
|
29425
31090
|
* }
|
|
29426
31091
|
*
|
|
@@ -29466,6 +31131,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
29466
31131
|
* The standard list page token.
|
|
29467
31132
|
*/
|
|
29468
31133
|
pageToken?: string;
|
|
31134
|
+
/**
|
|
31135
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
31136
|
+
*/
|
|
31137
|
+
returnPartialSuccess?: boolean;
|
|
29469
31138
|
}
|
|
29470
31139
|
export class Resource$Projects$Locations$Datastores$Schemas {
|
|
29471
31140
|
context: APIRequestContext;
|
|
@@ -30368,6 +32037,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30368
32037
|
* // "relevanceScoreSpec": {},
|
|
30369
32038
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
30370
32039
|
* // "safeSearch": false,
|
|
32040
|
+
* // "searchAddonSpec": {},
|
|
30371
32041
|
* // "searchAsYouTypeSpec": {},
|
|
30372
32042
|
* // "servingConfig": "my_servingConfig",
|
|
30373
32043
|
* // "session": "my_session",
|
|
@@ -30489,6 +32159,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30489
32159
|
* // "relevanceScoreSpec": {},
|
|
30490
32160
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
30491
32161
|
* // "safeSearch": false,
|
|
32162
|
+
* // "searchAddonSpec": {},
|
|
30492
32163
|
* // "searchAsYouTypeSpec": {},
|
|
30493
32164
|
* // "servingConfig": "my_servingConfig",
|
|
30494
32165
|
* // "session": "my_session",
|
|
@@ -34000,6 +35671,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
34000
35671
|
* pageSize: 'placeholder-value',
|
|
34001
35672
|
* // The standard list page token.
|
|
34002
35673
|
* pageToken: 'placeholder-value',
|
|
35674
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
35675
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
34003
35676
|
* },
|
|
34004
35677
|
* );
|
|
34005
35678
|
* console.log(res.data);
|
|
@@ -34007,7 +35680,8 @@ export declare namespace discoveryengine_v1beta {
|
|
|
34007
35680
|
* // Example response
|
|
34008
35681
|
* // {
|
|
34009
35682
|
* // "nextPageToken": "my_nextPageToken",
|
|
34010
|
-
* // "operations": []
|
|
35683
|
+
* // "operations": [],
|
|
35684
|
+
* // "unreachable": []
|
|
34011
35685
|
* // }
|
|
34012
35686
|
* }
|
|
34013
35687
|
*
|
|
@@ -34053,6 +35727,293 @@ export declare namespace discoveryengine_v1beta {
|
|
|
34053
35727
|
* The standard list page token.
|
|
34054
35728
|
*/
|
|
34055
35729
|
pageToken?: string;
|
|
35730
|
+
/**
|
|
35731
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
35732
|
+
*/
|
|
35733
|
+
returnPartialSuccess?: boolean;
|
|
35734
|
+
}
|
|
35735
|
+
export class Resource$Projects$Locations$Licenseconfigs {
|
|
35736
|
+
context: APIRequestContext;
|
|
35737
|
+
constructor(context: APIRequestContext);
|
|
35738
|
+
/**
|
|
35739
|
+
* Creates a LicenseConfig
|
|
35740
|
+
* @example
|
|
35741
|
+
* ```js
|
|
35742
|
+
* // Before running the sample:
|
|
35743
|
+
* // - Enable the API at:
|
|
35744
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
35745
|
+
* // - Login into gcloud by running:
|
|
35746
|
+
* // ```sh
|
|
35747
|
+
* // $ gcloud auth application-default login
|
|
35748
|
+
* // ```
|
|
35749
|
+
* // - Install the npm module by running:
|
|
35750
|
+
* // ```sh
|
|
35751
|
+
* // $ npm install googleapis
|
|
35752
|
+
* // ```
|
|
35753
|
+
*
|
|
35754
|
+
* const {google} = require('googleapis');
|
|
35755
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
35756
|
+
*
|
|
35757
|
+
* async function main() {
|
|
35758
|
+
* const auth = new google.auth.GoogleAuth({
|
|
35759
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
35760
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
35761
|
+
* });
|
|
35762
|
+
*
|
|
35763
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
35764
|
+
* const authClient = await auth.getClient();
|
|
35765
|
+
* google.options({auth: authClient});
|
|
35766
|
+
*
|
|
35767
|
+
* // Do the magic
|
|
35768
|
+
* const res = await discoveryengine.projects.locations.licenseConfigs.create({
|
|
35769
|
+
* // Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`.
|
|
35770
|
+
* licenseConfigId: 'placeholder-value',
|
|
35771
|
+
* // Required. The parent resource name, such as `projects/{project\}/locations/{location\}`.
|
|
35772
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
35773
|
+
*
|
|
35774
|
+
* // Request body metadata
|
|
35775
|
+
* requestBody: {
|
|
35776
|
+
* // request body parameters
|
|
35777
|
+
* // {
|
|
35778
|
+
* // "alertPolicyResourceConfig": {},
|
|
35779
|
+
* // "autoRenew": false,
|
|
35780
|
+
* // "endDate": {},
|
|
35781
|
+
* // "freeTrial": false,
|
|
35782
|
+
* // "licenseCount": "my_licenseCount",
|
|
35783
|
+
* // "name": "my_name",
|
|
35784
|
+
* // "startDate": {},
|
|
35785
|
+
* // "state": "my_state",
|
|
35786
|
+
* // "subscriptionTerm": "my_subscriptionTerm",
|
|
35787
|
+
* // "subscriptionTier": "my_subscriptionTier"
|
|
35788
|
+
* // }
|
|
35789
|
+
* },
|
|
35790
|
+
* });
|
|
35791
|
+
* console.log(res.data);
|
|
35792
|
+
*
|
|
35793
|
+
* // Example response
|
|
35794
|
+
* // {
|
|
35795
|
+
* // "alertPolicyResourceConfig": {},
|
|
35796
|
+
* // "autoRenew": false,
|
|
35797
|
+
* // "endDate": {},
|
|
35798
|
+
* // "freeTrial": false,
|
|
35799
|
+
* // "licenseCount": "my_licenseCount",
|
|
35800
|
+
* // "name": "my_name",
|
|
35801
|
+
* // "startDate": {},
|
|
35802
|
+
* // "state": "my_state",
|
|
35803
|
+
* // "subscriptionTerm": "my_subscriptionTerm",
|
|
35804
|
+
* // "subscriptionTier": "my_subscriptionTier"
|
|
35805
|
+
* // }
|
|
35806
|
+
* }
|
|
35807
|
+
*
|
|
35808
|
+
* main().catch(e => {
|
|
35809
|
+
* console.error(e);
|
|
35810
|
+
* throw e;
|
|
35811
|
+
* });
|
|
35812
|
+
*
|
|
35813
|
+
* ```
|
|
35814
|
+
*
|
|
35815
|
+
* @param params - Parameters for request
|
|
35816
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
35817
|
+
* @param callback - Optional callback that handles the response.
|
|
35818
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
35819
|
+
*/
|
|
35820
|
+
create(params: Params$Resource$Projects$Locations$Licenseconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
35821
|
+
create(params?: Params$Resource$Projects$Locations$Licenseconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>>;
|
|
35822
|
+
create(params: Params$Resource$Projects$Locations$Licenseconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
35823
|
+
create(params: Params$Resource$Projects$Locations$Licenseconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
35824
|
+
create(params: Params$Resource$Projects$Locations$Licenseconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
35825
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
35826
|
+
/**
|
|
35827
|
+
* Gets a LicenseConfig.
|
|
35828
|
+
* @example
|
|
35829
|
+
* ```js
|
|
35830
|
+
* // Before running the sample:
|
|
35831
|
+
* // - Enable the API at:
|
|
35832
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
35833
|
+
* // - Login into gcloud by running:
|
|
35834
|
+
* // ```sh
|
|
35835
|
+
* // $ gcloud auth application-default login
|
|
35836
|
+
* // ```
|
|
35837
|
+
* // - Install the npm module by running:
|
|
35838
|
+
* // ```sh
|
|
35839
|
+
* // $ npm install googleapis
|
|
35840
|
+
* // ```
|
|
35841
|
+
*
|
|
35842
|
+
* const {google} = require('googleapis');
|
|
35843
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
35844
|
+
*
|
|
35845
|
+
* async function main() {
|
|
35846
|
+
* const auth = new google.auth.GoogleAuth({
|
|
35847
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
35848
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
35849
|
+
* });
|
|
35850
|
+
*
|
|
35851
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
35852
|
+
* const authClient = await auth.getClient();
|
|
35853
|
+
* google.options({auth: authClient});
|
|
35854
|
+
*
|
|
35855
|
+
* // Do the magic
|
|
35856
|
+
* const res = await discoveryengine.projects.locations.licenseConfigs.get({
|
|
35857
|
+
* // Required. Full resource name of LicenseConfig, such as `projects/{project\}/locations/{location\}/licenseConfigs/x`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned.
|
|
35858
|
+
* name: 'projects/my-project/locations/my-location/licenseConfigs/my-licenseConfig',
|
|
35859
|
+
* });
|
|
35860
|
+
* console.log(res.data);
|
|
35861
|
+
*
|
|
35862
|
+
* // Example response
|
|
35863
|
+
* // {
|
|
35864
|
+
* // "alertPolicyResourceConfig": {},
|
|
35865
|
+
* // "autoRenew": false,
|
|
35866
|
+
* // "endDate": {},
|
|
35867
|
+
* // "freeTrial": false,
|
|
35868
|
+
* // "licenseCount": "my_licenseCount",
|
|
35869
|
+
* // "name": "my_name",
|
|
35870
|
+
* // "startDate": {},
|
|
35871
|
+
* // "state": "my_state",
|
|
35872
|
+
* // "subscriptionTerm": "my_subscriptionTerm",
|
|
35873
|
+
* // "subscriptionTier": "my_subscriptionTier"
|
|
35874
|
+
* // }
|
|
35875
|
+
* }
|
|
35876
|
+
*
|
|
35877
|
+
* main().catch(e => {
|
|
35878
|
+
* console.error(e);
|
|
35879
|
+
* throw e;
|
|
35880
|
+
* });
|
|
35881
|
+
*
|
|
35882
|
+
* ```
|
|
35883
|
+
*
|
|
35884
|
+
* @param params - Parameters for request
|
|
35885
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
35886
|
+
* @param callback - Optional callback that handles the response.
|
|
35887
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
35888
|
+
*/
|
|
35889
|
+
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
35890
|
+
get(params?: Params$Resource$Projects$Locations$Licenseconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>>;
|
|
35891
|
+
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
35892
|
+
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
35893
|
+
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
35894
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
35895
|
+
/**
|
|
35896
|
+
* Updates the LicenseConfig
|
|
35897
|
+
* @example
|
|
35898
|
+
* ```js
|
|
35899
|
+
* // Before running the sample:
|
|
35900
|
+
* // - Enable the API at:
|
|
35901
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
35902
|
+
* // - Login into gcloud by running:
|
|
35903
|
+
* // ```sh
|
|
35904
|
+
* // $ gcloud auth application-default login
|
|
35905
|
+
* // ```
|
|
35906
|
+
* // - Install the npm module by running:
|
|
35907
|
+
* // ```sh
|
|
35908
|
+
* // $ npm install googleapis
|
|
35909
|
+
* // ```
|
|
35910
|
+
*
|
|
35911
|
+
* const {google} = require('googleapis');
|
|
35912
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
35913
|
+
*
|
|
35914
|
+
* async function main() {
|
|
35915
|
+
* const auth = new google.auth.GoogleAuth({
|
|
35916
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
35917
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
35918
|
+
* });
|
|
35919
|
+
*
|
|
35920
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
35921
|
+
* const authClient = await auth.getClient();
|
|
35922
|
+
* google.options({auth: authClient});
|
|
35923
|
+
*
|
|
35924
|
+
* // Do the magic
|
|
35925
|
+
* const res = await discoveryengine.projects.locations.licenseConfigs.patch({
|
|
35926
|
+
* // Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
|
|
35927
|
+
* name: 'projects/my-project/locations/my-location/licenseConfigs/my-licenseConfig',
|
|
35928
|
+
* // Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
35929
|
+
* updateMask: 'placeholder-value',
|
|
35930
|
+
*
|
|
35931
|
+
* // Request body metadata
|
|
35932
|
+
* requestBody: {
|
|
35933
|
+
* // request body parameters
|
|
35934
|
+
* // {
|
|
35935
|
+
* // "alertPolicyResourceConfig": {},
|
|
35936
|
+
* // "autoRenew": false,
|
|
35937
|
+
* // "endDate": {},
|
|
35938
|
+
* // "freeTrial": false,
|
|
35939
|
+
* // "licenseCount": "my_licenseCount",
|
|
35940
|
+
* // "name": "my_name",
|
|
35941
|
+
* // "startDate": {},
|
|
35942
|
+
* // "state": "my_state",
|
|
35943
|
+
* // "subscriptionTerm": "my_subscriptionTerm",
|
|
35944
|
+
* // "subscriptionTier": "my_subscriptionTier"
|
|
35945
|
+
* // }
|
|
35946
|
+
* },
|
|
35947
|
+
* });
|
|
35948
|
+
* console.log(res.data);
|
|
35949
|
+
*
|
|
35950
|
+
* // Example response
|
|
35951
|
+
* // {
|
|
35952
|
+
* // "alertPolicyResourceConfig": {},
|
|
35953
|
+
* // "autoRenew": false,
|
|
35954
|
+
* // "endDate": {},
|
|
35955
|
+
* // "freeTrial": false,
|
|
35956
|
+
* // "licenseCount": "my_licenseCount",
|
|
35957
|
+
* // "name": "my_name",
|
|
35958
|
+
* // "startDate": {},
|
|
35959
|
+
* // "state": "my_state",
|
|
35960
|
+
* // "subscriptionTerm": "my_subscriptionTerm",
|
|
35961
|
+
* // "subscriptionTier": "my_subscriptionTier"
|
|
35962
|
+
* // }
|
|
35963
|
+
* }
|
|
35964
|
+
*
|
|
35965
|
+
* main().catch(e => {
|
|
35966
|
+
* console.error(e);
|
|
35967
|
+
* throw e;
|
|
35968
|
+
* });
|
|
35969
|
+
*
|
|
35970
|
+
* ```
|
|
35971
|
+
*
|
|
35972
|
+
* @param params - Parameters for request
|
|
35973
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
35974
|
+
* @param callback - Optional callback that handles the response.
|
|
35975
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
35976
|
+
*/
|
|
35977
|
+
patch(params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
35978
|
+
patch(params?: Params$Resource$Projects$Locations$Licenseconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>>;
|
|
35979
|
+
patch(params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
35980
|
+
patch(params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
35981
|
+
patch(params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
35982
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
35983
|
+
}
|
|
35984
|
+
export interface Params$Resource$Projects$Locations$Licenseconfigs$Create extends StandardParameters {
|
|
35985
|
+
/**
|
|
35986
|
+
* Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`.
|
|
35987
|
+
*/
|
|
35988
|
+
licenseConfigId?: string;
|
|
35989
|
+
/**
|
|
35990
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}`.
|
|
35991
|
+
*/
|
|
35992
|
+
parent?: string;
|
|
35993
|
+
/**
|
|
35994
|
+
* Request body metadata
|
|
35995
|
+
*/
|
|
35996
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig;
|
|
35997
|
+
}
|
|
35998
|
+
export interface Params$Resource$Projects$Locations$Licenseconfigs$Get extends StandardParameters {
|
|
35999
|
+
/**
|
|
36000
|
+
* Required. Full resource name of LicenseConfig, such as `projects/{project\}/locations/{location\}/licenseConfigs/x`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned.
|
|
36001
|
+
*/
|
|
36002
|
+
name?: string;
|
|
36003
|
+
}
|
|
36004
|
+
export interface Params$Resource$Projects$Locations$Licenseconfigs$Patch extends StandardParameters {
|
|
36005
|
+
/**
|
|
36006
|
+
* Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
|
|
36007
|
+
*/
|
|
36008
|
+
name?: string;
|
|
36009
|
+
/**
|
|
36010
|
+
* Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
36011
|
+
*/
|
|
36012
|
+
updateMask?: string;
|
|
36013
|
+
/**
|
|
36014
|
+
* Request body metadata
|
|
36015
|
+
*/
|
|
36016
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig;
|
|
34056
36017
|
}
|
|
34057
36018
|
export class Resource$Projects$Locations$Operations {
|
|
34058
36019
|
context: APIRequestContext;
|
|
@@ -34160,13 +36121,16 @@ export declare namespace discoveryengine_v1beta {
|
|
|
34160
36121
|
* pageSize: 'placeholder-value',
|
|
34161
36122
|
* // The standard list page token.
|
|
34162
36123
|
* pageToken: 'placeholder-value',
|
|
36124
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
36125
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
34163
36126
|
* });
|
|
34164
36127
|
* console.log(res.data);
|
|
34165
36128
|
*
|
|
34166
36129
|
* // Example response
|
|
34167
36130
|
* // {
|
|
34168
36131
|
* // "nextPageToken": "my_nextPageToken",
|
|
34169
|
-
* // "operations": []
|
|
36132
|
+
* // "operations": [],
|
|
36133
|
+
* // "unreachable": []
|
|
34170
36134
|
* // }
|
|
34171
36135
|
* }
|
|
34172
36136
|
*
|
|
@@ -34212,6 +36176,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
34212
36176
|
* The standard list page token.
|
|
34213
36177
|
*/
|
|
34214
36178
|
pageToken?: string;
|
|
36179
|
+
/**
|
|
36180
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
36181
|
+
*/
|
|
36182
|
+
returnPartialSuccess?: boolean;
|
|
34215
36183
|
}
|
|
34216
36184
|
export class Resource$Projects$Locations$Podcasts {
|
|
34217
36185
|
context: APIRequestContext;
|
|
@@ -35938,13 +37906,16 @@ export declare namespace discoveryengine_v1beta {
|
|
|
35938
37906
|
* pageSize: 'placeholder-value',
|
|
35939
37907
|
* // The standard list page token.
|
|
35940
37908
|
* pageToken: 'placeholder-value',
|
|
37909
|
+
* // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
37910
|
+
* returnPartialSuccess: 'placeholder-value',
|
|
35941
37911
|
* });
|
|
35942
37912
|
* console.log(res.data);
|
|
35943
37913
|
*
|
|
35944
37914
|
* // Example response
|
|
35945
37915
|
* // {
|
|
35946
37916
|
* // "nextPageToken": "my_nextPageToken",
|
|
35947
|
-
* // "operations": []
|
|
37917
|
+
* // "operations": [],
|
|
37918
|
+
* // "unreachable": []
|
|
35948
37919
|
* // }
|
|
35949
37920
|
* }
|
|
35950
37921
|
*
|
|
@@ -35990,6 +37961,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
35990
37961
|
* The standard list page token.
|
|
35991
37962
|
*/
|
|
35992
37963
|
pageToken?: string;
|
|
37964
|
+
/**
|
|
37965
|
+
* When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
|
|
37966
|
+
*/
|
|
37967
|
+
returnPartialSuccess?: boolean;
|
|
35993
37968
|
}
|
|
35994
37969
|
export {};
|
|
35995
37970
|
}
|