@googleapis/discoveryengine 2.0.0 → 3.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/v1alpha.d.ts +869 -26
- package/build/v1alpha.js +669 -18
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +354 -16
- package/build/v1beta.js +80 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1alpha.ts +4471 -1961
- package/v1beta.ts +530 -16
package/build/v1alpha.d.ts
CHANGED
|
@@ -202,15 +202,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
202
202
|
*/
|
|
203
203
|
token?: string | null;
|
|
204
204
|
}
|
|
205
|
-
/**
|
|
206
|
-
* Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
|
207
|
-
*/
|
|
208
|
-
export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse {
|
|
209
|
-
/**
|
|
210
|
-
* TargetSites created.
|
|
211
|
-
*/
|
|
212
|
-
targetSites?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite[];
|
|
213
|
-
}
|
|
214
205
|
/**
|
|
215
206
|
* BigQuery source import data from.
|
|
216
207
|
*/
|
|
@@ -419,6 +410,32 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
419
410
|
*/
|
|
420
411
|
searchResults?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult[];
|
|
421
412
|
}
|
|
413
|
+
/**
|
|
414
|
+
* Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
415
|
+
*/
|
|
416
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata {
|
|
417
|
+
/**
|
|
418
|
+
* Operation create time.
|
|
419
|
+
*/
|
|
420
|
+
createTime?: string | null;
|
|
421
|
+
/**
|
|
422
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
423
|
+
*/
|
|
424
|
+
updateTime?: string | null;
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
427
|
+
* Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
428
|
+
*/
|
|
429
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata {
|
|
430
|
+
/**
|
|
431
|
+
* Operation create time.
|
|
432
|
+
*/
|
|
433
|
+
createTime?: string | null;
|
|
434
|
+
/**
|
|
435
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
436
|
+
*/
|
|
437
|
+
updateTime?: string | null;
|
|
438
|
+
}
|
|
422
439
|
/**
|
|
423
440
|
* Metadata for Create Schema LRO.
|
|
424
441
|
*/
|
|
@@ -445,6 +462,65 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
445
462
|
*/
|
|
446
463
|
text?: string[] | null;
|
|
447
464
|
}
|
|
465
|
+
/**
|
|
466
|
+
* DataStore captures global settings and configs at the DataStore level.
|
|
467
|
+
*/
|
|
468
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStore {
|
|
469
|
+
/**
|
|
470
|
+
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
471
|
+
*/
|
|
472
|
+
contentConfig?: string | null;
|
|
473
|
+
/**
|
|
474
|
+
* Output only. Timestamp the DataStore was created at.
|
|
475
|
+
*/
|
|
476
|
+
createTime?: string | null;
|
|
477
|
+
/**
|
|
478
|
+
* Output only. The id of the default Schema asscociated to this data store.
|
|
479
|
+
*/
|
|
480
|
+
defaultSchemaId?: string | null;
|
|
481
|
+
/**
|
|
482
|
+
* Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
483
|
+
*/
|
|
484
|
+
displayName?: string | null;
|
|
485
|
+
/**
|
|
486
|
+
* Immutable. The industry vertical that the data store registers.
|
|
487
|
+
*/
|
|
488
|
+
industryVertical?: string | null;
|
|
489
|
+
/**
|
|
490
|
+
* Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
491
|
+
*/
|
|
492
|
+
name?: string | null;
|
|
493
|
+
/**
|
|
494
|
+
* The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
|
|
495
|
+
*/
|
|
496
|
+
solutionTypes?: string[] | null;
|
|
497
|
+
}
|
|
498
|
+
/**
|
|
499
|
+
* Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
500
|
+
*/
|
|
501
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
|
|
502
|
+
/**
|
|
503
|
+
* Operation create time.
|
|
504
|
+
*/
|
|
505
|
+
createTime?: string | null;
|
|
506
|
+
/**
|
|
507
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
508
|
+
*/
|
|
509
|
+
updateTime?: string | null;
|
|
510
|
+
}
|
|
511
|
+
/**
|
|
512
|
+
* Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
513
|
+
*/
|
|
514
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata {
|
|
515
|
+
/**
|
|
516
|
+
* Operation create time.
|
|
517
|
+
*/
|
|
518
|
+
createTime?: string | null;
|
|
519
|
+
/**
|
|
520
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
521
|
+
*/
|
|
522
|
+
updateTime?: string | null;
|
|
523
|
+
}
|
|
448
524
|
/**
|
|
449
525
|
* Metadata for DeleteSchema LRO.
|
|
450
526
|
*/
|
|
@@ -550,6 +626,188 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
550
626
|
*/
|
|
551
627
|
values?: number[] | null;
|
|
552
628
|
}
|
|
629
|
+
/**
|
|
630
|
+
* Metadata that describes the training and serving parameters of an Engine.
|
|
631
|
+
*/
|
|
632
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine {
|
|
633
|
+
/**
|
|
634
|
+
* Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
635
|
+
*/
|
|
636
|
+
chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
|
|
637
|
+
/**
|
|
638
|
+
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
639
|
+
*/
|
|
640
|
+
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata;
|
|
641
|
+
/**
|
|
642
|
+
* Common config spec that specifies the metadata of the engine.
|
|
643
|
+
*/
|
|
644
|
+
commonConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig;
|
|
645
|
+
/**
|
|
646
|
+
* Output only. Timestamp the Recommendation Engine was created at.
|
|
647
|
+
*/
|
|
648
|
+
createTime?: string | null;
|
|
649
|
+
/**
|
|
650
|
+
* The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations.
|
|
651
|
+
*/
|
|
652
|
+
dataStoreIds?: string[] | null;
|
|
653
|
+
/**
|
|
654
|
+
* Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
|
|
655
|
+
*/
|
|
656
|
+
displayName?: string | null;
|
|
657
|
+
/**
|
|
658
|
+
* The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.
|
|
659
|
+
*/
|
|
660
|
+
industryVertical?: string | null;
|
|
661
|
+
/**
|
|
662
|
+
* Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
|
|
663
|
+
*/
|
|
664
|
+
mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
|
|
665
|
+
/**
|
|
666
|
+
* Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
667
|
+
*/
|
|
668
|
+
name?: string | null;
|
|
669
|
+
/**
|
|
670
|
+
* Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
|
|
671
|
+
*/
|
|
672
|
+
recommendationMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
|
|
673
|
+
/**
|
|
674
|
+
* Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
675
|
+
*/
|
|
676
|
+
searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig;
|
|
677
|
+
/**
|
|
678
|
+
* Additional config specs for a `similar-items` engine.
|
|
679
|
+
*/
|
|
680
|
+
similarDocumentsConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig;
|
|
681
|
+
/**
|
|
682
|
+
* Required. The solutions of the engine.
|
|
683
|
+
*/
|
|
684
|
+
solutionType?: string | null;
|
|
685
|
+
/**
|
|
686
|
+
* Output only. Timestamp the Recommendation Engine was last updated.
|
|
687
|
+
*/
|
|
688
|
+
updateTime?: string | null;
|
|
689
|
+
}
|
|
690
|
+
/**
|
|
691
|
+
* Configurations for a Chat Engine.
|
|
692
|
+
*/
|
|
693
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig {
|
|
694
|
+
/**
|
|
695
|
+
* The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
696
|
+
*/
|
|
697
|
+
agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
|
|
698
|
+
/**
|
|
699
|
+
* The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use chat_engine_metadata.dialogflow_agent for actual agent association after Engine is created.
|
|
700
|
+
*/
|
|
701
|
+
dialogflowAgentToLink?: string | null;
|
|
702
|
+
}
|
|
703
|
+
/**
|
|
704
|
+
* Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
705
|
+
*/
|
|
706
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig {
|
|
707
|
+
/**
|
|
708
|
+
* Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
|
|
709
|
+
*/
|
|
710
|
+
business?: string | null;
|
|
711
|
+
/**
|
|
712
|
+
* Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
|
|
713
|
+
*/
|
|
714
|
+
defaultLanguageCode?: string | null;
|
|
715
|
+
/**
|
|
716
|
+
* Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
|
|
717
|
+
*/
|
|
718
|
+
timeZone?: string | null;
|
|
719
|
+
}
|
|
720
|
+
/**
|
|
721
|
+
* Additional information of a Chat Engine. Fields in this message are output only.
|
|
722
|
+
*/
|
|
723
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata {
|
|
724
|
+
/**
|
|
725
|
+
* The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
|
|
726
|
+
*/
|
|
727
|
+
dialogflowAgent?: string | null;
|
|
728
|
+
}
|
|
729
|
+
/**
|
|
730
|
+
* Common configurations for an Engine.
|
|
731
|
+
*/
|
|
732
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
|
|
733
|
+
/**
|
|
734
|
+
* The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
|
|
735
|
+
*/
|
|
736
|
+
companyName?: string | null;
|
|
737
|
+
}
|
|
738
|
+
/**
|
|
739
|
+
* Additional config specs for a Media Recommendation engine.
|
|
740
|
+
*/
|
|
741
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
|
|
742
|
+
/**
|
|
743
|
+
* The optimization objective e.g. `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` =\> `ctr` `others-you-may-like` =\> `ctr`
|
|
744
|
+
*/
|
|
745
|
+
optimizationObjective?: string | null;
|
|
746
|
+
/**
|
|
747
|
+
* Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).
|
|
748
|
+
*/
|
|
749
|
+
optimizationObjectiveConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig;
|
|
750
|
+
/**
|
|
751
|
+
* The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.
|
|
752
|
+
*/
|
|
753
|
+
trainingState?: string | null;
|
|
754
|
+
/**
|
|
755
|
+
* Required. The type of engine e.g. `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
|
|
756
|
+
*/
|
|
757
|
+
type?: string | null;
|
|
758
|
+
}
|
|
759
|
+
/**
|
|
760
|
+
* Custom threshold for `cvr` optimization_objective.
|
|
761
|
+
*/
|
|
762
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig {
|
|
763
|
+
/**
|
|
764
|
+
* Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.
|
|
765
|
+
*/
|
|
766
|
+
targetField?: string | null;
|
|
767
|
+
/**
|
|
768
|
+
* Required. The threshold to be applied to the target (e.g., 0.5).
|
|
769
|
+
*/
|
|
770
|
+
targetFieldValueFloat?: number | null;
|
|
771
|
+
}
|
|
772
|
+
/**
|
|
773
|
+
* Additional information of a recommendation engine.
|
|
774
|
+
*/
|
|
775
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata {
|
|
776
|
+
/**
|
|
777
|
+
* Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
|
|
778
|
+
*/
|
|
779
|
+
dataState?: string | null;
|
|
780
|
+
/**
|
|
781
|
+
* Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.
|
|
782
|
+
*/
|
|
783
|
+
lastTuneTime?: string | null;
|
|
784
|
+
/**
|
|
785
|
+
* Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.
|
|
786
|
+
*/
|
|
787
|
+
servingState?: string | null;
|
|
788
|
+
/**
|
|
789
|
+
* Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.
|
|
790
|
+
*/
|
|
791
|
+
tuningOperation?: string | null;
|
|
792
|
+
}
|
|
793
|
+
/**
|
|
794
|
+
* Configurations for a Search Engine.
|
|
795
|
+
*/
|
|
796
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
|
|
797
|
+
/**
|
|
798
|
+
* The add-on that this search engine enables.
|
|
799
|
+
*/
|
|
800
|
+
searchAddOns?: string[] | null;
|
|
801
|
+
/**
|
|
802
|
+
* The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
|
|
803
|
+
*/
|
|
804
|
+
searchTier?: string | null;
|
|
805
|
+
}
|
|
806
|
+
/**
|
|
807
|
+
* Additional config specs for a `similar-items` engine.
|
|
808
|
+
*/
|
|
809
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {
|
|
810
|
+
}
|
|
553
811
|
/**
|
|
554
812
|
* Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
|
|
555
813
|
*/
|
|
@@ -795,6 +1053,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
795
1053
|
*/
|
|
796
1054
|
nextPageToken?: string | null;
|
|
797
1055
|
}
|
|
1056
|
+
/**
|
|
1057
|
+
* Response message for DataStoreService.ListDataStores method.
|
|
1058
|
+
*/
|
|
1059
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListDataStoresResponse {
|
|
1060
|
+
/**
|
|
1061
|
+
* All the customer's DataStores.
|
|
1062
|
+
*/
|
|
1063
|
+
dataStores?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore[];
|
|
1064
|
+
/**
|
|
1065
|
+
* A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
|
1066
|
+
*/
|
|
1067
|
+
nextPageToken?: string | null;
|
|
1068
|
+
}
|
|
798
1069
|
/**
|
|
799
1070
|
* Response message for DocumentService.ListDocuments method.
|
|
800
1071
|
*/
|
|
@@ -808,6 +1079,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
808
1079
|
*/
|
|
809
1080
|
nextPageToken?: string | null;
|
|
810
1081
|
}
|
|
1082
|
+
/**
|
|
1083
|
+
* Response message for EngineService.ListEngines method.
|
|
1084
|
+
*/
|
|
1085
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaListEnginesResponse {
|
|
1086
|
+
/**
|
|
1087
|
+
* All the customer's Engines.
|
|
1088
|
+
*/
|
|
1089
|
+
engines?: Schema$GoogleCloudDiscoveryengineV1alphaEngine[];
|
|
1090
|
+
/**
|
|
1091
|
+
* Not supported.
|
|
1092
|
+
*/
|
|
1093
|
+
nextPageToken?: string | null;
|
|
1094
|
+
}
|
|
811
1095
|
/**
|
|
812
1096
|
* Response message for SchemaService.ListSchemas method.
|
|
813
1097
|
*/
|
|
@@ -894,6 +1178,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
894
1178
|
*/
|
|
895
1179
|
totalPanels?: number | null;
|
|
896
1180
|
}
|
|
1181
|
+
/**
|
|
1182
|
+
* Request for pausing training of an engine.
|
|
1183
|
+
*/
|
|
1184
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPauseEngineRequest {
|
|
1185
|
+
}
|
|
897
1186
|
/**
|
|
898
1187
|
* Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
899
1188
|
*/
|
|
@@ -989,7 +1278,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
989
1278
|
*/
|
|
990
1279
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest {
|
|
991
1280
|
/**
|
|
992
|
-
* Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
|
|
1281
|
+
* Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
|
|
993
1282
|
*/
|
|
994
1283
|
filter?: string | null;
|
|
995
1284
|
/**
|
|
@@ -997,7 +1286,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
997
1286
|
*/
|
|
998
1287
|
pageSize?: number | null;
|
|
999
1288
|
/**
|
|
1000
|
-
* Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category.
|
|
1289
|
+
* Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.
|
|
1001
1290
|
*/
|
|
1002
1291
|
params?: {
|
|
1003
1292
|
[key: string]: any;
|
|
@@ -1176,6 +1465,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1176
1465
|
*/
|
|
1177
1466
|
uri?: string | null;
|
|
1178
1467
|
}
|
|
1468
|
+
/**
|
|
1469
|
+
* Request for resuming training of an engine.
|
|
1470
|
+
*/
|
|
1471
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {
|
|
1472
|
+
}
|
|
1179
1473
|
/**
|
|
1180
1474
|
* Defines the structure and layout of a type of document data.
|
|
1181
1475
|
*/
|
|
@@ -1221,13 +1515,17 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1221
1515
|
*/
|
|
1222
1516
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest {
|
|
1223
1517
|
/**
|
|
1224
|
-
* Boost specification to boost certain documents.
|
|
1518
|
+
* Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
|
1225
1519
|
*/
|
|
1226
1520
|
boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
1227
1521
|
/**
|
|
1228
1522
|
* The branch resource name, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
|
|
1229
1523
|
*/
|
|
1230
1524
|
branch?: string | null;
|
|
1525
|
+
/**
|
|
1526
|
+
* The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
|
|
1527
|
+
*/
|
|
1528
|
+
canonicalFilter?: string | null;
|
|
1231
1529
|
/**
|
|
1232
1530
|
* A specification for configuring the behavior of content search.
|
|
1233
1531
|
*/
|
|
@@ -1241,7 +1539,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1241
1539
|
*/
|
|
1242
1540
|
facetSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[];
|
|
1243
1541
|
/**
|
|
1244
|
-
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
1542
|
+
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
|
1245
1543
|
*/
|
|
1246
1544
|
filter?: string | null;
|
|
1247
1545
|
/**
|
|
@@ -1253,7 +1551,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1253
1551
|
*/
|
|
1254
1552
|
offset?: number | null;
|
|
1255
1553
|
/**
|
|
1256
|
-
* The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
1554
|
+
* The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
|
1257
1555
|
*/
|
|
1258
1556
|
orderBy?: string | null;
|
|
1259
1557
|
/**
|
|
@@ -1265,7 +1563,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1265
1563
|
*/
|
|
1266
1564
|
pageToken?: string | null;
|
|
1267
1565
|
/**
|
|
1268
|
-
* Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
|
|
1566
|
+
* Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1
|
|
1269
1567
|
*/
|
|
1270
1568
|
params?: {
|
|
1271
1569
|
[key: string]: any;
|
|
@@ -1287,7 +1585,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1287
1585
|
*/
|
|
1288
1586
|
safeSearch?: boolean | null;
|
|
1289
1587
|
/**
|
|
1290
|
-
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
1588
|
+
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
1291
1589
|
*/
|
|
1292
1590
|
servingConfig?: string | null;
|
|
1293
1591
|
/**
|
|
@@ -1810,6 +2108,25 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1810
2108
|
*/
|
|
1811
2109
|
value?: number | null;
|
|
1812
2110
|
}
|
|
2111
|
+
/**
|
|
2112
|
+
* Metadata associated with a tune operation.
|
|
2113
|
+
*/
|
|
2114
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata {
|
|
2115
|
+
/**
|
|
2116
|
+
* Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`
|
|
2117
|
+
*/
|
|
2118
|
+
engine?: string | null;
|
|
2119
|
+
}
|
|
2120
|
+
/**
|
|
2121
|
+
* Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).
|
|
2122
|
+
*/
|
|
2123
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineRequest {
|
|
2124
|
+
}
|
|
2125
|
+
/**
|
|
2126
|
+
* Response associated with a tune operation.
|
|
2127
|
+
*/
|
|
2128
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {
|
|
2129
|
+
}
|
|
1813
2130
|
/**
|
|
1814
2131
|
* Metadata for UpdateSchema LRO.
|
|
1815
2132
|
*/
|
|
@@ -2699,11 +3016,73 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2699
3016
|
}
|
|
2700
3017
|
export class Resource$Projects$Locations$Collections {
|
|
2701
3018
|
context: APIRequestContext;
|
|
3019
|
+
dataConnector: Resource$Projects$Locations$Collections$Dataconnector;
|
|
2702
3020
|
dataStores: Resource$Projects$Locations$Collections$Datastores;
|
|
2703
3021
|
engines: Resource$Projects$Locations$Collections$Engines;
|
|
2704
3022
|
operations: Resource$Projects$Locations$Collections$Operations;
|
|
2705
3023
|
constructor(context: APIRequestContext);
|
|
2706
3024
|
}
|
|
3025
|
+
export class Resource$Projects$Locations$Collections$Dataconnector {
|
|
3026
|
+
context: APIRequestContext;
|
|
3027
|
+
operations: Resource$Projects$Locations$Collections$Dataconnector$Operations;
|
|
3028
|
+
constructor(context: APIRequestContext);
|
|
3029
|
+
}
|
|
3030
|
+
export class Resource$Projects$Locations$Collections$Dataconnector$Operations {
|
|
3031
|
+
context: APIRequestContext;
|
|
3032
|
+
constructor(context: APIRequestContext);
|
|
3033
|
+
/**
|
|
3034
|
+
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
3035
|
+
*
|
|
3036
|
+
* @param params - Parameters for request
|
|
3037
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3038
|
+
* @param callback - Optional callback that handles the response.
|
|
3039
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3040
|
+
*/
|
|
3041
|
+
get(params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3042
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
3043
|
+
get(params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3044
|
+
get(params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3045
|
+
get(params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3046
|
+
get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3047
|
+
/**
|
|
3048
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
3049
|
+
*
|
|
3050
|
+
* @param params - Parameters for request
|
|
3051
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3052
|
+
* @param callback - Optional callback that handles the response.
|
|
3053
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3054
|
+
*/
|
|
3055
|
+
list(params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3056
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
|
|
3057
|
+
list(params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3058
|
+
list(params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
3059
|
+
list(params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
3060
|
+
list(callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>): void;
|
|
3061
|
+
}
|
|
3062
|
+
export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get extends StandardParameters {
|
|
3063
|
+
/**
|
|
3064
|
+
* The name of the operation resource.
|
|
3065
|
+
*/
|
|
3066
|
+
name?: string;
|
|
3067
|
+
}
|
|
3068
|
+
export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List extends StandardParameters {
|
|
3069
|
+
/**
|
|
3070
|
+
* The standard list filter.
|
|
3071
|
+
*/
|
|
3072
|
+
filter?: string;
|
|
3073
|
+
/**
|
|
3074
|
+
* The name of the operation's parent resource.
|
|
3075
|
+
*/
|
|
3076
|
+
name?: string;
|
|
3077
|
+
/**
|
|
3078
|
+
* The standard list page size.
|
|
3079
|
+
*/
|
|
3080
|
+
pageSize?: number;
|
|
3081
|
+
/**
|
|
3082
|
+
* The standard list page token.
|
|
3083
|
+
*/
|
|
3084
|
+
pageToken?: string;
|
|
3085
|
+
}
|
|
2707
3086
|
export class Resource$Projects$Locations$Collections$Datastores {
|
|
2708
3087
|
context: APIRequestContext;
|
|
2709
3088
|
branches: Resource$Projects$Locations$Collections$Datastores$Branches;
|
|
@@ -2729,11 +3108,81 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2729
3108
|
completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>): void;
|
|
2730
3109
|
completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>): void;
|
|
2731
3110
|
completeQuery(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>): void;
|
|
2732
|
-
}
|
|
2733
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery extends StandardParameters {
|
|
2734
3111
|
/**
|
|
2735
|
-
*
|
|
2736
|
-
|
|
3112
|
+
* Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
|
|
3113
|
+
*
|
|
3114
|
+
* @param params - Parameters for request
|
|
3115
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3116
|
+
* @param callback - Optional callback that handles the response.
|
|
3117
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3118
|
+
*/
|
|
3119
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3120
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
3121
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3122
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3123
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3124
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3125
|
+
/**
|
|
3126
|
+
* Deletes a DataStore.
|
|
3127
|
+
*
|
|
3128
|
+
* @param params - Parameters for request
|
|
3129
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3130
|
+
* @param callback - Optional callback that handles the response.
|
|
3131
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3132
|
+
*/
|
|
3133
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3134
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
3135
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3136
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3137
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3138
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
3139
|
+
/**
|
|
3140
|
+
* Gets a DataStore.
|
|
3141
|
+
*
|
|
3142
|
+
* @param params - Parameters for request
|
|
3143
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3144
|
+
* @param callback - Optional callback that handles the response.
|
|
3145
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3146
|
+
*/
|
|
3147
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3148
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>;
|
|
3149
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3150
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
3151
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
3152
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
3153
|
+
/**
|
|
3154
|
+
* Lists all the DataStores associated with the project.
|
|
3155
|
+
*
|
|
3156
|
+
* @param params - Parameters for request
|
|
3157
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3158
|
+
* @param callback - Optional callback that handles the response.
|
|
3159
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3160
|
+
*/
|
|
3161
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3162
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>;
|
|
3163
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3164
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>): void;
|
|
3165
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>): void;
|
|
3166
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>): void;
|
|
3167
|
+
/**
|
|
3168
|
+
* Updates a DataStore
|
|
3169
|
+
*
|
|
3170
|
+
* @param params - Parameters for request
|
|
3171
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3172
|
+
* @param callback - Optional callback that handles the response.
|
|
3173
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3174
|
+
*/
|
|
3175
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
3176
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>;
|
|
3177
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3178
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
3179
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
3180
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
3181
|
+
}
|
|
3182
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery extends StandardParameters {
|
|
3183
|
+
/**
|
|
3184
|
+
* Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`.
|
|
3185
|
+
*/
|
|
2737
3186
|
dataStore?: string;
|
|
2738
3187
|
/**
|
|
2739
3188
|
* Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
|
|
@@ -2752,6 +3201,68 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2752
3201
|
*/
|
|
2753
3202
|
userPseudoId?: string;
|
|
2754
3203
|
}
|
|
3204
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Create extends StandardParameters {
|
|
3205
|
+
/**
|
|
3206
|
+
* A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
|
|
3207
|
+
*/
|
|
3208
|
+
createAdvancedSiteSearch?: boolean;
|
|
3209
|
+
/**
|
|
3210
|
+
* Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3211
|
+
*/
|
|
3212
|
+
dataStoreId?: string;
|
|
3213
|
+
/**
|
|
3214
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`.
|
|
3215
|
+
*/
|
|
3216
|
+
parent?: string;
|
|
3217
|
+
/**
|
|
3218
|
+
* Request body metadata
|
|
3219
|
+
*/
|
|
3220
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore;
|
|
3221
|
+
}
|
|
3222
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Delete extends StandardParameters {
|
|
3223
|
+
/**
|
|
3224
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.
|
|
3225
|
+
*/
|
|
3226
|
+
name?: string;
|
|
3227
|
+
}
|
|
3228
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Get extends StandardParameters {
|
|
3229
|
+
/**
|
|
3230
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.
|
|
3231
|
+
*/
|
|
3232
|
+
name?: string;
|
|
3233
|
+
}
|
|
3234
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$List extends StandardParameters {
|
|
3235
|
+
/**
|
|
3236
|
+
* Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'
|
|
3237
|
+
*/
|
|
3238
|
+
filter?: string;
|
|
3239
|
+
/**
|
|
3240
|
+
* Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.
|
|
3241
|
+
*/
|
|
3242
|
+
pageSize?: number;
|
|
3243
|
+
/**
|
|
3244
|
+
* A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3245
|
+
*/
|
|
3246
|
+
pageToken?: string;
|
|
3247
|
+
/**
|
|
3248
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStoress under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
|
|
3249
|
+
*/
|
|
3250
|
+
parent?: string;
|
|
3251
|
+
}
|
|
3252
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch extends StandardParameters {
|
|
3253
|
+
/**
|
|
3254
|
+
* Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
3255
|
+
*/
|
|
3256
|
+
name?: string;
|
|
3257
|
+
/**
|
|
3258
|
+
* Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
3259
|
+
*/
|
|
3260
|
+
updateMask?: string;
|
|
3261
|
+
/**
|
|
3262
|
+
* Request body metadata
|
|
3263
|
+
*/
|
|
3264
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore;
|
|
3265
|
+
}
|
|
2755
3266
|
export class Resource$Projects$Locations$Collections$Datastores$Branches {
|
|
2756
3267
|
context: APIRequestContext;
|
|
2757
3268
|
documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents;
|
|
@@ -3482,7 +3993,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3482
3993
|
}
|
|
3483
3994
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
3484
3995
|
/**
|
|
3485
|
-
* Required. Full resource name of
|
|
3996
|
+
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
|
|
3486
3997
|
*/
|
|
3487
3998
|
servingConfig?: string;
|
|
3488
3999
|
/**
|
|
@@ -3492,7 +4003,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3492
4003
|
}
|
|
3493
4004
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search extends StandardParameters {
|
|
3494
4005
|
/**
|
|
3495
|
-
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
4006
|
+
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
3496
4007
|
*/
|
|
3497
4008
|
servingConfig?: string;
|
|
3498
4009
|
/**
|
|
@@ -3760,6 +4271,206 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3760
4271
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
3761
4272
|
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
3762
4273
|
constructor(context: APIRequestContext);
|
|
4274
|
+
/**
|
|
4275
|
+
* Creates a Engine.
|
|
4276
|
+
*
|
|
4277
|
+
* @param params - Parameters for request
|
|
4278
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4279
|
+
* @param callback - Optional callback that handles the response.
|
|
4280
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4281
|
+
*/
|
|
4282
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4283
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4284
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4285
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4286
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4287
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4288
|
+
/**
|
|
4289
|
+
* Deletes a Engine.
|
|
4290
|
+
*
|
|
4291
|
+
* @param params - Parameters for request
|
|
4292
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4293
|
+
* @param callback - Optional callback that handles the response.
|
|
4294
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4295
|
+
*/
|
|
4296
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4297
|
+
delete(params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4298
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4299
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4300
|
+
delete(params: Params$Resource$Projects$Locations$Collections$Engines$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4301
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4302
|
+
/**
|
|
4303
|
+
* Gets a Engine.
|
|
4304
|
+
*
|
|
4305
|
+
* @param params - Parameters for request
|
|
4306
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4307
|
+
* @param callback - Optional callback that handles the response.
|
|
4308
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4309
|
+
*/
|
|
4310
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4311
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaEngine>;
|
|
4312
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4313
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
4314
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
4315
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
4316
|
+
/**
|
|
4317
|
+
* Lists all the Engines associated with the project.
|
|
4318
|
+
*
|
|
4319
|
+
* @param params - Parameters for request
|
|
4320
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4321
|
+
* @param callback - Optional callback that handles the response.
|
|
4322
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4323
|
+
*/
|
|
4324
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4325
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListEnginesResponse>;
|
|
4326
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4327
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListEnginesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListEnginesResponse>): void;
|
|
4328
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListEnginesResponse>): void;
|
|
4329
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListEnginesResponse>): void;
|
|
4330
|
+
/**
|
|
4331
|
+
* Updates an Engine
|
|
4332
|
+
*
|
|
4333
|
+
* @param params - Parameters for request
|
|
4334
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4335
|
+
* @param callback - Optional callback that handles the response.
|
|
4336
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4337
|
+
*/
|
|
4338
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4339
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaEngine>;
|
|
4340
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4341
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
4342
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
4343
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
4344
|
+
/**
|
|
4345
|
+
* Pauses the training of an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
|
|
4346
|
+
*
|
|
4347
|
+
* @param params - Parameters for request
|
|
4348
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4349
|
+
* @param callback - Optional callback that handles the response.
|
|
4350
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4351
|
+
*/
|
|
4352
|
+
pause(params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4353
|
+
pause(params?: Params$Resource$Projects$Locations$Collections$Engines$Pause, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaEngine>;
|
|
4354
|
+
pause(params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4355
|
+
pause(params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
4356
|
+
pause(params: Params$Resource$Projects$Locations$Collections$Engines$Pause, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
4357
|
+
pause(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
4358
|
+
/**
|
|
4359
|
+
* Resumes the training of an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
|
|
4360
|
+
*
|
|
4361
|
+
* @param params - Parameters for request
|
|
4362
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4363
|
+
* @param callback - Optional callback that handles the response.
|
|
4364
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4365
|
+
*/
|
|
4366
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4367
|
+
resume(params?: Params$Resource$Projects$Locations$Collections$Engines$Resume, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaEngine>;
|
|
4368
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4369
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
4370
|
+
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Resume, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
4371
|
+
resume(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
|
|
4372
|
+
/**
|
|
4373
|
+
* Tunes an existing engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
|
|
4374
|
+
*
|
|
4375
|
+
* @param params - Parameters for request
|
|
4376
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4377
|
+
* @param callback - Optional callback that handles the response.
|
|
4378
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4379
|
+
*/
|
|
4380
|
+
tune(params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4381
|
+
tune(params?: Params$Resource$Projects$Locations$Collections$Engines$Tune, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4382
|
+
tune(params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4383
|
+
tune(params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4384
|
+
tune(params: Params$Resource$Projects$Locations$Collections$Engines$Tune, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4385
|
+
tune(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4386
|
+
}
|
|
4387
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Create extends StandardParameters {
|
|
4388
|
+
/**
|
|
4389
|
+
* Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
4390
|
+
*/
|
|
4391
|
+
engineId?: string;
|
|
4392
|
+
/**
|
|
4393
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`.
|
|
4394
|
+
*/
|
|
4395
|
+
parent?: string;
|
|
4396
|
+
/**
|
|
4397
|
+
* Request body metadata
|
|
4398
|
+
*/
|
|
4399
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine;
|
|
4400
|
+
}
|
|
4401
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Delete extends StandardParameters {
|
|
4402
|
+
/**
|
|
4403
|
+
* Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.
|
|
4404
|
+
*/
|
|
4405
|
+
name?: string;
|
|
4406
|
+
}
|
|
4407
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Get extends StandardParameters {
|
|
4408
|
+
/**
|
|
4409
|
+
* Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`.
|
|
4410
|
+
*/
|
|
4411
|
+
name?: string;
|
|
4412
|
+
}
|
|
4413
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$List extends StandardParameters {
|
|
4414
|
+
/**
|
|
4415
|
+
* Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH
|
|
4416
|
+
*/
|
|
4417
|
+
filter?: string;
|
|
4418
|
+
/**
|
|
4419
|
+
* Optional. Not supported.
|
|
4420
|
+
*/
|
|
4421
|
+
pageSize?: number;
|
|
4422
|
+
/**
|
|
4423
|
+
* Optional. Not supported.
|
|
4424
|
+
*/
|
|
4425
|
+
pageToken?: string;
|
|
4426
|
+
/**
|
|
4427
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`.
|
|
4428
|
+
*/
|
|
4429
|
+
parent?: string;
|
|
4430
|
+
}
|
|
4431
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Patch extends StandardParameters {
|
|
4432
|
+
/**
|
|
4433
|
+
* Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
4434
|
+
*/
|
|
4435
|
+
name?: string;
|
|
4436
|
+
/**
|
|
4437
|
+
* Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
4438
|
+
*/
|
|
4439
|
+
updateMask?: string;
|
|
4440
|
+
/**
|
|
4441
|
+
* Request body metadata
|
|
4442
|
+
*/
|
|
4443
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine;
|
|
4444
|
+
}
|
|
4445
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Pause extends StandardParameters {
|
|
4446
|
+
/**
|
|
4447
|
+
* Required. The name of the engine to pause. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`
|
|
4448
|
+
*/
|
|
4449
|
+
name?: string;
|
|
4450
|
+
/**
|
|
4451
|
+
* Request body metadata
|
|
4452
|
+
*/
|
|
4453
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPauseEngineRequest;
|
|
4454
|
+
}
|
|
4455
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Resume extends StandardParameters {
|
|
4456
|
+
/**
|
|
4457
|
+
* Required. The name of the engine to resume. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`
|
|
4458
|
+
*/
|
|
4459
|
+
name?: string;
|
|
4460
|
+
/**
|
|
4461
|
+
* Request body metadata
|
|
4462
|
+
*/
|
|
4463
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest;
|
|
4464
|
+
}
|
|
4465
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Tune extends StandardParameters {
|
|
4466
|
+
/**
|
|
4467
|
+
* Required. The resource name of the engine to tune. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`
|
|
4468
|
+
*/
|
|
4469
|
+
name?: string;
|
|
4470
|
+
/**
|
|
4471
|
+
* Request body metadata
|
|
4472
|
+
*/
|
|
4473
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineRequest;
|
|
3763
4474
|
}
|
|
3764
4475
|
export class Resource$Projects$Locations$Collections$Engines$Operations {
|
|
3765
4476
|
context: APIRequestContext;
|
|
@@ -3851,7 +4562,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3851
4562
|
}
|
|
3852
4563
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
|
|
3853
4564
|
/**
|
|
3854
|
-
* Required. Full resource name of
|
|
4565
|
+
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
|
|
3855
4566
|
*/
|
|
3856
4567
|
servingConfig?: string;
|
|
3857
4568
|
/**
|
|
@@ -3861,7 +4572,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3861
4572
|
}
|
|
3862
4573
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search extends StandardParameters {
|
|
3863
4574
|
/**
|
|
3864
|
-
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
4575
|
+
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
3865
4576
|
*/
|
|
3866
4577
|
servingConfig?: string;
|
|
3867
4578
|
/**
|
|
@@ -3950,6 +4661,76 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3950
4661
|
completeQuery(params: Params$Resource$Projects$Locations$Datastores$Completequery, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>): void;
|
|
3951
4662
|
completeQuery(params: Params$Resource$Projects$Locations$Datastores$Completequery, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>): void;
|
|
3952
4663
|
completeQuery(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>): void;
|
|
4664
|
+
/**
|
|
4665
|
+
* Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
|
|
4666
|
+
*
|
|
4667
|
+
* @param params - Parameters for request
|
|
4668
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4669
|
+
* @param callback - Optional callback that handles the response.
|
|
4670
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4671
|
+
*/
|
|
4672
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4673
|
+
create(params?: Params$Resource$Projects$Locations$Datastores$Create, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4674
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4675
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4676
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Create, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4677
|
+
create(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4678
|
+
/**
|
|
4679
|
+
* Deletes a DataStore.
|
|
4680
|
+
*
|
|
4681
|
+
* @param params - Parameters for request
|
|
4682
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4683
|
+
* @param callback - Optional callback that handles the response.
|
|
4684
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4685
|
+
*/
|
|
4686
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4687
|
+
delete(params?: Params$Resource$Projects$Locations$Datastores$Delete, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
|
|
4688
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4689
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4690
|
+
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4691
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
4692
|
+
/**
|
|
4693
|
+
* Gets a DataStore.
|
|
4694
|
+
*
|
|
4695
|
+
* @param params - Parameters for request
|
|
4696
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4697
|
+
* @param callback - Optional callback that handles the response.
|
|
4698
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4699
|
+
*/
|
|
4700
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4701
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>;
|
|
4702
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4703
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
4704
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
4705
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
4706
|
+
/**
|
|
4707
|
+
* Lists all the DataStores associated with the project.
|
|
4708
|
+
*
|
|
4709
|
+
* @param params - Parameters for request
|
|
4710
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4711
|
+
* @param callback - Optional callback that handles the response.
|
|
4712
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4713
|
+
*/
|
|
4714
|
+
list(params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4715
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>;
|
|
4716
|
+
list(params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4717
|
+
list(params: Params$Resource$Projects$Locations$Datastores$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>): void;
|
|
4718
|
+
list(params: Params$Resource$Projects$Locations$Datastores$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>): void;
|
|
4719
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListDataStoresResponse>): void;
|
|
4720
|
+
/**
|
|
4721
|
+
* Updates a DataStore
|
|
4722
|
+
*
|
|
4723
|
+
* @param params - Parameters for request
|
|
4724
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4725
|
+
* @param callback - Optional callback that handles the response.
|
|
4726
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4727
|
+
*/
|
|
4728
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
|
|
4729
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>;
|
|
4730
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
4731
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
4732
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
4733
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
3953
4734
|
}
|
|
3954
4735
|
export interface Params$Resource$Projects$Locations$Datastores$Completequery extends StandardParameters {
|
|
3955
4736
|
/**
|
|
@@ -3973,6 +4754,68 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
3973
4754
|
*/
|
|
3974
4755
|
userPseudoId?: string;
|
|
3975
4756
|
}
|
|
4757
|
+
export interface Params$Resource$Projects$Locations$Datastores$Create extends StandardParameters {
|
|
4758
|
+
/**
|
|
4759
|
+
* A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
|
|
4760
|
+
*/
|
|
4761
|
+
createAdvancedSiteSearch?: boolean;
|
|
4762
|
+
/**
|
|
4763
|
+
* Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
4764
|
+
*/
|
|
4765
|
+
dataStoreId?: string;
|
|
4766
|
+
/**
|
|
4767
|
+
* Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`.
|
|
4768
|
+
*/
|
|
4769
|
+
parent?: string;
|
|
4770
|
+
/**
|
|
4771
|
+
* Request body metadata
|
|
4772
|
+
*/
|
|
4773
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore;
|
|
4774
|
+
}
|
|
4775
|
+
export interface Params$Resource$Projects$Locations$Datastores$Delete extends StandardParameters {
|
|
4776
|
+
/**
|
|
4777
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.
|
|
4778
|
+
*/
|
|
4779
|
+
name?: string;
|
|
4780
|
+
}
|
|
4781
|
+
export interface Params$Resource$Projects$Locations$Datastores$Get extends StandardParameters {
|
|
4782
|
+
/**
|
|
4783
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.
|
|
4784
|
+
*/
|
|
4785
|
+
name?: string;
|
|
4786
|
+
}
|
|
4787
|
+
export interface Params$Resource$Projects$Locations$Datastores$List extends StandardParameters {
|
|
4788
|
+
/**
|
|
4789
|
+
* Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'
|
|
4790
|
+
*/
|
|
4791
|
+
filter?: string;
|
|
4792
|
+
/**
|
|
4793
|
+
* Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.
|
|
4794
|
+
*/
|
|
4795
|
+
pageSize?: number;
|
|
4796
|
+
/**
|
|
4797
|
+
* A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
4798
|
+
*/
|
|
4799
|
+
pageToken?: string;
|
|
4800
|
+
/**
|
|
4801
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStoress under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
|
|
4802
|
+
*/
|
|
4803
|
+
parent?: string;
|
|
4804
|
+
}
|
|
4805
|
+
export interface Params$Resource$Projects$Locations$Datastores$Patch extends StandardParameters {
|
|
4806
|
+
/**
|
|
4807
|
+
* Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
4808
|
+
*/
|
|
4809
|
+
name?: string;
|
|
4810
|
+
/**
|
|
4811
|
+
* Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
4812
|
+
*/
|
|
4813
|
+
updateMask?: string;
|
|
4814
|
+
/**
|
|
4815
|
+
* Request body metadata
|
|
4816
|
+
*/
|
|
4817
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore;
|
|
4818
|
+
}
|
|
3976
4819
|
export class Resource$Projects$Locations$Datastores$Branches {
|
|
3977
4820
|
context: APIRequestContext;
|
|
3978
4821
|
documents: Resource$Projects$Locations$Datastores$Branches$Documents;
|
|
@@ -4646,7 +5489,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4646
5489
|
}
|
|
4647
5490
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend extends StandardParameters {
|
|
4648
5491
|
/**
|
|
4649
|
-
* Required. Full resource name of
|
|
5492
|
+
* Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
|
|
4650
5493
|
*/
|
|
4651
5494
|
servingConfig?: string;
|
|
4652
5495
|
/**
|
|
@@ -4656,7 +5499,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4656
5499
|
}
|
|
4657
5500
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search extends StandardParameters {
|
|
4658
5501
|
/**
|
|
4659
|
-
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
5502
|
+
* Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
4660
5503
|
*/
|
|
4661
5504
|
servingConfig?: string;
|
|
4662
5505
|
/**
|