@maxim_mazurok/gapi.client.discoveryengine-v1beta 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 +113 -4
  2. package/package.json +1 -1
  3. package/tests.ts +15 -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=v1beta
12
- // Revision: 20231102
12
+ // Revision: 20231110
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -204,6 +204,12 @@ declare namespace gapi.client {
204
204
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
205
205
  displayName?:
206
206
  string;
207
+ /**
208
+ * 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
209
+ * to match vertical of the DataStore liniked to the engine.
210
+ */
211
+ industryVertical?:
212
+ string;
207
213
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
208
214
  mediaRecommendationEngineConfig?:
209
215
  GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
@@ -233,15 +239,15 @@ declare namespace gapi.client {
233
239
  interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig {
234
240
  /**
235
241
  * 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
236
- * means they cannot be retrieved using GetEngine or ListEngine API after engine creation.
242
+ * means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
237
243
  */
238
244
  agentCreationConfig?:
239
245
  GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
240
246
  /**
241
247
  * 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
242
248
  * 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
243
- * 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
244
- * is created.
249
+ * they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use chat_engine_metadata.dialogflow_agent for actual agent
250
+ * association after Engine is created.
245
251
  */
246
252
  dialogflowAgentToLink?:
247
253
  string;
@@ -1292,6 +1298,14 @@ declare namespace gapi.client {
1292
1298
  */
1293
1299
  branch?:
1294
1300
  string;
1301
+ /**
1302
+ * 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
1303
+ * 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
1304
+ * 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
1305
+ * filter syntax, see SearchRequest.filter.
1306
+ */
1307
+ canonicalFilter?:
1308
+ string;
1295
1309
  /** A specification for configuring the behavior of content search. */
1296
1310
  contentSearchSpec?:
1297
1311
  GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
@@ -2068,6 +2082,99 @@ declare namespace gapi.client {
2068
2082
  year?:
2069
2083
  number;
2070
2084
  }
2085
+ interface OperationsResource {
2086
+ /** 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. */
2087
+ get(request?: {
2088
+ /** V1 error format. */
2089
+ "$.xgafv"?:
2090
+ string;
2091
+ /** OAuth access token. */
2092
+ access_token?:
2093
+ string;
2094
+ /** Data format for response. */
2095
+ alt?:
2096
+ string;
2097
+ /** JSONP */
2098
+ callback?:
2099
+ string;
2100
+ /** Selector specifying which fields to include in a partial response. */
2101
+ fields?:
2102
+ string;
2103
+ /** 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. */
2104
+ key?:
2105
+ string;
2106
+ /** The name of the operation resource. */
2107
+ name:
2108
+ string;
2109
+ /** OAuth 2.0 token for the current user. */
2110
+ oauth_token?:
2111
+ string;
2112
+ /** Returns response with indentations and line breaks. */
2113
+ prettyPrint?:
2114
+ boolean;
2115
+ /** 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. */
2116
+ quotaUser?:
2117
+ string;
2118
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2119
+ upload_protocol?:
2120
+ string;
2121
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2122
+ uploadType?:
2123
+ string;
2124
+ }): Request<GoogleLongrunningOperation>;
2125
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
2126
+ list(request?: {
2127
+ /** V1 error format. */
2128
+ "$.xgafv"?:
2129
+ string;
2130
+ /** OAuth access token. */
2131
+ access_token?:
2132
+ string;
2133
+ /** Data format for response. */
2134
+ alt?:
2135
+ string;
2136
+ /** JSONP */
2137
+ callback?:
2138
+ string;
2139
+ /** Selector specifying which fields to include in a partial response. */
2140
+ fields?:
2141
+ string;
2142
+ /** The standard list filter. */
2143
+ filter?:
2144
+ string;
2145
+ /** 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. */
2146
+ key?:
2147
+ string;
2148
+ /** The name of the operation's parent resource. */
2149
+ name:
2150
+ string;
2151
+ /** OAuth 2.0 token for the current user. */
2152
+ oauth_token?:
2153
+ string;
2154
+ /** The standard list page size. */
2155
+ pageSize?:
2156
+ number;
2157
+ /** The standard list page token. */
2158
+ pageToken?:
2159
+ string;
2160
+ /** Returns response with indentations and line breaks. */
2161
+ prettyPrint?:
2162
+ boolean;
2163
+ /** 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. */
2164
+ quotaUser?:
2165
+ string;
2166
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2167
+ upload_protocol?:
2168
+ string;
2169
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2170
+ uploadType?:
2171
+ string;
2172
+ }): Request<GoogleLongrunningListOperationsResponse>;
2173
+ }
2174
+ interface DataConnectorResource {
2175
+ operations:
2176
+ OperationsResource;
2177
+ }
2071
2178
  interface DocumentsResource {
2072
2179
  /** Creates a Document. */
2073
2180
  create(request: {
@@ -4705,6 +4812,8 @@ declare namespace gapi.client {
4705
4812
  }): Request<GoogleLongrunningListOperationsResponse>;
4706
4813
  }
4707
4814
  interface CollectionsResource {
4815
+ dataConnector:
4816
+ DataConnectorResource;
4708
4817
  dataStores:
4709
4818
  DataStoresResource;
4710
4819
  engines:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
3
- "version": "0.0.20231102",
3
+ "version": "0.0.20231110",
4
4
  "description": "TypeScript typings for Discovery Engine API v1beta",
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 */
@@ -29,6 +29,17 @@ gapi.load('client', async () => {
29
29
  });
30
30
 
31
31
  async function run() {
32
+ /** 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. */
33
+ await gapi.client.discoveryengine.projects.locations.collections.dataConnector.operations.get({
34
+ name: "Test string",
35
+ });
36
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
37
+ await gapi.client.discoveryengine.projects.locations.collections.dataConnector.operations.list({
38
+ filter: "Test string",
39
+ name: "Test string",
40
+ pageSize: 42,
41
+ pageToken: "Test string",
42
+ });
32
43
  /** Completes the specified user input with keyword suggestions. */
33
44
  await gapi.client.discoveryengine.projects.locations.collections.dataStores.completeQuery({
34
45
  dataStore: "Test string",
@@ -527,6 +538,7 @@ gapi.load('client', async () => {
527
538
  ],
528
539
  },
529
540
  branch: "Test string",
541
+ canonicalFilter: "Test string",
530
542
  contentSearchSpec: {
531
543
  extractiveContentSpec: {
532
544
  maxExtractiveAnswerCount: 42,
@@ -943,6 +955,7 @@ gapi.load('client', async () => {
943
955
  ],
944
956
  },
945
957
  branch: "Test string",
958
+ canonicalFilter: "Test string",
946
959
  contentSearchSpec: {
947
960
  extractiveContentSpec: {
948
961
  maxExtractiveAnswerCount: 42,
@@ -1532,6 +1545,7 @@ gapi.load('client', async () => {
1532
1545
  ],
1533
1546
  },
1534
1547
  branch: "Test string",
1548
+ canonicalFilter: "Test string",
1535
1549
  contentSearchSpec: {
1536
1550
  extractiveContentSpec: {
1537
1551
  maxExtractiveAnswerCount: 42,