@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20230306 → 0.0.20230322

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 +32 -68
  2. package/package.json +1 -1
  3. package/tests.ts +1 -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: 20230306
12
+ // Revision: 20230322
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -74,8 +74,9 @@ declare namespace gapi.client {
74
74
  }
75
75
  interface GoogleCloudDiscoveryengineV1alphaBigQuerySource {
76
76
  /**
77
- * The schema to use when parsing the data from the source. Supported values for imports: * `user_event` (default): One JSON UserEvent per line. * `document` (default): One JSON
78
- * Document per line. Each document must have a valid document.id.
77
+ * The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document
78
+ * imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom_data`: One
79
+ * custom data per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the Generic Data Store vertical.
79
80
  */
80
81
  dataSchema?: string;
81
82
  /** Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. */
@@ -98,67 +99,6 @@ declare namespace gapi.client {
98
99
  /** End user selected CompleteQueryResponse.CompletionResult.suggestion. */
99
100
  selectedSuggestion?: string;
100
101
  }
101
- interface GoogleCloudDiscoveryengineV1alphaCondition {
102
- /** Optional. Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
103
- activeTimeRange?: GoogleCloudDiscoveryengineV1alphaConditionTimeRange[];
104
- /** Optional. Search only A list of terms to match the query on. Maximum of 10 query terms. */
105
- queryTerms?: GoogleCloudDiscoveryengineV1alphaConditionQueryTerm[];
106
- }
107
- interface GoogleCloudDiscoveryengineV1alphaConditionQueryTerm {
108
- /** Whether the search query needs to exactly match the query term. */
109
- fullMatch?: boolean;
110
- /**
111
- * The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length
112
- * of 5000 characters.
113
- */
114
- value?: string;
115
- }
116
- interface GoogleCloudDiscoveryengineV1alphaConditionTimeRange {
117
- /** End of time range. Range is inclusive. Must be in the future. */
118
- endTime?: string;
119
- /** Start of time range. Range is inclusive. */
120
- startTime?: string;
121
- }
122
- interface GoogleCloudDiscoveryengineV1alphaControl {
123
- /** Output only. List of all [ServingConfig] ids this control is attached to. May take up to 10 minutes to update after changes. */
124
- associatedServingConfigIds?: string[];
125
- /** Defines a boost-type control */
126
- boostAction?: GoogleCloudDiscoveryengineV1alphaControlBoostAction;
127
- /**
128
- * Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is
129
- * thrown.
130
- */
131
- conditions?: GoogleCloudDiscoveryengineV1alphaCondition[];
132
- /** Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. */
133
- displayName?: string;
134
- /** Defines a filter-type control Currently not supported by Recommendation */
135
- filterAction?: GoogleCloudDiscoveryengineV1alphaControlFilterAction;
136
- /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
137
- name?: string;
138
- /** Required. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
139
- solutionType?: string;
140
- /**
141
- * Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set
142
- * when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.
143
- */
144
- useCases?: string[];
145
- }
146
- interface GoogleCloudDiscoveryengineV1alphaControlBoostAction {
147
- /** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
148
- boost?: number;
149
- /**
150
- * Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation:
151
- * https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
152
- */
153
- filter?: string;
154
- }
155
- interface GoogleCloudDiscoveryengineV1alphaControlFilterAction {
156
- /**
157
- * Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000
158
- * characters. Otherwise an INVALID ARGUMENT error is thrown.
159
- */
160
- filter?: string;
161
- }
162
102
  interface GoogleCloudDiscoveryengineV1alphaCustomAttribute {
163
103
  /**
164
104
  * The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT
@@ -187,7 +127,7 @@ declare namespace gapi.client {
187
127
  * length limit of 63 characters.
188
128
  */
189
129
  parentDocumentId?: string;
190
- /** Required. The identifier of the schema located in the same data store. */
130
+ /** The identifier of the schema located in the same data store. */
191
131
  schemaId?: string;
192
132
  /** The structured JSON data for the document. It should conform to the registered schema or an INVALID_ARGUMENT error is thrown. */
193
133
  structData?: { [P in string]: any };
@@ -210,13 +150,15 @@ declare namespace gapi.client {
210
150
  }
211
151
  interface GoogleCloudDiscoveryengineV1alphaGcsSource {
212
152
  /**
213
- * The schema to use when parsing the data from the source. Supported values for imports: * `user_event` (default): One JSON UserEvent per line. * `document` (default): One JSON
214
- * Document per line. Each document must have a valid Document.id.
153
+ * The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid
154
+ * Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` will become a document, with the ID set to the first 128 bits of SHA256(URI) encoded
155
+ * as a hex string. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
215
156
  */
216
157
  dataSchema?: string;
217
158
  /**
218
159
  * Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a
219
- * pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB.
160
+ * pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can
161
+ * be up to 2 GB (or 100 MB if `data_schema` is `content`).
220
162
  */
221
163
  inputUris?: string[];
222
164
  }
@@ -407,6 +349,17 @@ declare namespace gapi.client {
407
349
  /** Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. */
408
350
  metadata?: { [P in string]: any };
409
351
  }
352
+ interface GoogleCloudDiscoveryengineV1alphaSchema {
353
+ /** The JSON representation of the schema. */
354
+ jsonSchema?: string;
355
+ /**
356
+ * Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This
357
+ * field must be a UTF-8 encoded string with a length limit of 1024 characters.
358
+ */
359
+ name?: string;
360
+ /** The structured representation of the schema. */
361
+ structSchema?: { [P in string]: any };
362
+ }
410
363
  interface GoogleCloudDiscoveryengineV1alphaSearchInfo {
411
364
  /**
412
365
  * An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for
@@ -589,6 +542,17 @@ declare namespace gapi.client {
589
542
  /** Count of user events imported, but with Document information not found in the existing Branch. */
590
543
  unjoinedEventsCount?: string;
591
544
  }
545
+ interface GoogleCloudDiscoveryengineV1betaSchema {
546
+ /** The JSON representation of the schema. */
547
+ jsonSchema?: string;
548
+ /**
549
+ * Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This
550
+ * field must be a UTF-8 encoded string with a length limit of 1024 characters.
551
+ */
552
+ name?: string;
553
+ /** The structured representation of the schema. */
554
+ structSchema?: { [P in string]: any };
555
+ }
592
556
  interface GoogleLongrunningListOperationsResponse {
593
557
  /** The standard List next-page token. */
594
558
  nextPageToken?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
3
- "version": "0.0.20230306",
3
+ "version": "0.0.20230322",
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: 20230306
6
+ // Revision: 20230322
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */