@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20231102 → 0.0.20231110

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.
Files changed (3) hide show
  1. package/index.d.ts +114 -5
  2. package/package.json +1 -1
  3. package/tests.ts +18 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
12
- // Revision: 20231102
12
+ // Revision: 20231110
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -484,6 +484,12 @@ declare namespace gapi.client {
484
484
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
485
485
  displayName?:
486
486
  string;
487
+ /**
488
+ * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has
489
+ * to match vertical of the DataStore liniked to the engine.
490
+ */
491
+ industryVertical?:
492
+ string;
487
493
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
488
494
  mediaRecommendationEngineConfig?:
489
495
  GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
@@ -513,15 +519,15 @@ declare namespace gapi.client {
513
519
  interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig {
514
520
  /**
515
521
  * The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It
516
- * means they cannot be retrieved using GetEngine or ListEngine API after engine creation.
522
+ * means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
517
523
  */
518
524
  agentCreationConfig?:
519
525
  GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
520
526
  /**
521
527
  * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links
522
528
  * the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means
523
- * they cannot be retrieved using GetEngine or ListEngine API after engine creation. Please use Engine.chat_engine_metadata.dialogflow_agent for actual agent association after Engine
524
- * is created.
529
+ * they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use chat_engine_metadata.dialogflow_agent for actual agent
530
+ * association after Engine is created.
525
531
  */
526
532
  dialogflowAgentToLink?:
527
533
  string;
@@ -1217,6 +1223,14 @@ declare namespace gapi.client {
1217
1223
  */
1218
1224
  branch?:
1219
1225
  string;
1226
+ /**
1227
+ * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement
1228
+ * such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query
1229
+ * expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about
1230
+ * filter syntax, see SearchRequest.filter.
1231
+ */
1232
+ canonicalFilter?:
1233
+ string;
1220
1234
  /** A specification for configuring the behavior of content search. */
1221
1235
  contentSearchSpec?:
1222
1236
  GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
@@ -2681,6 +2695,99 @@ declare namespace gapi.client {
2681
2695
  },
2682
2696
  body: GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest): Request<GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>;
2683
2697
  }
2698
+ interface OperationsResource {
2699
+ /** 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. */
2700
+ get(request?: {
2701
+ /** V1 error format. */
2702
+ "$.xgafv"?:
2703
+ string;
2704
+ /** OAuth access token. */
2705
+ access_token?:
2706
+ string;
2707
+ /** Data format for response. */
2708
+ alt?:
2709
+ string;
2710
+ /** JSONP */
2711
+ callback?:
2712
+ string;
2713
+ /** Selector specifying which fields to include in a partial response. */
2714
+ fields?:
2715
+ string;
2716
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2717
+ key?:
2718
+ string;
2719
+ /** The name of the operation resource. */
2720
+ name:
2721
+ string;
2722
+ /** OAuth 2.0 token for the current user. */
2723
+ oauth_token?:
2724
+ string;
2725
+ /** Returns response with indentations and line breaks. */
2726
+ prettyPrint?:
2727
+ boolean;
2728
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2729
+ quotaUser?:
2730
+ string;
2731
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2732
+ upload_protocol?:
2733
+ string;
2734
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2735
+ uploadType?:
2736
+ string;
2737
+ }): Request<GoogleLongrunningOperation>;
2738
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
2739
+ list(request?: {
2740
+ /** V1 error format. */
2741
+ "$.xgafv"?:
2742
+ string;
2743
+ /** OAuth access token. */
2744
+ access_token?:
2745
+ string;
2746
+ /** Data format for response. */
2747
+ alt?:
2748
+ string;
2749
+ /** JSONP */
2750
+ callback?:
2751
+ string;
2752
+ /** Selector specifying which fields to include in a partial response. */
2753
+ fields?:
2754
+ string;
2755
+ /** The standard list filter. */
2756
+ filter?:
2757
+ string;
2758
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2759
+ key?:
2760
+ string;
2761
+ /** The name of the operation's parent resource. */
2762
+ name:
2763
+ string;
2764
+ /** OAuth 2.0 token for the current user. */
2765
+ oauth_token?:
2766
+ string;
2767
+ /** The standard list page size. */
2768
+ pageSize?:
2769
+ number;
2770
+ /** The standard list page token. */
2771
+ pageToken?:
2772
+ string;
2773
+ /** Returns response with indentations and line breaks. */
2774
+ prettyPrint?:
2775
+ boolean;
2776
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2777
+ quotaUser?:
2778
+ string;
2779
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2780
+ upload_protocol?:
2781
+ string;
2782
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2783
+ uploadType?:
2784
+ string;
2785
+ }): Request<GoogleLongrunningListOperationsResponse>;
2786
+ }
2787
+ interface DataConnectorResource {
2788
+ operations:
2789
+ OperationsResource;
2790
+ }
2684
2791
  interface DocumentsResource {
2685
2792
  /** Creates a Document. */
2686
2793
  create(request: {
@@ -5869,7 +5976,7 @@ declare namespace gapi.client {
5869
5976
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5870
5977
  uploadType?:
5871
5978
  string;
5872
- }): Request<{}>;
5979
+ }): Request<GoogleLongrunningOperation>;
5873
5980
  /** Gets a Engine. */
5874
5981
  get(request?: {
5875
5982
  /** V1 error format. */
@@ -6390,6 +6497,8 @@ declare namespace gapi.client {
6390
6497
  }): Request<GoogleLongrunningListOperationsResponse>;
6391
6498
  }
6392
6499
  interface CollectionsResource {
6500
+ dataConnector:
6501
+ DataConnectorResource;
6393
6502
  dataStores:
6394
6503
  DataStoresResource;
6395
6504
  engines:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
3
- "version": "0.0.20231102",
3
+ "version": "0.0.20231110",
4
4
  "description": "TypeScript typings for Discovery Engine API v1alpha",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20231102
6
+ // Revision: 20231110
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -152,6 +152,7 @@ gapi.load('client', async () => {
152
152
  ],
153
153
  },
154
154
  branch: "Test string",
155
+ canonicalFilter: "Test string",
155
156
  contentSearchSpec: {
156
157
  extractiveContentSpec: {
157
158
  maxExtractiveAnswerCount: 42,
@@ -245,6 +246,17 @@ gapi.load('client', async () => {
245
246
  userPseudoId: "Test string",
246
247
  },
247
248
  });
249
+ /** 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. */
250
+ await gapi.client.discoveryengine.projects.locations.collections.dataConnector.operations.get({
251
+ name: "Test string",
252
+ });
253
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
254
+ await gapi.client.discoveryengine.projects.locations.collections.dataConnector.operations.list({
255
+ filter: "Test string",
256
+ name: "Test string",
257
+ pageSize: 42,
258
+ pageToken: "Test string",
259
+ });
248
260
  /** Completes the specified user input with keyword suggestions. */
249
261
  await gapi.client.discoveryengine.projects.locations.collections.dataStores.completeQuery({
250
262
  dataStore: "Test string",
@@ -816,6 +828,7 @@ gapi.load('client', async () => {
816
828
  ],
817
829
  },
818
830
  branch: "Test string",
831
+ canonicalFilter: "Test string",
819
832
  contentSearchSpec: {
820
833
  extractiveContentSpec: {
821
834
  maxExtractiveAnswerCount: 42,
@@ -1164,6 +1177,7 @@ gapi.load('client', async () => {
1164
1177
  "Test string"
1165
1178
  ],
1166
1179
  displayName: "Test string",
1180
+ industryVertical: "Test string",
1167
1181
  mediaRecommendationEngineConfig: {
1168
1182
  optimizationObjective: "Test string",
1169
1183
  optimizationObjectiveConfig: {
@@ -1230,6 +1244,7 @@ gapi.load('client', async () => {
1230
1244
  "Test string"
1231
1245
  ],
1232
1246
  displayName: "Test string",
1247
+ industryVertical: "Test string",
1233
1248
  mediaRecommendationEngineConfig: {
1234
1249
  optimizationObjective: "Test string",
1235
1250
  optimizationObjectiveConfig: {
@@ -1383,6 +1398,7 @@ gapi.load('client', async () => {
1383
1398
  ],
1384
1399
  },
1385
1400
  branch: "Test string",
1401
+ canonicalFilter: "Test string",
1386
1402
  contentSearchSpec: {
1387
1403
  extractiveContentSpec: {
1388
1404
  maxExtractiveAnswerCount: 42,
@@ -2046,6 +2062,7 @@ gapi.load('client', async () => {
2046
2062
  ],
2047
2063
  },
2048
2064
  branch: "Test string",
2065
+ canonicalFilter: "Test string",
2049
2066
  contentSearchSpec: {
2050
2067
  extractiveContentSpec: {
2051
2068
  maxExtractiveAnswerCount: 42,