@googleapis/discoveryengine 6.0.0 → 7.0.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/v1alpha.ts CHANGED
@@ -241,6 +241,19 @@ export namespace discoveryengine_v1alpha {
241
241
  */
242
242
  functionName?: string | null;
243
243
  }
244
+ /**
245
+ * Access Control Configuration.
246
+ */
247
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAclConfig {
248
+ /**
249
+ * Identity provider config.
250
+ */
251
+ idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
252
+ /**
253
+ * 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.
254
+ */
255
+ name?: string | null;
256
+ }
244
257
  /**
245
258
  * AdditionalParams message for WidgetService methods for security and privacy enhancement.
246
259
  */
@@ -441,6 +454,10 @@ export namespace discoveryengine_v1alpha {
441
454
  * Request message for ConversationalSearchService.ConverseConversation method.
442
455
  */
443
456
  export interface Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest {
457
+ /**
458
+ * Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
459
+ */
460
+ boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
444
461
  /**
445
462
  * The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
446
463
  */
@@ -573,10 +590,23 @@ export namespace discoveryengine_v1alpha {
573
590
  */
574
591
  text?: string[] | null;
575
592
  }
593
+ /**
594
+ * Defines custom fine tuning spec.
595
+ */
596
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec {
597
+ /**
598
+ * Whether or not to enable and include custom fine tuned search adaptor model.
599
+ */
600
+ enableSearchAdaptor?: boolean | null;
601
+ }
576
602
  /**
577
603
  * DataStore captures global settings and configs at the DataStore level.
578
604
  */
579
605
  export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStore {
606
+ /**
607
+ * Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.
608
+ */
609
+ aclEnabled?: boolean | null;
580
610
  /**
581
611
  * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
582
612
  */
@@ -593,6 +623,14 @@ export namespace discoveryengine_v1alpha {
593
623
  * 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.
594
624
  */
595
625
  displayName?: string | null;
626
+ /**
627
+ * Configuration for Document understanding and enrichment.
628
+ */
629
+ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
630
+ /**
631
+ * Output only. Data store level identity provider config.
632
+ */
633
+ idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
596
634
  /**
597
635
  * Immutable. The industry vertical that the data store registers.
598
636
  */
@@ -605,6 +643,10 @@ export namespace discoveryengine_v1alpha {
605
643
  * 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.
606
644
  */
607
645
  solutionTypes?: string[] | null;
646
+ /**
647
+ * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore 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).
648
+ */
649
+ startingSchema?: Schema$GoogleCloudDiscoveryengineV1alphaSchema;
608
650
  }
609
651
  /**
610
652
  * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
@@ -687,6 +729,10 @@ export namespace discoveryengine_v1alpha {
687
729
  * Document captures all raw metadata information of items to be recommended or searched.
688
730
  */
689
731
  export interface Schema$GoogleCloudDiscoveryengineV1alphaDocument {
732
+ /**
733
+ * Access control information for the document.
734
+ */
735
+ aclInfo?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfo;
690
736
  /**
691
737
  * The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
692
738
  */
@@ -699,6 +745,10 @@ export namespace discoveryengine_v1alpha {
699
745
  * Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
700
746
  */
701
747
  id?: string | null;
748
+ /**
749
+ * Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.
750
+ */
751
+ indexTime?: string | null;
702
752
  /**
703
753
  * The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
704
754
  */
@@ -720,6 +770,21 @@ export namespace discoveryengine_v1alpha {
720
770
  */
721
771
  structData?: {[key: string]: any} | null;
722
772
  }
773
+ /**
774
+ * ACL Information of the Document.
775
+ */
776
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfo {
777
+ readers?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction[];
778
+ }
779
+ /**
780
+ * AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --\> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" \}, { "user_id": "user_1" \} ] \} ] \} \} Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" \}, { "group_id": "group_3" \}, { "user_id": "user_2" \} ], \}, { "principals": [ { "group_id": "group_1" \}, { "user_id": "user_1" \} ], \} ] \} \}
781
+ */
782
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction {
783
+ /**
784
+ * List of principals.
785
+ */
786
+ principals?: Schema$GoogleCloudDiscoveryengineV1alphaPrincipal[];
787
+ }
723
788
  /**
724
789
  * Unstructured data linked to this document.
725
790
  */
@@ -779,7 +844,7 @@ export namespace discoveryengine_v1alpha {
779
844
  */
780
845
  ocrConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOcrConfig;
781
846
  /**
782
- * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported.
847
+ * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
783
848
  */
784
849
  parsingConfigOverrides?: {
785
850
  [
@@ -813,6 +878,15 @@ export namespace discoveryengine_v1alpha {
813
878
  */
814
879
  values?: number[] | null;
815
880
  }
881
+ /**
882
+ * Defines embedding config, used for bring your own embeddings feature.
883
+ */
884
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig {
885
+ /**
886
+ * Full field path in the schema mapped as embedding field.
887
+ */
888
+ fieldPath?: string | null;
889
+ }
816
890
  /**
817
891
  * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
818
892
  */
@@ -838,6 +912,10 @@ export namespace discoveryengine_v1alpha {
838
912
  * Metadata that describes the training and serving parameters of an Engine.
839
913
  */
840
914
  export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine {
915
+ /**
916
+ * Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field.
917
+ */
918
+ allowMultipleDataStoresSearchEngine?: boolean | null;
841
919
  /**
842
920
  * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
843
921
  */
@@ -1164,6 +1242,45 @@ export namespace discoveryengine_v1alpha {
1164
1242
  */
1165
1243
  inputUris?: string[] | null;
1166
1244
  }
1245
+ /**
1246
+ * Defines guided search spec.
1247
+ */
1248
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec {
1249
+ /**
1250
+ * Whether or not to enable and include refinement attributes in gudied search result.
1251
+ */
1252
+ enableRefinementAttributes?: boolean | null;
1253
+ /**
1254
+ * Whether or not to enable and include related questions in search response.
1255
+ */
1256
+ enableRelatedQuestions?: boolean | null;
1257
+ /**
1258
+ * Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3.
1259
+ */
1260
+ maxRelatedQuestions?: number | null;
1261
+ }
1262
+ /**
1263
+ * Identity Provider Config.
1264
+ */
1265
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig {
1266
+ /**
1267
+ * External Identity provider config.
1268
+ */
1269
+ externalIdpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
1270
+ /**
1271
+ * Identity provider type configured.
1272
+ */
1273
+ idpType?: string | null;
1274
+ }
1275
+ /**
1276
+ * Third party IDP Config.
1277
+ */
1278
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig {
1279
+ /**
1280
+ * Workforce pool name. Example: "locations/global/workforcePools/pool_id"
1281
+ */
1282
+ workforcePoolName?: string | null;
1283
+ }
1167
1284
  /**
1168
1285
  * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
1169
1286
  */
@@ -1463,6 +1580,19 @@ export namespace discoveryengine_v1alpha {
1463
1580
  */
1464
1581
  schemas?: Schema$GoogleCloudDiscoveryengineV1alphaSchema[];
1465
1582
  }
1583
+ /**
1584
+ * Response for ListServingConfigs method.
1585
+ */
1586
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse {
1587
+ /**
1588
+ * Pagination token, if not returned indicates the last page.
1589
+ */
1590
+ nextPageToken?: string | null;
1591
+ /**
1592
+ * All the ServingConfigs for a given dataStore.
1593
+ */
1594
+ servingConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig[];
1595
+ }
1466
1596
  /**
1467
1597
  * Response message for SiteSearchEngineService.ListTargetSites method.
1468
1598
  */
@@ -1587,6 +1717,19 @@ export namespace discoveryengine_v1alpha {
1587
1717
  * Request for pausing training of an engine.
1588
1718
  */
1589
1719
  export interface Schema$GoogleCloudDiscoveryengineV1alphaPauseEngineRequest {}
1720
+ /**
1721
+ * Principal identifier of a user or a group.
1722
+ */
1723
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaPrincipal {
1724
+ /**
1725
+ * Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.
1726
+ */
1727
+ groupId?: string | null;
1728
+ /**
1729
+ * User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.
1730
+ */
1731
+ userId?: string | null;
1732
+ }
1590
1733
  /**
1591
1734
  * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
1592
1735
  */
@@ -1599,6 +1742,10 @@ export namespace discoveryengine_v1alpha {
1599
1742
  * Count of entries that encountered errors while processing.
1600
1743
  */
1601
1744
  failureCount?: string | null;
1745
+ /**
1746
+ * Count of entries that were ignored as entries were not found.
1747
+ */
1748
+ ignoredCount?: string | null;
1602
1749
  /**
1603
1750
  * Count of entries that were deleted successfully.
1604
1751
  */
@@ -1612,6 +1759,10 @@ export namespace discoveryengine_v1alpha {
1612
1759
  * Request message for DocumentService.PurgeDocuments method.
1613
1760
  */
1614
1761
  export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest {
1762
+ /**
1763
+ * The desired location of errors incurred during the purge.
1764
+ */
1765
+ errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig;
1615
1766
  /**
1616
1767
  * Required. Filter matching documents to purge. Only currently supported value is `*` (all items).
1617
1768
  */
@@ -1620,6 +1771,10 @@ export namespace discoveryengine_v1alpha {
1620
1771
  * Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.
1621
1772
  */
1622
1773
  force?: boolean | null;
1774
+ /**
1775
+ * Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line.
1776
+ */
1777
+ gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource;
1623
1778
  }
1624
1779
  /**
1625
1780
  * Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
@@ -1634,6 +1789,15 @@ export namespace discoveryengine_v1alpha {
1634
1789
  */
1635
1790
  purgeSample?: string[] | null;
1636
1791
  }
1792
+ /**
1793
+ * Configuration of destination for Purge related errors.
1794
+ */
1795
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig {
1796
+ /**
1797
+ * Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
1798
+ */
1799
+ gcsPrefix?: string | null;
1800
+ }
1637
1801
  /**
1638
1802
  * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
1639
1803
  */
@@ -1955,6 +2119,10 @@ export namespace discoveryengine_v1alpha {
1955
2119
  * A specification for configuring the behavior of content search.
1956
2120
  */
1957
2121
  contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
2122
+ /**
2123
+ * Custom fine tuning configs.
2124
+ */
2125
+ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
1958
2126
  /**
1959
2127
  * Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
1960
2128
  */
@@ -2046,7 +2214,7 @@ export namespace discoveryengine_v1alpha {
2046
2214
  */
2047
2215
  boost?: number | null;
2048
2216
  /**
2049
- * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
2217
+ * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))
2050
2218
  */
2051
2219
  condition?: string | null;
2052
2220
  }
@@ -2434,6 +2602,9 @@ export namespace discoveryengine_v1alpha {
2434
2602
  * The summary content.
2435
2603
  */
2436
2604
  summaryText?: string | null;
2605
+ /**
2606
+ * Summary with metadata information.
2607
+ */
2437
2608
  summaryWithMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata;
2438
2609
  }
2439
2610
  /**
@@ -2518,6 +2689,129 @@ export namespace discoveryengine_v1alpha {
2518
2689
  */
2519
2690
  summary?: string | null;
2520
2691
  }
2692
+ /**
2693
+ * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.
2694
+ */
2695
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfig {
2696
+ /**
2697
+ * Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.
2698
+ */
2699
+ boostControlIds?: string[] | null;
2700
+ /**
2701
+ * Output only. ServingConfig created timestamp.
2702
+ */
2703
+ createTime?: string | null;
2704
+ /**
2705
+ * Custom fine tuning configs.
2706
+ */
2707
+ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
2708
+ /**
2709
+ * Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
2710
+ */
2711
+ displayName?: string | null;
2712
+ /**
2713
+ * Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
2714
+ */
2715
+ dissociateControlIds?: string[] | null;
2716
+ /**
2717
+ * How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
2718
+ */
2719
+ diversityLevel?: string | null;
2720
+ /**
2721
+ * Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config.
2722
+ */
2723
+ embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig;
2724
+ /**
2725
+ * Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.
2726
+ */
2727
+ filterControlIds?: string[] | null;
2728
+ /**
2729
+ * The GenericConfig of the serving configuration.
2730
+ */
2731
+ genericConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig;
2732
+ /**
2733
+ * Guided search configs.
2734
+ */
2735
+ guidedSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec;
2736
+ /**
2737
+ * Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.
2738
+ */
2739
+ ignoreControlIds?: string[] | null;
2740
+ /**
2741
+ * The MediaConfig of the serving configuration.
2742
+ */
2743
+ mediaConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig;
2744
+ /**
2745
+ * The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.
2746
+ */
2747
+ modelId?: string | null;
2748
+ /**
2749
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
2750
+ */
2751
+ name?: string | null;
2752
+ /**
2753
+ * Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
2754
+ */
2755
+ onewaySynonymsControlIds?: string[] | null;
2756
+ /**
2757
+ * The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
2758
+ */
2759
+ rankingExpression?: string | null;
2760
+ /**
2761
+ * IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
2762
+ */
2763
+ redirectControlIds?: string[] | null;
2764
+ /**
2765
+ * Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
2766
+ */
2767
+ replacementControlIds?: string[] | null;
2768
+ /**
2769
+ * Required. Immutable. Specifies the solution type that a serving config can be associated with.
2770
+ */
2771
+ solutionType?: string | null;
2772
+ /**
2773
+ * Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
2774
+ */
2775
+ synonymsControlIds?: string[] | null;
2776
+ /**
2777
+ * Output only. ServingConfig updated timestamp.
2778
+ */
2779
+ updateTime?: string | null;
2780
+ }
2781
+ /**
2782
+ * Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.
2783
+ */
2784
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig {
2785
+ /**
2786
+ * Specifies the expected behavior of content search. Only valid for content-search enabled data store.
2787
+ */
2788
+ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
2789
+ }
2790
+ /**
2791
+ * Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
2792
+ */
2793
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig {
2794
+ /**
2795
+ * Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
2796
+ */
2797
+ contentFreshnessCutoffDays?: number | null;
2798
+ /**
2799
+ * Specifies the content watched minutes threshold for demotion.
2800
+ */
2801
+ contentWatchedMinutesThreshold?: number | null;
2802
+ /**
2803
+ * Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
2804
+ */
2805
+ contentWatchedPercentageThreshold?: number | null;
2806
+ /**
2807
+ * Specifies the content watched minutes threshold for demotion.
2808
+ */
2809
+ contentWatchedSecondsThreshold?: number | null;
2810
+ /**
2811
+ * Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.
2812
+ */
2813
+ demotionEventType?: string | null;
2814
+ }
2521
2815
  /**
2522
2816
  * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
2523
2817
  */
@@ -2603,6 +2897,9 @@ export namespace discoveryengine_v1alpha {
2603
2897
  */
2604
2898
  quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
2605
2899
  }
2900
+ /**
2901
+ * Failed due to insufficient quota.
2902
+ */
2606
2903
  export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
2607
2904
  /**
2608
2905
  * This number is an estimation on how much total quota this project needs to successfully complete indexing.
@@ -2953,6 +3250,10 @@ export namespace discoveryengine_v1alpha {
2953
3250
  * Turn on or off summarization for the search response.
2954
3251
  */
2955
3252
  enableSummarization?: boolean | null;
3253
+ /**
3254
+ * Whether to enable standalone web app.
3255
+ */
3256
+ enableWebApp?: boolean | null;
2956
3257
  /**
2957
3258
  * The configuration and appearance of facets in the end user view.
2958
3259
  */
@@ -3208,6 +3509,10 @@ export namespace discoveryengine_v1alpha {
3208
3509
  * 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.
3209
3510
  */
3210
3511
  displayName?: string | null;
3512
+ /**
3513
+ * Configuration for Document understanding and enrichment.
3514
+ */
3515
+ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
3211
3516
  /**
3212
3517
  * Immutable. The industry vertical that the data store registers.
3213
3518
  */
@@ -3220,6 +3525,10 @@ export namespace discoveryengine_v1alpha {
3220
3525
  * 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.
3221
3526
  */
3222
3527
  solutionTypes?: string[] | null;
3528
+ /**
3529
+ * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore 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).
3530
+ */
3531
+ startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema;
3223
3532
  }
3224
3533
  /**
3225
3534
  * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
@@ -3273,6 +3582,10 @@ export namespace discoveryengine_v1alpha {
3273
3582
  */
3274
3583
  updateTime?: string | null;
3275
3584
  }
3585
+ /**
3586
+ * The digital parsing configurations for documents.
3587
+ */
3588
+ export interface Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {}
3276
3589
  /**
3277
3590
  * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
3278
3591
  */
@@ -3290,6 +3603,40 @@ export namespace discoveryengine_v1alpha {
3290
3603
  * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
3291
3604
  */
3292
3605
  export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
3606
+ /**
3607
+ * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.
3608
+ */
3609
+ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig {
3610
+ /**
3611
+ * Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.
3612
+ */
3613
+ defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
3614
+ /**
3615
+ * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
3616
+ */
3617
+ name?: string | null;
3618
+ /**
3619
+ * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
3620
+ */
3621
+ parsingConfigOverrides?: {
3622
+ [
3623
+ key: string
3624
+ ]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
3625
+ } | null;
3626
+ }
3627
+ /**
3628
+ * Related configurations applied to a specific type of document parser.
3629
+ */
3630
+ export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig {
3631
+ /**
3632
+ * Configurations applied to digital parser.
3633
+ */
3634
+ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDigitalParsingConfig;
3635
+ /**
3636
+ * Configurations applied to OCR parser. Currently it only applies to PDFs.
3637
+ */
3638
+ ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig;
3639
+ }
3293
3640
  /**
3294
3641
  * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
3295
3642
  */
@@ -3536,6 +3883,19 @@ export namespace discoveryengine_v1alpha {
3536
3883
  */
3537
3884
  unjoinedEventsCount?: string | null;
3538
3885
  }
3886
+ /**
3887
+ * The OCR parsing configurations for documents.
3888
+ */
3889
+ export interface Schema$GoogleCloudDiscoveryengineV1betaOcrParsingConfig {
3890
+ /**
3891
+ * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
3892
+ */
3893
+ enhancedDocumentElements?: string[] | null;
3894
+ /**
3895
+ * If true, will use native text instead of OCR text on pages containing native text.
3896
+ */
3897
+ useNativeText?: boolean | null;
3898
+ }
3539
3899
  /**
3540
3900
  * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
3541
3901
  */
@@ -3548,6 +3908,10 @@ export namespace discoveryengine_v1alpha {
3548
3908
  * Count of entries that encountered errors while processing.
3549
3909
  */
3550
3910
  failureCount?: string | null;
3911
+ /**
3912
+ * Count of entries that were ignored as entries were not found.
3913
+ */
3914
+ ignoredCount?: string | null;
3551
3915
  /**
3552
3916
  * Count of entries that were deleted successfully.
3553
3917
  */
@@ -3676,6 +4040,9 @@ export namespace discoveryengine_v1alpha {
3676
4040
  */
3677
4041
  quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
3678
4042
  }
4043
+ /**
4044
+ * Failed due to insufficient quota.
4045
+ */
3679
4046
  export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
3680
4047
  /**
3681
4048
  * This number is an estimation on how much total quota this project needs to successfully complete indexing.
@@ -3780,6 +4147,10 @@ export namespace discoveryengine_v1alpha {
3780
4147
  * 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.
3781
4148
  */
3782
4149
  displayName?: string | null;
4150
+ /**
4151
+ * Configuration for Document understanding and enrichment.
4152
+ */
4153
+ documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
3783
4154
  /**
3784
4155
  * Immutable. The industry vertical that the data store registers.
3785
4156
  */
@@ -3792,6 +4163,10 @@ export namespace discoveryengine_v1alpha {
3792
4163
  * 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.
3793
4164
  */
3794
4165
  solutionTypes?: string[] | null;
4166
+ /**
4167
+ * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore 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).
4168
+ */
4169
+ startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema;
3795
4170
  }
3796
4171
  /**
3797
4172
  * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
@@ -3845,6 +4220,10 @@ export namespace discoveryengine_v1alpha {
3845
4220
  */
3846
4221
  updateTime?: string | null;
3847
4222
  }
4223
+ /**
4224
+ * The digital parsing configurations for documents.
4225
+ */
4226
+ export interface Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig {}
3848
4227
  /**
3849
4228
  * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
3850
4229
  */
@@ -3863,30 +4242,64 @@ export namespace discoveryengine_v1alpha {
3863
4242
  */
3864
4243
  export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
3865
4244
  /**
3866
- * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
4245
+ * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.
3867
4246
  */
3868
- export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
4247
+ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig {
3869
4248
  /**
3870
- * Operation create time.
4249
+ * Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.
3871
4250
  */
3872
- createTime?: string | null;
4251
+ defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
3873
4252
  /**
3874
- * Operation last update time. If the operation is done, this is also the finish time.
4253
+ * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
3875
4254
  */
3876
- updateTime?: string | null;
4255
+ name?: string | null;
4256
+ /**
4257
+ * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
4258
+ */
4259
+ parsingConfigOverrides?: {
4260
+ [
4261
+ key: string
4262
+ ]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
4263
+ } | null;
3877
4264
  }
3878
4265
  /**
3879
- * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
3880
- */
3881
- export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {}
3882
- /**
3883
- * Metadata that describes the training and serving parameters of an Engine.
4266
+ * Related configurations applied to a specific type of document parser.
3884
4267
  */
3885
- export interface Schema$GoogleCloudDiscoveryengineV1Engine {
4268
+ export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig {
3886
4269
  /**
3887
- * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
4270
+ * Configurations applied to digital parser.
3888
4271
  */
3889
- chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig;
4272
+ digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DigitalParsingConfig;
4273
+ /**
4274
+ * Configurations applied to OCR parser. Currently it only applies to PDFs.
4275
+ */
4276
+ ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig;
4277
+ }
4278
+ /**
4279
+ * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
4280
+ */
4281
+ export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
4282
+ /**
4283
+ * Operation create time.
4284
+ */
4285
+ createTime?: string | null;
4286
+ /**
4287
+ * Operation last update time. If the operation is done, this is also the finish time.
4288
+ */
4289
+ updateTime?: string | null;
4290
+ }
4291
+ /**
4292
+ * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
4293
+ */
4294
+ export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {}
4295
+ /**
4296
+ * Metadata that describes the training and serving parameters of an Engine.
4297
+ */
4298
+ export interface Schema$GoogleCloudDiscoveryengineV1Engine {
4299
+ /**
4300
+ * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
4301
+ */
4302
+ chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig;
3890
4303
  /**
3891
4304
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
3892
4305
  */
@@ -4108,6 +4521,19 @@ export namespace discoveryengine_v1alpha {
4108
4521
  */
4109
4522
  unjoinedEventsCount?: string | null;
4110
4523
  }
4524
+ /**
4525
+ * The OCR parsing configurations for documents.
4526
+ */
4527
+ export interface Schema$GoogleCloudDiscoveryengineV1OcrParsingConfig {
4528
+ /**
4529
+ * Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
4530
+ */
4531
+ enhancedDocumentElements?: string[] | null;
4532
+ /**
4533
+ * If true, will use native text instead of OCR text on pages containing native text.
4534
+ */
4535
+ useNativeText?: boolean | null;
4536
+ }
4111
4537
  /**
4112
4538
  * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
4113
4539
  */
@@ -4120,6 +4546,10 @@ export namespace discoveryengine_v1alpha {
4120
4546
  * Count of entries that encountered errors while processing.
4121
4547
  */
4122
4548
  failureCount?: string | null;
4549
+ /**
4550
+ * Count of entries that were ignored as entries were not found.
4551
+ */
4552
+ ignoredCount?: string | null;
4123
4553
  /**
4124
4554
  * Count of entries that were deleted successfully.
4125
4555
  */
@@ -4248,6 +4678,9 @@ export namespace discoveryengine_v1alpha {
4248
4678
  */
4249
4679
  quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
4250
4680
  }
4681
+ /**
4682
+ * Failed due to insufficient quota.
4683
+ */
4251
4684
  export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
4252
4685
  /**
4253
4686
  * This number is an estimation on how much total quota this project needs to successfully complete indexing.
@@ -4923,6 +5356,194 @@ export namespace discoveryengine_v1alpha {
4923
5356
  return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
4924
5357
  }
4925
5358
  }
5359
+
5360
+ /**
5361
+ * Gets the AclConfig.
5362
+ *
5363
+ * @param params - Parameters for request
5364
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5365
+ * @param callback - Optional callback that handles the response.
5366
+ * @returns A promise if used with async/await, or void if used with a callback.
5367
+ */
5368
+ getAclConfig(
5369
+ params: Params$Resource$Projects$Locations$Getaclconfig,
5370
+ options: StreamMethodOptions
5371
+ ): GaxiosPromise<Readable>;
5372
+ getAclConfig(
5373
+ params?: Params$Resource$Projects$Locations$Getaclconfig,
5374
+ options?: MethodOptions
5375
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>;
5376
+ getAclConfig(
5377
+ params: Params$Resource$Projects$Locations$Getaclconfig,
5378
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
5379
+ callback: BodyResponseCallback<Readable>
5380
+ ): void;
5381
+ getAclConfig(
5382
+ params: Params$Resource$Projects$Locations$Getaclconfig,
5383
+ options:
5384
+ | MethodOptions
5385
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>,
5386
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5387
+ ): void;
5388
+ getAclConfig(
5389
+ params: Params$Resource$Projects$Locations$Getaclconfig,
5390
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5391
+ ): void;
5392
+ getAclConfig(
5393
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5394
+ ): void;
5395
+ getAclConfig(
5396
+ paramsOrCallback?:
5397
+ | Params$Resource$Projects$Locations$Getaclconfig
5398
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5399
+ | BodyResponseCallback<Readable>,
5400
+ optionsOrCallback?:
5401
+ | MethodOptions
5402
+ | StreamMethodOptions
5403
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5404
+ | BodyResponseCallback<Readable>,
5405
+ callback?:
5406
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5407
+ | BodyResponseCallback<Readable>
5408
+ ):
5409
+ | void
5410
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5411
+ | GaxiosPromise<Readable> {
5412
+ let params = (paramsOrCallback ||
5413
+ {}) as Params$Resource$Projects$Locations$Getaclconfig;
5414
+ let options = (optionsOrCallback || {}) as MethodOptions;
5415
+
5416
+ if (typeof paramsOrCallback === 'function') {
5417
+ callback = paramsOrCallback;
5418
+ params = {} as Params$Resource$Projects$Locations$Getaclconfig;
5419
+ options = {};
5420
+ }
5421
+
5422
+ if (typeof optionsOrCallback === 'function') {
5423
+ callback = optionsOrCallback;
5424
+ options = {};
5425
+ }
5426
+
5427
+ const rootUrl =
5428
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
5429
+ const parameters = {
5430
+ options: Object.assign(
5431
+ {
5432
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
5433
+ method: 'GET',
5434
+ },
5435
+ options
5436
+ ),
5437
+ params,
5438
+ requiredParams: ['name'],
5439
+ pathParams: ['name'],
5440
+ context: this.context,
5441
+ };
5442
+ if (callback) {
5443
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>(
5444
+ parameters,
5445
+ callback as BodyResponseCallback<unknown>
5446
+ );
5447
+ } else {
5448
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>(
5449
+ parameters
5450
+ );
5451
+ }
5452
+ }
5453
+
5454
+ /**
5455
+ * 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.
5456
+ *
5457
+ * @param params - Parameters for request
5458
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5459
+ * @param callback - Optional callback that handles the response.
5460
+ * @returns A promise if used with async/await, or void if used with a callback.
5461
+ */
5462
+ updateAclConfig(
5463
+ params: Params$Resource$Projects$Locations$Updateaclconfig,
5464
+ options: StreamMethodOptions
5465
+ ): GaxiosPromise<Readable>;
5466
+ updateAclConfig(
5467
+ params?: Params$Resource$Projects$Locations$Updateaclconfig,
5468
+ options?: MethodOptions
5469
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>;
5470
+ updateAclConfig(
5471
+ params: Params$Resource$Projects$Locations$Updateaclconfig,
5472
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
5473
+ callback: BodyResponseCallback<Readable>
5474
+ ): void;
5475
+ updateAclConfig(
5476
+ params: Params$Resource$Projects$Locations$Updateaclconfig,
5477
+ options:
5478
+ | MethodOptions
5479
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>,
5480
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5481
+ ): void;
5482
+ updateAclConfig(
5483
+ params: Params$Resource$Projects$Locations$Updateaclconfig,
5484
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5485
+ ): void;
5486
+ updateAclConfig(
5487
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5488
+ ): void;
5489
+ updateAclConfig(
5490
+ paramsOrCallback?:
5491
+ | Params$Resource$Projects$Locations$Updateaclconfig
5492
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5493
+ | BodyResponseCallback<Readable>,
5494
+ optionsOrCallback?:
5495
+ | MethodOptions
5496
+ | StreamMethodOptions
5497
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5498
+ | BodyResponseCallback<Readable>,
5499
+ callback?:
5500
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5501
+ | BodyResponseCallback<Readable>
5502
+ ):
5503
+ | void
5504
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>
5505
+ | GaxiosPromise<Readable> {
5506
+ let params = (paramsOrCallback ||
5507
+ {}) as Params$Resource$Projects$Locations$Updateaclconfig;
5508
+ let options = (optionsOrCallback || {}) as MethodOptions;
5509
+
5510
+ if (typeof paramsOrCallback === 'function') {
5511
+ callback = paramsOrCallback;
5512
+ params = {} as Params$Resource$Projects$Locations$Updateaclconfig;
5513
+ options = {};
5514
+ }
5515
+
5516
+ if (typeof optionsOrCallback === 'function') {
5517
+ callback = optionsOrCallback;
5518
+ options = {};
5519
+ }
5520
+
5521
+ const rootUrl =
5522
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
5523
+ const parameters = {
5524
+ options: Object.assign(
5525
+ {
5526
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
5527
+ method: 'PATCH',
5528
+ },
5529
+ options
5530
+ ),
5531
+ params,
5532
+ requiredParams: ['name'],
5533
+ pathParams: ['name'],
5534
+ context: this.context,
5535
+ };
5536
+ if (callback) {
5537
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>(
5538
+ parameters,
5539
+ callback as BodyResponseCallback<unknown>
5540
+ );
5541
+ } else {
5542
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAclConfig>(
5543
+ parameters
5544
+ );
5545
+ }
5546
+ }
4926
5547
  }
4927
5548
 
4928
5549
  export interface Params$Resource$Projects$Locations$Estimatedatasize
@@ -4937,6 +5558,25 @@ export namespace discoveryengine_v1alpha {
4937
5558
  */
4938
5559
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest;
4939
5560
  }
5561
+ export interface Params$Resource$Projects$Locations$Getaclconfig
5562
+ extends StandardParameters {
5563
+ /**
5564
+ * 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.
5565
+ */
5566
+ name?: string;
5567
+ }
5568
+ export interface Params$Resource$Projects$Locations$Updateaclconfig
5569
+ extends StandardParameters {
5570
+ /**
5571
+ * 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.
5572
+ */
5573
+ name?: string;
5574
+
5575
+ /**
5576
+ * Request body metadata
5577
+ */
5578
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAclConfig;
5579
+ }
4940
5580
 
4941
5581
  export class Resource$Projects$Locations$Collections {
4942
5582
  context: APIRequestContext;
@@ -7098,6 +7738,10 @@ export namespace discoveryengine_v1alpha {
7098
7738
  * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
7099
7739
  */
7100
7740
  name?: string;
7741
+ /**
7742
+ * Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
7743
+ */
7744
+ updateMask?: string;
7101
7745
 
7102
7746
  /**
7103
7747
  * Request body metadata
@@ -9243,65 +9887,65 @@ export namespace discoveryengine_v1alpha {
9243
9887
  }
9244
9888
 
9245
9889
  /**
9246
- * Makes a recommendation, which requires a contextual user event.
9890
+ * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
9247
9891
  *
9248
9892
  * @param params - Parameters for request
9249
9893
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9250
9894
  * @param callback - Optional callback that handles the response.
9251
9895
  * @returns A promise if used with async/await, or void if used with a callback.
9252
9896
  */
9253
- recommend(
9254
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9897
+ get(
9898
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
9255
9899
  options: StreamMethodOptions
9256
9900
  ): GaxiosPromise<Readable>;
9257
- recommend(
9258
- params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9901
+ get(
9902
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
9259
9903
  options?: MethodOptions
9260
- ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
9261
- recommend(
9262
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9904
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
9905
+ get(
9906
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
9263
9907
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
9264
9908
  callback: BodyResponseCallback<Readable>
9265
9909
  ): void;
9266
- recommend(
9267
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9910
+ get(
9911
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
9268
9912
  options:
9269
9913
  | MethodOptions
9270
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>,
9271
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9914
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
9915
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9272
9916
  ): void;
9273
- recommend(
9274
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9275
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9917
+ get(
9918
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
9919
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9276
9920
  ): void;
9277
- recommend(
9278
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9921
+ get(
9922
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9279
9923
  ): void;
9280
- recommend(
9924
+ get(
9281
9925
  paramsOrCallback?:
9282
- | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
9283
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9926
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get
9927
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9284
9928
  | BodyResponseCallback<Readable>,
9285
9929
  optionsOrCallback?:
9286
9930
  | MethodOptions
9287
9931
  | StreamMethodOptions
9288
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9932
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9289
9933
  | BodyResponseCallback<Readable>,
9290
9934
  callback?:
9291
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9935
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9292
9936
  | BodyResponseCallback<Readable>
9293
9937
  ):
9294
9938
  | void
9295
- | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9939
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9296
9940
  | GaxiosPromise<Readable> {
9297
9941
  let params = (paramsOrCallback ||
9298
- {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend;
9942
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get;
9299
9943
  let options = (optionsOrCallback || {}) as MethodOptions;
9300
9944
 
9301
9945
  if (typeof paramsOrCallback === 'function') {
9302
9946
  callback = paramsOrCallback;
9303
9947
  params =
9304
- {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend;
9948
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get;
9305
9949
  options = {};
9306
9950
  }
9307
9951
 
@@ -9315,91 +9959,88 @@ export namespace discoveryengine_v1alpha {
9315
9959
  const parameters = {
9316
9960
  options: Object.assign(
9317
9961
  {
9318
- url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace(
9319
- /([^:]\/)\/+/g,
9320
- '$1'
9321
- ),
9322
- method: 'POST',
9962
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
9963
+ method: 'GET',
9323
9964
  },
9324
9965
  options
9325
9966
  ),
9326
9967
  params,
9327
- requiredParams: ['servingConfig'],
9328
- pathParams: ['servingConfig'],
9968
+ requiredParams: ['name'],
9969
+ pathParams: ['name'],
9329
9970
  context: this.context,
9330
9971
  };
9331
9972
  if (callback) {
9332
- createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>(
9973
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
9333
9974
  parameters,
9334
9975
  callback as BodyResponseCallback<unknown>
9335
9976
  );
9336
9977
  } else {
9337
- return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>(
9978
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
9338
9979
  parameters
9339
9980
  );
9340
9981
  }
9341
9982
  }
9342
9983
 
9343
9984
  /**
9344
- * Performs a search.
9985
+ * Lists all ServingConfigs linked to this dataStore.
9345
9986
  *
9346
9987
  * @param params - Parameters for request
9347
9988
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9348
9989
  * @param callback - Optional callback that handles the response.
9349
9990
  * @returns A promise if used with async/await, or void if used with a callback.
9350
9991
  */
9351
- search(
9352
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9992
+ list(
9993
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
9353
9994
  options: StreamMethodOptions
9354
9995
  ): GaxiosPromise<Readable>;
9355
- search(
9356
- params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9996
+ list(
9997
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
9357
9998
  options?: MethodOptions
9358
- ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>;
9359
- search(
9360
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9999
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
10000
+ list(
10001
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
9361
10002
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
9362
10003
  callback: BodyResponseCallback<Readable>
9363
10004
  ): void;
9364
- search(
9365
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
10005
+ list(
10006
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
9366
10007
  options:
9367
10008
  | MethodOptions
9368
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>,
9369
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
10009
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>,
10010
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9370
10011
  ): void;
9371
- search(
9372
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9373
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
10012
+ list(
10013
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
10014
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9374
10015
  ): void;
9375
- search(
9376
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
10016
+ list(
10017
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9377
10018
  ): void;
9378
- search(
10019
+ list(
9379
10020
  paramsOrCallback?:
9380
- | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search
9381
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
10021
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List
10022
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9382
10023
  | BodyResponseCallback<Readable>,
9383
10024
  optionsOrCallback?:
9384
10025
  | MethodOptions
9385
10026
  | StreamMethodOptions
9386
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
10027
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9387
10028
  | BodyResponseCallback<Readable>,
9388
10029
  callback?:
9389
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
10030
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9390
10031
  | BodyResponseCallback<Readable>
9391
10032
  ):
9392
10033
  | void
9393
- | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
10034
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9394
10035
  | GaxiosPromise<Readable> {
9395
10036
  let params = (paramsOrCallback ||
9396
- {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search;
10037
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List;
9397
10038
  let options = (optionsOrCallback || {}) as MethodOptions;
9398
10039
 
9399
10040
  if (typeof paramsOrCallback === 'function') {
9400
10041
  callback = paramsOrCallback;
9401
10042
  params =
9402
- {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search;
10043
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List;
9403
10044
  options = {};
9404
10045
  }
9405
10046
 
@@ -9413,133 +10054,91 @@ export namespace discoveryengine_v1alpha {
9413
10054
  const parameters = {
9414
10055
  options: Object.assign(
9415
10056
  {
9416
- url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace(
10057
+ url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace(
9417
10058
  /([^:]\/)\/+/g,
9418
10059
  '$1'
9419
10060
  ),
9420
- method: 'POST',
10061
+ method: 'GET',
9421
10062
  },
9422
10063
  options
9423
10064
  ),
9424
10065
  params,
9425
- requiredParams: ['servingConfig'],
9426
- pathParams: ['servingConfig'],
10066
+ requiredParams: ['parent'],
10067
+ pathParams: ['parent'],
9427
10068
  context: this.context,
9428
10069
  };
9429
10070
  if (callback) {
9430
- createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>(
10071
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
9431
10072
  parameters,
9432
10073
  callback as BodyResponseCallback<unknown>
9433
10074
  );
9434
10075
  } else {
9435
- return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>(
10076
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
9436
10077
  parameters
9437
10078
  );
9438
10079
  }
9439
10080
  }
9440
- }
9441
-
9442
- export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
9443
- extends StandardParameters {
9444
- /**
9445
- * 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 RecommendationService.Recommend requests.
9446
- */
9447
- servingConfig?: string;
9448
-
9449
- /**
9450
- * Request body metadata
9451
- */
9452
- requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest;
9453
- }
9454
- export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search
9455
- extends StandardParameters {
9456
- /**
9457
- * 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.
9458
- */
9459
- servingConfig?: string;
9460
-
9461
- /**
9462
- * Request body metadata
9463
- */
9464
- requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
9465
- }
9466
-
9467
- export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine {
9468
- context: APIRequestContext;
9469
- operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations;
9470
- targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites;
9471
- constructor(context: APIRequestContext) {
9472
- this.context = context;
9473
- this.operations =
9474
- new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations(
9475
- this.context
9476
- );
9477
- this.targetSites =
9478
- new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites(
9479
- this.context
9480
- );
9481
- }
9482
10081
 
9483
10082
  /**
9484
- * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
10083
+ * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
9485
10084
  *
9486
10085
  * @param params - Parameters for request
9487
10086
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9488
10087
  * @param callback - Optional callback that handles the response.
9489
10088
  * @returns A promise if used with async/await, or void if used with a callback.
9490
10089
  */
9491
- batchVerifyTargetSites(
9492
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
10090
+ patch(
10091
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
9493
10092
  options: StreamMethodOptions
9494
10093
  ): GaxiosPromise<Readable>;
9495
- batchVerifyTargetSites(
9496
- params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
10094
+ patch(
10095
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
9497
10096
  options?: MethodOptions
9498
- ): GaxiosPromise<Schema$GoogleLongrunningOperation>;
9499
- batchVerifyTargetSites(
9500
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
10097
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
10098
+ patch(
10099
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
9501
10100
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
9502
10101
  callback: BodyResponseCallback<Readable>
9503
10102
  ): void;
9504
- batchVerifyTargetSites(
9505
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
10103
+ patch(
10104
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
9506
10105
  options:
9507
10106
  | MethodOptions
9508
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
9509
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10107
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
10108
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9510
10109
  ): void;
9511
- batchVerifyTargetSites(
9512
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
9513
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10110
+ patch(
10111
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
10112
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9514
10113
  ): void;
9515
- batchVerifyTargetSites(
9516
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10114
+ patch(
10115
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9517
10116
  ): void;
9518
- batchVerifyTargetSites(
10117
+ patch(
9519
10118
  paramsOrCallback?:
9520
- | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites
9521
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10119
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch
10120
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9522
10121
  | BodyResponseCallback<Readable>,
9523
10122
  optionsOrCallback?:
9524
10123
  | MethodOptions
9525
10124
  | StreamMethodOptions
9526
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10125
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9527
10126
  | BodyResponseCallback<Readable>,
9528
10127
  callback?:
9529
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10128
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9530
10129
  | BodyResponseCallback<Readable>
9531
10130
  ):
9532
10131
  | void
9533
- | GaxiosPromise<Schema$GoogleLongrunningOperation>
10132
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9534
10133
  | GaxiosPromise<Readable> {
9535
10134
  let params = (paramsOrCallback ||
9536
- {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites;
10135
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch;
9537
10136
  let options = (optionsOrCallback || {}) as MethodOptions;
9538
10137
 
9539
10138
  if (typeof paramsOrCallback === 'function') {
9540
10139
  callback = paramsOrCallback;
9541
10140
  params =
9542
- {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites;
10141
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch;
9543
10142
  options = {};
9544
10143
  }
9545
10144
 
@@ -9553,88 +10152,88 @@ export namespace discoveryengine_v1alpha {
9553
10152
  const parameters = {
9554
10153
  options: Object.assign(
9555
10154
  {
9556
- url: (
9557
- rootUrl + '/v1alpha/{+parent}:batchVerifyTargetSites'
9558
- ).replace(/([^:]\/)\/+/g, '$1'),
9559
- method: 'POST',
10155
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
10156
+ method: 'PATCH',
9560
10157
  },
9561
10158
  options
9562
10159
  ),
9563
10160
  params,
9564
- requiredParams: ['parent'],
9565
- pathParams: ['parent'],
10161
+ requiredParams: ['name'],
10162
+ pathParams: ['name'],
9566
10163
  context: this.context,
9567
10164
  };
9568
10165
  if (callback) {
9569
- createAPIRequest<Schema$GoogleLongrunningOperation>(
10166
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
9570
10167
  parameters,
9571
10168
  callback as BodyResponseCallback<unknown>
9572
10169
  );
9573
10170
  } else {
9574
- return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
10171
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
10172
+ parameters
10173
+ );
9575
10174
  }
9576
10175
  }
9577
10176
 
9578
10177
  /**
9579
- * Downgrade from advanced site search to basic site search.
10178
+ * Makes a recommendation, which requires a contextual user event.
9580
10179
  *
9581
10180
  * @param params - Parameters for request
9582
10181
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9583
10182
  * @param callback - Optional callback that handles the response.
9584
10183
  * @returns A promise if used with async/await, or void if used with a callback.
9585
10184
  */
9586
- disableAdvancedSiteSearch(
9587
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch,
10185
+ recommend(
10186
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9588
10187
  options: StreamMethodOptions
9589
10188
  ): GaxiosPromise<Readable>;
9590
- disableAdvancedSiteSearch(
9591
- params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch,
10189
+ recommend(
10190
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9592
10191
  options?: MethodOptions
9593
- ): GaxiosPromise<Schema$GoogleLongrunningOperation>;
9594
- disableAdvancedSiteSearch(
9595
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch,
10192
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
10193
+ recommend(
10194
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9596
10195
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
9597
10196
  callback: BodyResponseCallback<Readable>
9598
10197
  ): void;
9599
- disableAdvancedSiteSearch(
9600
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch,
10198
+ recommend(
10199
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9601
10200
  options:
9602
10201
  | MethodOptions
9603
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
9604
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10202
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>,
10203
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9605
10204
  ): void;
9606
- disableAdvancedSiteSearch(
9607
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch,
9608
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10205
+ recommend(
10206
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
10207
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9609
10208
  ): void;
9610
- disableAdvancedSiteSearch(
9611
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10209
+ recommend(
10210
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9612
10211
  ): void;
9613
- disableAdvancedSiteSearch(
10212
+ recommend(
9614
10213
  paramsOrCallback?:
9615
- | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch
9616
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10214
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
10215
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9617
10216
  | BodyResponseCallback<Readable>,
9618
10217
  optionsOrCallback?:
9619
10218
  | MethodOptions
9620
10219
  | StreamMethodOptions
9621
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10220
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9622
10221
  | BodyResponseCallback<Readable>,
9623
10222
  callback?:
9624
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10223
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9625
10224
  | BodyResponseCallback<Readable>
9626
10225
  ):
9627
10226
  | void
9628
- | GaxiosPromise<Schema$GoogleLongrunningOperation>
10227
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9629
10228
  | GaxiosPromise<Readable> {
9630
10229
  let params = (paramsOrCallback ||
9631
- {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch;
10230
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend;
9632
10231
  let options = (optionsOrCallback || {}) as MethodOptions;
9633
10232
 
9634
10233
  if (typeof paramsOrCallback === 'function') {
9635
10234
  callback = paramsOrCallback;
9636
10235
  params =
9637
- {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch;
10236
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend;
9638
10237
  options = {};
9639
10238
  }
9640
10239
 
@@ -9648,88 +10247,91 @@ export namespace discoveryengine_v1alpha {
9648
10247
  const parameters = {
9649
10248
  options: Object.assign(
9650
10249
  {
9651
- url: (
9652
- rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch'
9653
- ).replace(/([^:]\/)\/+/g, '$1'),
10250
+ url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace(
10251
+ /([^:]\/)\/+/g,
10252
+ '$1'
10253
+ ),
9654
10254
  method: 'POST',
9655
10255
  },
9656
10256
  options
9657
10257
  ),
9658
10258
  params,
9659
- requiredParams: ['siteSearchEngine'],
9660
- pathParams: ['siteSearchEngine'],
10259
+ requiredParams: ['servingConfig'],
10260
+ pathParams: ['servingConfig'],
9661
10261
  context: this.context,
9662
10262
  };
9663
10263
  if (callback) {
9664
- createAPIRequest<Schema$GoogleLongrunningOperation>(
10264
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>(
9665
10265
  parameters,
9666
10266
  callback as BodyResponseCallback<unknown>
9667
10267
  );
9668
10268
  } else {
9669
- return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
10269
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>(
10270
+ parameters
10271
+ );
9670
10272
  }
9671
10273
  }
9672
10274
 
9673
10275
  /**
9674
- * Upgrade from basic site search to advanced site search.
10276
+ * Performs a search.
9675
10277
  *
9676
10278
  * @param params - Parameters for request
9677
10279
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9678
10280
  * @param callback - Optional callback that handles the response.
9679
10281
  * @returns A promise if used with async/await, or void if used with a callback.
9680
10282
  */
9681
- enableAdvancedSiteSearch(
9682
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch,
10283
+ search(
10284
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9683
10285
  options: StreamMethodOptions
9684
10286
  ): GaxiosPromise<Readable>;
9685
- enableAdvancedSiteSearch(
9686
- params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch,
10287
+ search(
10288
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9687
10289
  options?: MethodOptions
9688
- ): GaxiosPromise<Schema$GoogleLongrunningOperation>;
9689
- enableAdvancedSiteSearch(
9690
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch,
10290
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>;
10291
+ search(
10292
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9691
10293
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
9692
10294
  callback: BodyResponseCallback<Readable>
9693
10295
  ): void;
9694
- enableAdvancedSiteSearch(
9695
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch,
10296
+ search(
10297
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9696
10298
  options:
9697
10299
  | MethodOptions
9698
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
9699
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10300
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>,
10301
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9700
10302
  ): void;
9701
- enableAdvancedSiteSearch(
9702
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch,
9703
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10303
+ search(
10304
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
10305
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9704
10306
  ): void;
9705
- enableAdvancedSiteSearch(
9706
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10307
+ search(
10308
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9707
10309
  ): void;
9708
- enableAdvancedSiteSearch(
10310
+ search(
9709
10311
  paramsOrCallback?:
9710
- | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch
9711
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10312
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search
10313
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9712
10314
  | BodyResponseCallback<Readable>,
9713
10315
  optionsOrCallback?:
9714
10316
  | MethodOptions
9715
10317
  | StreamMethodOptions
9716
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10318
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9717
10319
  | BodyResponseCallback<Readable>,
9718
10320
  callback?:
9719
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10321
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9720
10322
  | BodyResponseCallback<Readable>
9721
10323
  ):
9722
10324
  | void
9723
- | GaxiosPromise<Schema$GoogleLongrunningOperation>
10325
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9724
10326
  | GaxiosPromise<Readable> {
9725
10327
  let params = (paramsOrCallback ||
9726
- {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch;
10328
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search;
9727
10329
  let options = (optionsOrCallback || {}) as MethodOptions;
9728
10330
 
9729
10331
  if (typeof paramsOrCallback === 'function') {
9730
10332
  callback = paramsOrCallback;
9731
10333
  params =
9732
- {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch;
10334
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search;
9733
10335
  options = {};
9734
10336
  }
9735
10337
 
@@ -9743,35 +10345,403 @@ export namespace discoveryengine_v1alpha {
9743
10345
  const parameters = {
9744
10346
  options: Object.assign(
9745
10347
  {
9746
- url: (
9747
- rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch'
9748
- ).replace(/([^:]\/)\/+/g, '$1'),
10348
+ url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace(
10349
+ /([^:]\/)\/+/g,
10350
+ '$1'
10351
+ ),
9749
10352
  method: 'POST',
9750
10353
  },
9751
10354
  options
9752
10355
  ),
9753
10356
  params,
9754
- requiredParams: ['siteSearchEngine'],
9755
- pathParams: ['siteSearchEngine'],
10357
+ requiredParams: ['servingConfig'],
10358
+ pathParams: ['servingConfig'],
9756
10359
  context: this.context,
9757
10360
  };
9758
10361
  if (callback) {
9759
- createAPIRequest<Schema$GoogleLongrunningOperation>(
10362
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>(
9760
10363
  parameters,
9761
10364
  callback as BodyResponseCallback<unknown>
9762
10365
  );
9763
10366
  } else {
9764
- return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
10367
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>(
10368
+ parameters
10369
+ );
9765
10370
  }
9766
10371
  }
10372
+ }
9767
10373
 
10374
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get
10375
+ extends StandardParameters {
9768
10376
  /**
9769
- * Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.
9770
- *
9771
- * @param params - Parameters for request
9772
- * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9773
- * @param callback - Optional callback that handles the response.
9774
- * @returns A promise if used with async/await, or void if used with a callback.
10377
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
10378
+ */
10379
+ name?: string;
10380
+ }
10381
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List
10382
+ extends StandardParameters {
10383
+ /**
10384
+ * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
10385
+ */
10386
+ pageSize?: number;
10387
+ /**
10388
+ * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
10389
+ */
10390
+ pageToken?: string;
10391
+ /**
10392
+ * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
10393
+ */
10394
+ parent?: string;
10395
+ }
10396
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch
10397
+ extends StandardParameters {
10398
+ /**
10399
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
10400
+ */
10401
+ name?: string;
10402
+ /**
10403
+ * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
10404
+ */
10405
+ updateMask?: string;
10406
+
10407
+ /**
10408
+ * Request body metadata
10409
+ */
10410
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
10411
+ }
10412
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
10413
+ extends StandardParameters {
10414
+ /**
10415
+ * 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 RecommendationService.Recommend requests.
10416
+ */
10417
+ servingConfig?: string;
10418
+
10419
+ /**
10420
+ * Request body metadata
10421
+ */
10422
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest;
10423
+ }
10424
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search
10425
+ extends StandardParameters {
10426
+ /**
10427
+ * 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.
10428
+ */
10429
+ servingConfig?: string;
10430
+
10431
+ /**
10432
+ * Request body metadata
10433
+ */
10434
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
10435
+ }
10436
+
10437
+ export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine {
10438
+ context: APIRequestContext;
10439
+ operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations;
10440
+ targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites;
10441
+ constructor(context: APIRequestContext) {
10442
+ this.context = context;
10443
+ this.operations =
10444
+ new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations(
10445
+ this.context
10446
+ );
10447
+ this.targetSites =
10448
+ new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites(
10449
+ this.context
10450
+ );
10451
+ }
10452
+
10453
+ /**
10454
+ * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
10455
+ *
10456
+ * @param params - Parameters for request
10457
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
10458
+ * @param callback - Optional callback that handles the response.
10459
+ * @returns A promise if used with async/await, or void if used with a callback.
10460
+ */
10461
+ batchVerifyTargetSites(
10462
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
10463
+ options: StreamMethodOptions
10464
+ ): GaxiosPromise<Readable>;
10465
+ batchVerifyTargetSites(
10466
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
10467
+ options?: MethodOptions
10468
+ ): GaxiosPromise<Schema$GoogleLongrunningOperation>;
10469
+ batchVerifyTargetSites(
10470
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
10471
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
10472
+ callback: BodyResponseCallback<Readable>
10473
+ ): void;
10474
+ batchVerifyTargetSites(
10475
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
10476
+ options:
10477
+ | MethodOptions
10478
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
10479
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10480
+ ): void;
10481
+ batchVerifyTargetSites(
10482
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
10483
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10484
+ ): void;
10485
+ batchVerifyTargetSites(
10486
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10487
+ ): void;
10488
+ batchVerifyTargetSites(
10489
+ paramsOrCallback?:
10490
+ | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites
10491
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10492
+ | BodyResponseCallback<Readable>,
10493
+ optionsOrCallback?:
10494
+ | MethodOptions
10495
+ | StreamMethodOptions
10496
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10497
+ | BodyResponseCallback<Readable>,
10498
+ callback?:
10499
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10500
+ | BodyResponseCallback<Readable>
10501
+ ):
10502
+ | void
10503
+ | GaxiosPromise<Schema$GoogleLongrunningOperation>
10504
+ | GaxiosPromise<Readable> {
10505
+ let params = (paramsOrCallback ||
10506
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites;
10507
+ let options = (optionsOrCallback || {}) as MethodOptions;
10508
+
10509
+ if (typeof paramsOrCallback === 'function') {
10510
+ callback = paramsOrCallback;
10511
+ params =
10512
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites;
10513
+ options = {};
10514
+ }
10515
+
10516
+ if (typeof optionsOrCallback === 'function') {
10517
+ callback = optionsOrCallback;
10518
+ options = {};
10519
+ }
10520
+
10521
+ const rootUrl =
10522
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
10523
+ const parameters = {
10524
+ options: Object.assign(
10525
+ {
10526
+ url: (
10527
+ rootUrl + '/v1alpha/{+parent}:batchVerifyTargetSites'
10528
+ ).replace(/([^:]\/)\/+/g, '$1'),
10529
+ method: 'POST',
10530
+ },
10531
+ options
10532
+ ),
10533
+ params,
10534
+ requiredParams: ['parent'],
10535
+ pathParams: ['parent'],
10536
+ context: this.context,
10537
+ };
10538
+ if (callback) {
10539
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
10540
+ parameters,
10541
+ callback as BodyResponseCallback<unknown>
10542
+ );
10543
+ } else {
10544
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
10545
+ }
10546
+ }
10547
+
10548
+ /**
10549
+ * Downgrade from advanced site search to basic site search.
10550
+ *
10551
+ * @param params - Parameters for request
10552
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
10553
+ * @param callback - Optional callback that handles the response.
10554
+ * @returns A promise if used with async/await, or void if used with a callback.
10555
+ */
10556
+ disableAdvancedSiteSearch(
10557
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch,
10558
+ options: StreamMethodOptions
10559
+ ): GaxiosPromise<Readable>;
10560
+ disableAdvancedSiteSearch(
10561
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch,
10562
+ options?: MethodOptions
10563
+ ): GaxiosPromise<Schema$GoogleLongrunningOperation>;
10564
+ disableAdvancedSiteSearch(
10565
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch,
10566
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
10567
+ callback: BodyResponseCallback<Readable>
10568
+ ): void;
10569
+ disableAdvancedSiteSearch(
10570
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch,
10571
+ options:
10572
+ | MethodOptions
10573
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
10574
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10575
+ ): void;
10576
+ disableAdvancedSiteSearch(
10577
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch,
10578
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10579
+ ): void;
10580
+ disableAdvancedSiteSearch(
10581
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10582
+ ): void;
10583
+ disableAdvancedSiteSearch(
10584
+ paramsOrCallback?:
10585
+ | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch
10586
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10587
+ | BodyResponseCallback<Readable>,
10588
+ optionsOrCallback?:
10589
+ | MethodOptions
10590
+ | StreamMethodOptions
10591
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10592
+ | BodyResponseCallback<Readable>,
10593
+ callback?:
10594
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10595
+ | BodyResponseCallback<Readable>
10596
+ ):
10597
+ | void
10598
+ | GaxiosPromise<Schema$GoogleLongrunningOperation>
10599
+ | GaxiosPromise<Readable> {
10600
+ let params = (paramsOrCallback ||
10601
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch;
10602
+ let options = (optionsOrCallback || {}) as MethodOptions;
10603
+
10604
+ if (typeof paramsOrCallback === 'function') {
10605
+ callback = paramsOrCallback;
10606
+ params =
10607
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch;
10608
+ options = {};
10609
+ }
10610
+
10611
+ if (typeof optionsOrCallback === 'function') {
10612
+ callback = optionsOrCallback;
10613
+ options = {};
10614
+ }
10615
+
10616
+ const rootUrl =
10617
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
10618
+ const parameters = {
10619
+ options: Object.assign(
10620
+ {
10621
+ url: (
10622
+ rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch'
10623
+ ).replace(/([^:]\/)\/+/g, '$1'),
10624
+ method: 'POST',
10625
+ },
10626
+ options
10627
+ ),
10628
+ params,
10629
+ requiredParams: ['siteSearchEngine'],
10630
+ pathParams: ['siteSearchEngine'],
10631
+ context: this.context,
10632
+ };
10633
+ if (callback) {
10634
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
10635
+ parameters,
10636
+ callback as BodyResponseCallback<unknown>
10637
+ );
10638
+ } else {
10639
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
10640
+ }
10641
+ }
10642
+
10643
+ /**
10644
+ * Upgrade from basic site search to advanced site search.
10645
+ *
10646
+ * @param params - Parameters for request
10647
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
10648
+ * @param callback - Optional callback that handles the response.
10649
+ * @returns A promise if used with async/await, or void if used with a callback.
10650
+ */
10651
+ enableAdvancedSiteSearch(
10652
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch,
10653
+ options: StreamMethodOptions
10654
+ ): GaxiosPromise<Readable>;
10655
+ enableAdvancedSiteSearch(
10656
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch,
10657
+ options?: MethodOptions
10658
+ ): GaxiosPromise<Schema$GoogleLongrunningOperation>;
10659
+ enableAdvancedSiteSearch(
10660
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch,
10661
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
10662
+ callback: BodyResponseCallback<Readable>
10663
+ ): void;
10664
+ enableAdvancedSiteSearch(
10665
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch,
10666
+ options:
10667
+ | MethodOptions
10668
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
10669
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10670
+ ): void;
10671
+ enableAdvancedSiteSearch(
10672
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch,
10673
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10674
+ ): void;
10675
+ enableAdvancedSiteSearch(
10676
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10677
+ ): void;
10678
+ enableAdvancedSiteSearch(
10679
+ paramsOrCallback?:
10680
+ | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch
10681
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10682
+ | BodyResponseCallback<Readable>,
10683
+ optionsOrCallback?:
10684
+ | MethodOptions
10685
+ | StreamMethodOptions
10686
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10687
+ | BodyResponseCallback<Readable>,
10688
+ callback?:
10689
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10690
+ | BodyResponseCallback<Readable>
10691
+ ):
10692
+ | void
10693
+ | GaxiosPromise<Schema$GoogleLongrunningOperation>
10694
+ | GaxiosPromise<Readable> {
10695
+ let params = (paramsOrCallback ||
10696
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch;
10697
+ let options = (optionsOrCallback || {}) as MethodOptions;
10698
+
10699
+ if (typeof paramsOrCallback === 'function') {
10700
+ callback = paramsOrCallback;
10701
+ params =
10702
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch;
10703
+ options = {};
10704
+ }
10705
+
10706
+ if (typeof optionsOrCallback === 'function') {
10707
+ callback = optionsOrCallback;
10708
+ options = {};
10709
+ }
10710
+
10711
+ const rootUrl =
10712
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
10713
+ const parameters = {
10714
+ options: Object.assign(
10715
+ {
10716
+ url: (
10717
+ rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch'
10718
+ ).replace(/([^:]\/)\/+/g, '$1'),
10719
+ method: 'POST',
10720
+ },
10721
+ options
10722
+ ),
10723
+ params,
10724
+ requiredParams: ['siteSearchEngine'],
10725
+ pathParams: ['siteSearchEngine'],
10726
+ context: this.context,
10727
+ };
10728
+ if (callback) {
10729
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
10730
+ parameters,
10731
+ callback as BodyResponseCallback<unknown>
10732
+ );
10733
+ } else {
10734
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
10735
+ }
10736
+ }
10737
+
10738
+ /**
10739
+ * Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.
10740
+ *
10741
+ * @param params - Parameters for request
10742
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
10743
+ * @param callback - Optional callback that handles the response.
10744
+ * @returns A promise if used with async/await, or void if used with a callback.
9775
10745
  */
9776
10746
  fetchDomainVerificationStatus(
9777
10747
  params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus,
@@ -12933,13 +13903,201 @@ export namespace discoveryengine_v1alpha {
12933
13903
  | GaxiosPromise<Schema$GoogleProtobufEmpty>
12934
13904
  | GaxiosPromise<Readable> {
12935
13905
  let params = (paramsOrCallback ||
12936
- {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete;
13906
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete;
13907
+ let options = (optionsOrCallback || {}) as MethodOptions;
13908
+
13909
+ if (typeof paramsOrCallback === 'function') {
13910
+ callback = paramsOrCallback;
13911
+ params =
13912
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete;
13913
+ options = {};
13914
+ }
13915
+
13916
+ if (typeof optionsOrCallback === 'function') {
13917
+ callback = optionsOrCallback;
13918
+ options = {};
13919
+ }
13920
+
13921
+ const rootUrl =
13922
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
13923
+ const parameters = {
13924
+ options: Object.assign(
13925
+ {
13926
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
13927
+ method: 'DELETE',
13928
+ },
13929
+ options
13930
+ ),
13931
+ params,
13932
+ requiredParams: ['name'],
13933
+ pathParams: ['name'],
13934
+ context: this.context,
13935
+ };
13936
+ if (callback) {
13937
+ createAPIRequest<Schema$GoogleProtobufEmpty>(
13938
+ parameters,
13939
+ callback as BodyResponseCallback<unknown>
13940
+ );
13941
+ } else {
13942
+ return createAPIRequest<Schema$GoogleProtobufEmpty>(parameters);
13943
+ }
13944
+ }
13945
+
13946
+ /**
13947
+ * Gets a Conversation.
13948
+ *
13949
+ * @param params - Parameters for request
13950
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
13951
+ * @param callback - Optional callback that handles the response.
13952
+ * @returns A promise if used with async/await, or void if used with a callback.
13953
+ */
13954
+ get(
13955
+ params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get,
13956
+ options: StreamMethodOptions
13957
+ ): GaxiosPromise<Readable>;
13958
+ get(
13959
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get,
13960
+ options?: MethodOptions
13961
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaConversation>;
13962
+ get(
13963
+ params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get,
13964
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
13965
+ callback: BodyResponseCallback<Readable>
13966
+ ): void;
13967
+ get(
13968
+ params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get,
13969
+ options:
13970
+ | MethodOptions
13971
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>,
13972
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
13973
+ ): void;
13974
+ get(
13975
+ params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get,
13976
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
13977
+ ): void;
13978
+ get(
13979
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
13980
+ ): void;
13981
+ get(
13982
+ paramsOrCallback?:
13983
+ | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get
13984
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
13985
+ | BodyResponseCallback<Readable>,
13986
+ optionsOrCallback?:
13987
+ | MethodOptions
13988
+ | StreamMethodOptions
13989
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
13990
+ | BodyResponseCallback<Readable>,
13991
+ callback?:
13992
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
13993
+ | BodyResponseCallback<Readable>
13994
+ ):
13995
+ | void
13996
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
13997
+ | GaxiosPromise<Readable> {
13998
+ let params = (paramsOrCallback ||
13999
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get;
14000
+ let options = (optionsOrCallback || {}) as MethodOptions;
14001
+
14002
+ if (typeof paramsOrCallback === 'function') {
14003
+ callback = paramsOrCallback;
14004
+ params =
14005
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get;
14006
+ options = {};
14007
+ }
14008
+
14009
+ if (typeof optionsOrCallback === 'function') {
14010
+ callback = optionsOrCallback;
14011
+ options = {};
14012
+ }
14013
+
14014
+ const rootUrl =
14015
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
14016
+ const parameters = {
14017
+ options: Object.assign(
14018
+ {
14019
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
14020
+ method: 'GET',
14021
+ },
14022
+ options
14023
+ ),
14024
+ params,
14025
+ requiredParams: ['name'],
14026
+ pathParams: ['name'],
14027
+ context: this.context,
14028
+ };
14029
+ if (callback) {
14030
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaConversation>(
14031
+ parameters,
14032
+ callback as BodyResponseCallback<unknown>
14033
+ );
14034
+ } else {
14035
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaConversation>(
14036
+ parameters
14037
+ );
14038
+ }
14039
+ }
14040
+
14041
+ /**
14042
+ * Lists all Conversations by their parent DataStore.
14043
+ *
14044
+ * @param params - Parameters for request
14045
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
14046
+ * @param callback - Optional callback that handles the response.
14047
+ * @returns A promise if used with async/await, or void if used with a callback.
14048
+ */
14049
+ list(
14050
+ params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List,
14051
+ options: StreamMethodOptions
14052
+ ): GaxiosPromise<Readable>;
14053
+ list(
14054
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List,
14055
+ options?: MethodOptions
14056
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>;
14057
+ list(
14058
+ params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List,
14059
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
14060
+ callback: BodyResponseCallback<Readable>
14061
+ ): void;
14062
+ list(
14063
+ params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List,
14064
+ options:
14065
+ | MethodOptions
14066
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>,
14067
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14068
+ ): void;
14069
+ list(
14070
+ params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List,
14071
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14072
+ ): void;
14073
+ list(
14074
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14075
+ ): void;
14076
+ list(
14077
+ paramsOrCallback?:
14078
+ | Params$Resource$Projects$Locations$Collections$Engines$Conversations$List
14079
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14080
+ | BodyResponseCallback<Readable>,
14081
+ optionsOrCallback?:
14082
+ | MethodOptions
14083
+ | StreamMethodOptions
14084
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14085
+ | BodyResponseCallback<Readable>,
14086
+ callback?:
14087
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14088
+ | BodyResponseCallback<Readable>
14089
+ ):
14090
+ | void
14091
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14092
+ | GaxiosPromise<Readable> {
14093
+ let params = (paramsOrCallback ||
14094
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List;
12937
14095
  let options = (optionsOrCallback || {}) as MethodOptions;
12938
14096
 
12939
14097
  if (typeof paramsOrCallback === 'function') {
12940
14098
  callback = paramsOrCallback;
12941
14099
  params =
12942
- {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete;
14100
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List;
12943
14101
  options = {};
12944
14102
  }
12945
14103
 
@@ -12953,64 +14111,69 @@ export namespace discoveryengine_v1alpha {
12953
14111
  const parameters = {
12954
14112
  options: Object.assign(
12955
14113
  {
12956
- url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
12957
- method: 'DELETE',
14114
+ url: (rootUrl + '/v1alpha/{+parent}/conversations').replace(
14115
+ /([^:]\/)\/+/g,
14116
+ '$1'
14117
+ ),
14118
+ method: 'GET',
12958
14119
  },
12959
14120
  options
12960
14121
  ),
12961
14122
  params,
12962
- requiredParams: ['name'],
12963
- pathParams: ['name'],
14123
+ requiredParams: ['parent'],
14124
+ pathParams: ['parent'],
12964
14125
  context: this.context,
12965
14126
  };
12966
14127
  if (callback) {
12967
- createAPIRequest<Schema$GoogleProtobufEmpty>(
14128
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>(
12968
14129
  parameters,
12969
14130
  callback as BodyResponseCallback<unknown>
12970
14131
  );
12971
14132
  } else {
12972
- return createAPIRequest<Schema$GoogleProtobufEmpty>(parameters);
14133
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>(
14134
+ parameters
14135
+ );
12973
14136
  }
12974
14137
  }
12975
14138
 
12976
14139
  /**
12977
- * Gets a Conversation.
14140
+ * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
12978
14141
  *
12979
14142
  * @param params - Parameters for request
12980
14143
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
12981
14144
  * @param callback - Optional callback that handles the response.
12982
14145
  * @returns A promise if used with async/await, or void if used with a callback.
12983
14146
  */
12984
- get(
12985
- params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get,
14147
+ patch(
14148
+ params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch,
12986
14149
  options: StreamMethodOptions
12987
14150
  ): GaxiosPromise<Readable>;
12988
- get(
12989
- params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get,
14151
+ patch(
14152
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch,
12990
14153
  options?: MethodOptions
12991
14154
  ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaConversation>;
12992
- get(
12993
- params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get,
14155
+ patch(
14156
+ params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch,
12994
14157
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
12995
14158
  callback: BodyResponseCallback<Readable>
12996
14159
  ): void;
12997
- get(
12998
- params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get,
14160
+ patch(
14161
+ params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch,
12999
14162
  options:
13000
14163
  | MethodOptions
13001
14164
  | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>,
13002
14165
  callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
13003
14166
  ): void;
13004
- get(
13005
- params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get,
14167
+ patch(
14168
+ params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch,
13006
14169
  callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
13007
14170
  ): void;
13008
- get(
14171
+ patch(
13009
14172
  callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
13010
14173
  ): void;
13011
- get(
14174
+ patch(
13012
14175
  paramsOrCallback?:
13013
- | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get
14176
+ | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch
13014
14177
  | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
13015
14178
  | BodyResponseCallback<Readable>,
13016
14179
  optionsOrCallback?:
@@ -13026,13 +14189,13 @@ export namespace discoveryengine_v1alpha {
13026
14189
  | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
13027
14190
  | GaxiosPromise<Readable> {
13028
14191
  let params = (paramsOrCallback ||
13029
- {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get;
14192
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch;
13030
14193
  let options = (optionsOrCallback || {}) as MethodOptions;
13031
14194
 
13032
14195
  if (typeof paramsOrCallback === 'function') {
13033
14196
  callback = paramsOrCallback;
13034
14197
  params =
13035
- {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get;
14198
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch;
13036
14199
  options = {};
13037
14200
  }
13038
14201
 
@@ -13047,7 +14210,7 @@ export namespace discoveryengine_v1alpha {
13047
14210
  options: Object.assign(
13048
14211
  {
13049
14212
  url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
13050
- method: 'GET',
14213
+ method: 'PATCH',
13051
14214
  },
13052
14215
  options
13053
14216
  ),
@@ -13067,67 +14230,152 @@ export namespace discoveryengine_v1alpha {
13067
14230
  );
13068
14231
  }
13069
14232
  }
14233
+ }
13070
14234
 
14235
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse
14236
+ extends StandardParameters {
13071
14237
  /**
13072
- * Lists all Conversations by their parent DataStore.
14238
+ * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
14239
+ */
14240
+ name?: string;
14241
+
14242
+ /**
14243
+ * Request body metadata
14244
+ */
14245
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
14246
+ }
14247
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create
14248
+ extends StandardParameters {
14249
+ /**
14250
+ * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
14251
+ */
14252
+ parent?: string;
14253
+
14254
+ /**
14255
+ * Request body metadata
14256
+ */
14257
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation;
14258
+ }
14259
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete
14260
+ extends StandardParameters {
14261
+ /**
14262
+ * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`
14263
+ */
14264
+ name?: string;
14265
+ }
14266
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get
14267
+ extends StandardParameters {
14268
+ /**
14269
+ * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`
14270
+ */
14271
+ name?: string;
14272
+ }
14273
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List
14274
+ extends StandardParameters {
14275
+ /**
14276
+ * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
14277
+ */
14278
+ filter?: string;
14279
+ /**
14280
+ * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time"
14281
+ */
14282
+ orderBy?: string;
14283
+ /**
14284
+ * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
14285
+ */
14286
+ pageSize?: number;
14287
+ /**
14288
+ * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.
14289
+ */
14290
+ pageToken?: string;
14291
+ /**
14292
+ * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
14293
+ */
14294
+ parent?: string;
14295
+ }
14296
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch
14297
+ extends StandardParameters {
14298
+ /**
14299
+ * Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `project/x/locations/global/collections/{collection\}/engines/x/conversations/x`.
14300
+ */
14301
+ name?: string;
14302
+ /**
14303
+ * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.
14304
+ */
14305
+ updateMask?: string;
14306
+
14307
+ /**
14308
+ * Request body metadata
14309
+ */
14310
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation;
14311
+ }
14312
+
14313
+ export class Resource$Projects$Locations$Collections$Engines$Operations {
14314
+ context: APIRequestContext;
14315
+ constructor(context: APIRequestContext) {
14316
+ this.context = context;
14317
+ }
14318
+
14319
+ /**
14320
+ * 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.
13073
14321
  *
13074
14322
  * @param params - Parameters for request
13075
14323
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
13076
14324
  * @param callback - Optional callback that handles the response.
13077
14325
  * @returns A promise if used with async/await, or void if used with a callback.
13078
14326
  */
13079
- list(
13080
- params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List,
14327
+ get(
14328
+ params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
13081
14329
  options: StreamMethodOptions
13082
14330
  ): GaxiosPromise<Readable>;
13083
- list(
13084
- params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List,
14331
+ get(
14332
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
13085
14333
  options?: MethodOptions
13086
- ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>;
13087
- list(
13088
- params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List,
14334
+ ): GaxiosPromise<Schema$GoogleLongrunningOperation>;
14335
+ get(
14336
+ params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
13089
14337
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
13090
14338
  callback: BodyResponseCallback<Readable>
13091
14339
  ): void;
13092
- list(
13093
- params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List,
14340
+ get(
14341
+ params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
13094
14342
  options:
13095
14343
  | MethodOptions
13096
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>,
13097
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14344
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
14345
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
13098
14346
  ): void;
13099
- list(
13100
- params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List,
13101
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14347
+ get(
14348
+ params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
14349
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
13102
14350
  ): void;
13103
- list(
13104
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14351
+ get(
14352
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
13105
14353
  ): void;
13106
- list(
14354
+ get(
13107
14355
  paramsOrCallback?:
13108
- | Params$Resource$Projects$Locations$Collections$Engines$Conversations$List
13109
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14356
+ | Params$Resource$Projects$Locations$Collections$Engines$Operations$Get
14357
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
13110
14358
  | BodyResponseCallback<Readable>,
13111
14359
  optionsOrCallback?:
13112
14360
  | MethodOptions
13113
14361
  | StreamMethodOptions
13114
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14362
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
13115
14363
  | BodyResponseCallback<Readable>,
13116
14364
  callback?:
13117
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14365
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
13118
14366
  | BodyResponseCallback<Readable>
13119
14367
  ):
13120
14368
  | void
13121
- | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>
14369
+ | GaxiosPromise<Schema$GoogleLongrunningOperation>
13122
14370
  | GaxiosPromise<Readable> {
13123
14371
  let params = (paramsOrCallback ||
13124
- {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List;
14372
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get;
13125
14373
  let options = (optionsOrCallback || {}) as MethodOptions;
13126
14374
 
13127
14375
  if (typeof paramsOrCallback === 'function') {
13128
14376
  callback = paramsOrCallback;
13129
14377
  params =
13130
- {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List;
14378
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get;
13131
14379
  options = {};
13132
14380
  }
13133
14381
 
@@ -13141,91 +14389,86 @@ export namespace discoveryengine_v1alpha {
13141
14389
  const parameters = {
13142
14390
  options: Object.assign(
13143
14391
  {
13144
- url: (rootUrl + '/v1alpha/{+parent}/conversations').replace(
13145
- /([^:]\/)\/+/g,
13146
- '$1'
13147
- ),
14392
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
13148
14393
  method: 'GET',
13149
14394
  },
13150
14395
  options
13151
14396
  ),
13152
14397
  params,
13153
- requiredParams: ['parent'],
13154
- pathParams: ['parent'],
14398
+ requiredParams: ['name'],
14399
+ pathParams: ['name'],
13155
14400
  context: this.context,
13156
14401
  };
13157
14402
  if (callback) {
13158
- createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>(
14403
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
13159
14404
  parameters,
13160
14405
  callback as BodyResponseCallback<unknown>
13161
14406
  );
13162
14407
  } else {
13163
- return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListConversationsResponse>(
13164
- parameters
13165
- );
14408
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
13166
14409
  }
13167
14410
  }
13168
14411
 
13169
14412
  /**
13170
- * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
14413
+ * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
13171
14414
  *
13172
14415
  * @param params - Parameters for request
13173
14416
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
13174
14417
  * @param callback - Optional callback that handles the response.
13175
14418
  * @returns A promise if used with async/await, or void if used with a callback.
13176
14419
  */
13177
- patch(
13178
- params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch,
14420
+ list(
14421
+ params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
13179
14422
  options: StreamMethodOptions
13180
14423
  ): GaxiosPromise<Readable>;
13181
- patch(
13182
- params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch,
14424
+ list(
14425
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
13183
14426
  options?: MethodOptions
13184
- ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaConversation>;
13185
- patch(
13186
- params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch,
14427
+ ): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
14428
+ list(
14429
+ params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
13187
14430
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
13188
14431
  callback: BodyResponseCallback<Readable>
13189
14432
  ): void;
13190
- patch(
13191
- params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch,
14433
+ list(
14434
+ params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
13192
14435
  options:
13193
14436
  | MethodOptions
13194
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>,
13195
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
14437
+ | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>,
14438
+ callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
13196
14439
  ): void;
13197
- patch(
13198
- params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch,
13199
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
14440
+ list(
14441
+ params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
14442
+ callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
13200
14443
  ): void;
13201
- patch(
13202
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
14444
+ list(
14445
+ callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
13203
14446
  ): void;
13204
- patch(
14447
+ list(
13205
14448
  paramsOrCallback?:
13206
- | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch
13207
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
14449
+ | Params$Resource$Projects$Locations$Collections$Engines$Operations$List
14450
+ | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
13208
14451
  | BodyResponseCallback<Readable>,
13209
14452
  optionsOrCallback?:
13210
14453
  | MethodOptions
13211
14454
  | StreamMethodOptions
13212
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
14455
+ | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
13213
14456
  | BodyResponseCallback<Readable>,
13214
14457
  callback?:
13215
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
14458
+ | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
13216
14459
  | BodyResponseCallback<Readable>
13217
14460
  ):
13218
14461
  | void
13219
- | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaConversation>
14462
+ | GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>
13220
14463
  | GaxiosPromise<Readable> {
13221
14464
  let params = (paramsOrCallback ||
13222
- {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch;
14465
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List;
13223
14466
  let options = (optionsOrCallback || {}) as MethodOptions;
13224
14467
 
13225
14468
  if (typeof paramsOrCallback === 'function') {
13226
14469
  callback = paramsOrCallback;
13227
14470
  params =
13228
- {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch;
14471
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List;
13229
14472
  options = {};
13230
14473
  }
13231
14474
 
@@ -13239,8 +14482,11 @@ export namespace discoveryengine_v1alpha {
13239
14482
  const parameters = {
13240
14483
  options: Object.assign(
13241
14484
  {
13242
- url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
13243
- method: 'PATCH',
14485
+ url: (rootUrl + '/v1alpha/{+name}/operations').replace(
14486
+ /([^:]\/)\/+/g,
14487
+ '$1'
14488
+ ),
14489
+ method: 'GET',
13244
14490
  },
13245
14491
  options
13246
14492
  ),
@@ -13250,104 +14496,53 @@ export namespace discoveryengine_v1alpha {
13250
14496
  context: this.context,
13251
14497
  };
13252
14498
  if (callback) {
13253
- createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaConversation>(
14499
+ createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
13254
14500
  parameters,
13255
14501
  callback as BodyResponseCallback<unknown>
13256
14502
  );
13257
14503
  } else {
13258
- return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaConversation>(
14504
+ return createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
13259
14505
  parameters
13260
14506
  );
13261
14507
  }
13262
14508
  }
13263
14509
  }
13264
14510
 
13265
- export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse
13266
- extends StandardParameters {
13267
- /**
13268
- * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
13269
- */
13270
- name?: string;
13271
-
13272
- /**
13273
- * Request body metadata
13274
- */
13275
- requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
13276
- }
13277
- export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create
13278
- extends StandardParameters {
13279
- /**
13280
- * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
13281
- */
13282
- parent?: string;
13283
-
13284
- /**
13285
- * Request body metadata
13286
- */
13287
- requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation;
13288
- }
13289
- export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete
13290
- extends StandardParameters {
13291
- /**
13292
- * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`
13293
- */
13294
- name?: string;
13295
- }
13296
- export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get
14511
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get
13297
14512
  extends StandardParameters {
13298
14513
  /**
13299
- * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`
14514
+ * The name of the operation resource.
13300
14515
  */
13301
14516
  name?: string;
13302
14517
  }
13303
- export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List
14518
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List
13304
14519
  extends StandardParameters {
13305
14520
  /**
13306
- * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
14521
+ * The standard list filter.
13307
14522
  */
13308
14523
  filter?: string;
13309
14524
  /**
13310
- * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time"
14525
+ * The name of the operation's parent resource.
13311
14526
  */
13312
- orderBy?: string;
14527
+ name?: string;
13313
14528
  /**
13314
- * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
14529
+ * The standard list page size.
13315
14530
  */
13316
14531
  pageSize?: number;
13317
14532
  /**
13318
- * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.
14533
+ * The standard list page token.
13319
14534
  */
13320
14535
  pageToken?: string;
13321
- /**
13322
- * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}`
13323
- */
13324
- parent?: string;
13325
- }
13326
- export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch
13327
- extends StandardParameters {
13328
- /**
13329
- * Immutable. Fully qualified name `project/x/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `project/x/locations/global/collections/{collection\}/engines/x/conversations/x`.
13330
- */
13331
- name?: string;
13332
- /**
13333
- * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.
13334
- */
13335
- updateMask?: string;
13336
-
13337
- /**
13338
- * Request body metadata
13339
- */
13340
- requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation;
13341
14536
  }
13342
14537
 
13343
- export class Resource$Projects$Locations$Collections$Engines$Operations {
14538
+ export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
13344
14539
  context: APIRequestContext;
13345
14540
  constructor(context: APIRequestContext) {
13346
14541
  this.context = context;
13347
14542
  }
13348
14543
 
13349
14544
  /**
13350
- * 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.
14545
+ * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
13351
14546
  *
13352
14547
  * @param params - Parameters for request
13353
14548
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -13355,57 +14550,57 @@ export namespace discoveryengine_v1alpha {
13355
14550
  * @returns A promise if used with async/await, or void if used with a callback.
13356
14551
  */
13357
14552
  get(
13358
- params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
14553
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
13359
14554
  options: StreamMethodOptions
13360
14555
  ): GaxiosPromise<Readable>;
13361
14556
  get(
13362
- params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
14557
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
13363
14558
  options?: MethodOptions
13364
- ): GaxiosPromise<Schema$GoogleLongrunningOperation>;
14559
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
13365
14560
  get(
13366
- params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
14561
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
13367
14562
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
13368
14563
  callback: BodyResponseCallback<Readable>
13369
14564
  ): void;
13370
14565
  get(
13371
- params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
14566
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
13372
14567
  options:
13373
14568
  | MethodOptions
13374
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
13375
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
14569
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
14570
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
13376
14571
  ): void;
13377
14572
  get(
13378
- params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get,
13379
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
14573
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
14574
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
13380
14575
  ): void;
13381
14576
  get(
13382
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
14577
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
13383
14578
  ): void;
13384
14579
  get(
13385
14580
  paramsOrCallback?:
13386
- | Params$Resource$Projects$Locations$Collections$Engines$Operations$Get
13387
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
14581
+ | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get
14582
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
13388
14583
  | BodyResponseCallback<Readable>,
13389
14584
  optionsOrCallback?:
13390
14585
  | MethodOptions
13391
14586
  | StreamMethodOptions
13392
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
14587
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
13393
14588
  | BodyResponseCallback<Readable>,
13394
14589
  callback?:
13395
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
14590
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
13396
14591
  | BodyResponseCallback<Readable>
13397
14592
  ):
13398
14593
  | void
13399
- | GaxiosPromise<Schema$GoogleLongrunningOperation>
14594
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
13400
14595
  | GaxiosPromise<Readable> {
13401
14596
  let params = (paramsOrCallback ||
13402
- {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get;
14597
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get;
13403
14598
  let options = (optionsOrCallback || {}) as MethodOptions;
13404
14599
 
13405
14600
  if (typeof paramsOrCallback === 'function') {
13406
14601
  callback = paramsOrCallback;
13407
14602
  params =
13408
- {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get;
14603
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get;
13409
14604
  options = {};
13410
14605
  }
13411
14606
 
@@ -13430,17 +14625,19 @@ export namespace discoveryengine_v1alpha {
13430
14625
  context: this.context,
13431
14626
  };
13432
14627
  if (callback) {
13433
- createAPIRequest<Schema$GoogleLongrunningOperation>(
14628
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
13434
14629
  parameters,
13435
14630
  callback as BodyResponseCallback<unknown>
13436
14631
  );
13437
14632
  } else {
13438
- return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
14633
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
14634
+ parameters
14635
+ );
13439
14636
  }
13440
14637
  }
13441
14638
 
13442
14639
  /**
13443
- * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
14640
+ * Lists all ServingConfigs linked to this dataStore.
13444
14641
  *
13445
14642
  * @param params - Parameters for request
13446
14643
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -13448,57 +14645,57 @@ export namespace discoveryengine_v1alpha {
13448
14645
  * @returns A promise if used with async/await, or void if used with a callback.
13449
14646
  */
13450
14647
  list(
13451
- params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
14648
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
13452
14649
  options: StreamMethodOptions
13453
14650
  ): GaxiosPromise<Readable>;
13454
14651
  list(
13455
- params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
14652
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
13456
14653
  options?: MethodOptions
13457
- ): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
14654
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
13458
14655
  list(
13459
- params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
14656
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
13460
14657
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
13461
14658
  callback: BodyResponseCallback<Readable>
13462
14659
  ): void;
13463
14660
  list(
13464
- params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
14661
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
13465
14662
  options:
13466
14663
  | MethodOptions
13467
- | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>,
13468
- callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
14664
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>,
14665
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
13469
14666
  ): void;
13470
14667
  list(
13471
- params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List,
13472
- callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
14668
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
14669
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
13473
14670
  ): void;
13474
14671
  list(
13475
- callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
14672
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
13476
14673
  ): void;
13477
14674
  list(
13478
14675
  paramsOrCallback?:
13479
- | Params$Resource$Projects$Locations$Collections$Engines$Operations$List
13480
- | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
14676
+ | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List
14677
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
13481
14678
  | BodyResponseCallback<Readable>,
13482
14679
  optionsOrCallback?:
13483
14680
  | MethodOptions
13484
14681
  | StreamMethodOptions
13485
- | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
14682
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
13486
14683
  | BodyResponseCallback<Readable>,
13487
14684
  callback?:
13488
- | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
14685
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
13489
14686
  | BodyResponseCallback<Readable>
13490
14687
  ):
13491
14688
  | void
13492
- | GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>
14689
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
13493
14690
  | GaxiosPromise<Readable> {
13494
14691
  let params = (paramsOrCallback ||
13495
- {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List;
14692
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List;
13496
14693
  let options = (optionsOrCallback || {}) as MethodOptions;
13497
14694
 
13498
14695
  if (typeof paramsOrCallback === 'function') {
13499
14696
  callback = paramsOrCallback;
13500
14697
  params =
13501
- {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List;
14698
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List;
13502
14699
  options = {};
13503
14700
  }
13504
14701
 
@@ -13512,7 +14709,7 @@ export namespace discoveryengine_v1alpha {
13512
14709
  const parameters = {
13513
14710
  options: Object.assign(
13514
14711
  {
13515
- url: (rootUrl + '/v1alpha/{+name}/operations').replace(
14712
+ url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace(
13516
14713
  /([^:]\/)\/+/g,
13517
14714
  '$1'
13518
14715
  ),
@@ -13521,54 +14718,115 @@ export namespace discoveryengine_v1alpha {
13521
14718
  options
13522
14719
  ),
13523
14720
  params,
13524
- requiredParams: ['name'],
13525
- pathParams: ['name'],
14721
+ requiredParams: ['parent'],
14722
+ pathParams: ['parent'],
13526
14723
  context: this.context,
13527
14724
  };
13528
14725
  if (callback) {
13529
- createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
14726
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
13530
14727
  parameters,
13531
14728
  callback as BodyResponseCallback<unknown>
13532
14729
  );
13533
14730
  } else {
13534
- return createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
14731
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
13535
14732
  parameters
13536
14733
  );
13537
14734
  }
13538
14735
  }
13539
- }
13540
14736
 
13541
- export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get
13542
- extends StandardParameters {
13543
- /**
13544
- * The name of the operation resource.
13545
- */
13546
- name?: string;
13547
- }
13548
- export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List
13549
- extends StandardParameters {
13550
- /**
13551
- * The standard list filter.
13552
- */
13553
- filter?: string;
13554
- /**
13555
- * The name of the operation's parent resource.
13556
- */
13557
- name?: string;
13558
- /**
13559
- * The standard list page size.
13560
- */
13561
- pageSize?: number;
13562
14737
  /**
13563
- * The standard list page token.
14738
+ * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
14739
+ *
14740
+ * @param params - Parameters for request
14741
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
14742
+ * @param callback - Optional callback that handles the response.
14743
+ * @returns A promise if used with async/await, or void if used with a callback.
13564
14744
  */
13565
- pageToken?: string;
13566
- }
14745
+ patch(
14746
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
14747
+ options: StreamMethodOptions
14748
+ ): GaxiosPromise<Readable>;
14749
+ patch(
14750
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
14751
+ options?: MethodOptions
14752
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
14753
+ patch(
14754
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
14755
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
14756
+ callback: BodyResponseCallback<Readable>
14757
+ ): void;
14758
+ patch(
14759
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
14760
+ options:
14761
+ | MethodOptions
14762
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
14763
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14764
+ ): void;
14765
+ patch(
14766
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
14767
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14768
+ ): void;
14769
+ patch(
14770
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14771
+ ): void;
14772
+ patch(
14773
+ paramsOrCallback?:
14774
+ | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch
14775
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14776
+ | BodyResponseCallback<Readable>,
14777
+ optionsOrCallback?:
14778
+ | MethodOptions
14779
+ | StreamMethodOptions
14780
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14781
+ | BodyResponseCallback<Readable>,
14782
+ callback?:
14783
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14784
+ | BodyResponseCallback<Readable>
14785
+ ):
14786
+ | void
14787
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14788
+ | GaxiosPromise<Readable> {
14789
+ let params = (paramsOrCallback ||
14790
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch;
14791
+ let options = (optionsOrCallback || {}) as MethodOptions;
13567
14792
 
13568
- export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
13569
- context: APIRequestContext;
13570
- constructor(context: APIRequestContext) {
13571
- this.context = context;
14793
+ if (typeof paramsOrCallback === 'function') {
14794
+ callback = paramsOrCallback;
14795
+ params =
14796
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch;
14797
+ options = {};
14798
+ }
14799
+
14800
+ if (typeof optionsOrCallback === 'function') {
14801
+ callback = optionsOrCallback;
14802
+ options = {};
14803
+ }
14804
+
14805
+ const rootUrl =
14806
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
14807
+ const parameters = {
14808
+ options: Object.assign(
14809
+ {
14810
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
14811
+ method: 'PATCH',
14812
+ },
14813
+ options
14814
+ ),
14815
+ params,
14816
+ requiredParams: ['name'],
14817
+ pathParams: ['name'],
14818
+ context: this.context,
14819
+ };
14820
+ if (callback) {
14821
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
14822
+ parameters,
14823
+ callback as BodyResponseCallback<unknown>
14824
+ );
14825
+ } else {
14826
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
14827
+ parameters
14828
+ );
14829
+ }
13572
14830
  }
13573
14831
 
13574
14832
  /**
@@ -13768,6 +15026,44 @@ export namespace discoveryengine_v1alpha {
13768
15026
  }
13769
15027
  }
13770
15028
 
15029
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get
15030
+ extends StandardParameters {
15031
+ /**
15032
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
15033
+ */
15034
+ name?: string;
15035
+ }
15036
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List
15037
+ extends StandardParameters {
15038
+ /**
15039
+ * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
15040
+ */
15041
+ pageSize?: number;
15042
+ /**
15043
+ * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
15044
+ */
15045
+ pageToken?: string;
15046
+ /**
15047
+ * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
15048
+ */
15049
+ parent?: string;
15050
+ }
15051
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch
15052
+ extends StandardParameters {
15053
+ /**
15054
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
15055
+ */
15056
+ name?: string;
15057
+ /**
15058
+ * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
15059
+ */
15060
+ updateMask?: string;
15061
+
15062
+ /**
15063
+ * Request body metadata
15064
+ */
15065
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
15066
+ }
13771
15067
  export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend
13772
15068
  extends StandardParameters {
13773
15069
  /**
@@ -15797,6 +17093,10 @@ export namespace discoveryengine_v1alpha {
15797
17093
  * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
15798
17094
  */
15799
17095
  name?: string;
17096
+ /**
17097
+ * Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
17098
+ */
17099
+ updateMask?: string;
15800
17100
 
15801
17101
  /**
15802
17102
  * Request body metadata
@@ -17711,6 +19011,294 @@ export namespace discoveryengine_v1alpha {
17711
19011
  this.context = context;
17712
19012
  }
17713
19013
 
19014
+ /**
19015
+ * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
19016
+ *
19017
+ * @param params - Parameters for request
19018
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
19019
+ * @param callback - Optional callback that handles the response.
19020
+ * @returns A promise if used with async/await, or void if used with a callback.
19021
+ */
19022
+ get(
19023
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
19024
+ options: StreamMethodOptions
19025
+ ): GaxiosPromise<Readable>;
19026
+ get(
19027
+ params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
19028
+ options?: MethodOptions
19029
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
19030
+ get(
19031
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
19032
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
19033
+ callback: BodyResponseCallback<Readable>
19034
+ ): void;
19035
+ get(
19036
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
19037
+ options:
19038
+ | MethodOptions
19039
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
19040
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19041
+ ): void;
19042
+ get(
19043
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
19044
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19045
+ ): void;
19046
+ get(
19047
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19048
+ ): void;
19049
+ get(
19050
+ paramsOrCallback?:
19051
+ | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get
19052
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19053
+ | BodyResponseCallback<Readable>,
19054
+ optionsOrCallback?:
19055
+ | MethodOptions
19056
+ | StreamMethodOptions
19057
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19058
+ | BodyResponseCallback<Readable>,
19059
+ callback?:
19060
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19061
+ | BodyResponseCallback<Readable>
19062
+ ):
19063
+ | void
19064
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19065
+ | GaxiosPromise<Readable> {
19066
+ let params = (paramsOrCallback ||
19067
+ {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get;
19068
+ let options = (optionsOrCallback || {}) as MethodOptions;
19069
+
19070
+ if (typeof paramsOrCallback === 'function') {
19071
+ callback = paramsOrCallback;
19072
+ params =
19073
+ {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get;
19074
+ options = {};
19075
+ }
19076
+
19077
+ if (typeof optionsOrCallback === 'function') {
19078
+ callback = optionsOrCallback;
19079
+ options = {};
19080
+ }
19081
+
19082
+ const rootUrl =
19083
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
19084
+ const parameters = {
19085
+ options: Object.assign(
19086
+ {
19087
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
19088
+ method: 'GET',
19089
+ },
19090
+ options
19091
+ ),
19092
+ params,
19093
+ requiredParams: ['name'],
19094
+ pathParams: ['name'],
19095
+ context: this.context,
19096
+ };
19097
+ if (callback) {
19098
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
19099
+ parameters,
19100
+ callback as BodyResponseCallback<unknown>
19101
+ );
19102
+ } else {
19103
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
19104
+ parameters
19105
+ );
19106
+ }
19107
+ }
19108
+
19109
+ /**
19110
+ * Lists all ServingConfigs linked to this dataStore.
19111
+ *
19112
+ * @param params - Parameters for request
19113
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
19114
+ * @param callback - Optional callback that handles the response.
19115
+ * @returns A promise if used with async/await, or void if used with a callback.
19116
+ */
19117
+ list(
19118
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
19119
+ options: StreamMethodOptions
19120
+ ): GaxiosPromise<Readable>;
19121
+ list(
19122
+ params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
19123
+ options?: MethodOptions
19124
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
19125
+ list(
19126
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
19127
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
19128
+ callback: BodyResponseCallback<Readable>
19129
+ ): void;
19130
+ list(
19131
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
19132
+ options:
19133
+ | MethodOptions
19134
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>,
19135
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
19136
+ ): void;
19137
+ list(
19138
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
19139
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
19140
+ ): void;
19141
+ list(
19142
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
19143
+ ): void;
19144
+ list(
19145
+ paramsOrCallback?:
19146
+ | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List
19147
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
19148
+ | BodyResponseCallback<Readable>,
19149
+ optionsOrCallback?:
19150
+ | MethodOptions
19151
+ | StreamMethodOptions
19152
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
19153
+ | BodyResponseCallback<Readable>,
19154
+ callback?:
19155
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
19156
+ | BodyResponseCallback<Readable>
19157
+ ):
19158
+ | void
19159
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
19160
+ | GaxiosPromise<Readable> {
19161
+ let params = (paramsOrCallback ||
19162
+ {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List;
19163
+ let options = (optionsOrCallback || {}) as MethodOptions;
19164
+
19165
+ if (typeof paramsOrCallback === 'function') {
19166
+ callback = paramsOrCallback;
19167
+ params =
19168
+ {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List;
19169
+ options = {};
19170
+ }
19171
+
19172
+ if (typeof optionsOrCallback === 'function') {
19173
+ callback = optionsOrCallback;
19174
+ options = {};
19175
+ }
19176
+
19177
+ const rootUrl =
19178
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
19179
+ const parameters = {
19180
+ options: Object.assign(
19181
+ {
19182
+ url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace(
19183
+ /([^:]\/)\/+/g,
19184
+ '$1'
19185
+ ),
19186
+ method: 'GET',
19187
+ },
19188
+ options
19189
+ ),
19190
+ params,
19191
+ requiredParams: ['parent'],
19192
+ pathParams: ['parent'],
19193
+ context: this.context,
19194
+ };
19195
+ if (callback) {
19196
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
19197
+ parameters,
19198
+ callback as BodyResponseCallback<unknown>
19199
+ );
19200
+ } else {
19201
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
19202
+ parameters
19203
+ );
19204
+ }
19205
+ }
19206
+
19207
+ /**
19208
+ * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
19209
+ *
19210
+ * @param params - Parameters for request
19211
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
19212
+ * @param callback - Optional callback that handles the response.
19213
+ * @returns A promise if used with async/await, or void if used with a callback.
19214
+ */
19215
+ patch(
19216
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
19217
+ options: StreamMethodOptions
19218
+ ): GaxiosPromise<Readable>;
19219
+ patch(
19220
+ params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
19221
+ options?: MethodOptions
19222
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
19223
+ patch(
19224
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
19225
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
19226
+ callback: BodyResponseCallback<Readable>
19227
+ ): void;
19228
+ patch(
19229
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
19230
+ options:
19231
+ | MethodOptions
19232
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
19233
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19234
+ ): void;
19235
+ patch(
19236
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
19237
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19238
+ ): void;
19239
+ patch(
19240
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19241
+ ): void;
19242
+ patch(
19243
+ paramsOrCallback?:
19244
+ | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch
19245
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19246
+ | BodyResponseCallback<Readable>,
19247
+ optionsOrCallback?:
19248
+ | MethodOptions
19249
+ | StreamMethodOptions
19250
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19251
+ | BodyResponseCallback<Readable>,
19252
+ callback?:
19253
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19254
+ | BodyResponseCallback<Readable>
19255
+ ):
19256
+ | void
19257
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
19258
+ | GaxiosPromise<Readable> {
19259
+ let params = (paramsOrCallback ||
19260
+ {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch;
19261
+ let options = (optionsOrCallback || {}) as MethodOptions;
19262
+
19263
+ if (typeof paramsOrCallback === 'function') {
19264
+ callback = paramsOrCallback;
19265
+ params =
19266
+ {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch;
19267
+ options = {};
19268
+ }
19269
+
19270
+ if (typeof optionsOrCallback === 'function') {
19271
+ callback = optionsOrCallback;
19272
+ options = {};
19273
+ }
19274
+
19275
+ const rootUrl =
19276
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
19277
+ const parameters = {
19278
+ options: Object.assign(
19279
+ {
19280
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
19281
+ method: 'PATCH',
19282
+ },
19283
+ options
19284
+ ),
19285
+ params,
19286
+ requiredParams: ['name'],
19287
+ pathParams: ['name'],
19288
+ context: this.context,
19289
+ };
19290
+ if (callback) {
19291
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
19292
+ parameters,
19293
+ callback as BodyResponseCallback<unknown>
19294
+ );
19295
+ } else {
19296
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
19297
+ parameters
19298
+ );
19299
+ }
19300
+ }
19301
+
17714
19302
  /**
17715
19303
  * Makes a recommendation, which requires a contextual user event.
17716
19304
  *
@@ -17908,6 +19496,44 @@ export namespace discoveryengine_v1alpha {
17908
19496
  }
17909
19497
  }
17910
19498
 
19499
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get
19500
+ extends StandardParameters {
19501
+ /**
19502
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
19503
+ */
19504
+ name?: string;
19505
+ }
19506
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List
19507
+ extends StandardParameters {
19508
+ /**
19509
+ * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
19510
+ */
19511
+ pageSize?: number;
19512
+ /**
19513
+ * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
19514
+ */
19515
+ pageToken?: string;
19516
+ /**
19517
+ * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
19518
+ */
19519
+ parent?: string;
19520
+ }
19521
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch
19522
+ extends StandardParameters {
19523
+ /**
19524
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
19525
+ */
19526
+ name?: string;
19527
+ /**
19528
+ * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
19529
+ */
19530
+ updateMask?: string;
19531
+
19532
+ /**
19533
+ * Request body metadata
19534
+ */
19535
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
19536
+ }
17911
19537
  export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend
17912
19538
  extends StandardParameters {
17913
19539
  /**