@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20230310 → 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.
- package/index.d.ts +29 -67
- package/package.json +1 -1
- 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=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20230322
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -72,67 +72,6 @@ declare namespace gapi.client {
|
|
|
72
72
|
/** Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. */
|
|
73
73
|
functionName?: string;
|
|
74
74
|
}
|
|
75
|
-
interface GoogleCloudDiscoveryengineV1alphaCondition {
|
|
76
|
-
/** Optional. Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
77
|
-
activeTimeRange?: GoogleCloudDiscoveryengineV1alphaConditionTimeRange[];
|
|
78
|
-
/** Optional. Search only A list of terms to match the query on. Maximum of 10 query terms. */
|
|
79
|
-
queryTerms?: GoogleCloudDiscoveryengineV1alphaConditionQueryTerm[];
|
|
80
|
-
}
|
|
81
|
-
interface GoogleCloudDiscoveryengineV1alphaConditionQueryTerm {
|
|
82
|
-
/** Whether the search query needs to exactly match the query term. */
|
|
83
|
-
fullMatch?: boolean;
|
|
84
|
-
/**
|
|
85
|
-
* 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
|
|
86
|
-
* of 5000 characters.
|
|
87
|
-
*/
|
|
88
|
-
value?: string;
|
|
89
|
-
}
|
|
90
|
-
interface GoogleCloudDiscoveryengineV1alphaConditionTimeRange {
|
|
91
|
-
/** End of time range. Range is inclusive. Must be in the future. */
|
|
92
|
-
endTime?: string;
|
|
93
|
-
/** Start of time range. Range is inclusive. */
|
|
94
|
-
startTime?: string;
|
|
95
|
-
}
|
|
96
|
-
interface GoogleCloudDiscoveryengineV1alphaControl {
|
|
97
|
-
/** Output only. List of all [ServingConfig] ids this control is attached to. May take up to 10 minutes to update after changes. */
|
|
98
|
-
associatedServingConfigIds?: string[];
|
|
99
|
-
/** Defines a boost-type control */
|
|
100
|
-
boostAction?: GoogleCloudDiscoveryengineV1alphaControlBoostAction;
|
|
101
|
-
/**
|
|
102
|
-
* 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
|
|
103
|
-
* thrown.
|
|
104
|
-
*/
|
|
105
|
-
conditions?: GoogleCloudDiscoveryengineV1alphaCondition[];
|
|
106
|
-
/** 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. */
|
|
107
|
-
displayName?: string;
|
|
108
|
-
/** Defines a filter-type control Currently not supported by Recommendation */
|
|
109
|
-
filterAction?: GoogleCloudDiscoveryengineV1alphaControlFilterAction;
|
|
110
|
-
/** Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` */
|
|
111
|
-
name?: string;
|
|
112
|
-
/** Required. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */
|
|
113
|
-
solutionType?: string;
|
|
114
|
-
/**
|
|
115
|
-
* 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
|
|
116
|
-
* when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.
|
|
117
|
-
*/
|
|
118
|
-
useCases?: string[];
|
|
119
|
-
}
|
|
120
|
-
interface GoogleCloudDiscoveryengineV1alphaControlBoostAction {
|
|
121
|
-
/** Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */
|
|
122
|
-
boost?: number;
|
|
123
|
-
/**
|
|
124
|
-
* Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation:
|
|
125
|
-
* https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
|
|
126
|
-
*/
|
|
127
|
-
filter?: string;
|
|
128
|
-
}
|
|
129
|
-
interface GoogleCloudDiscoveryengineV1alphaControlFilterAction {
|
|
130
|
-
/**
|
|
131
|
-
* 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
|
|
132
|
-
* characters. Otherwise an INVALID ARGUMENT error is thrown.
|
|
133
|
-
*/
|
|
134
|
-
filter?: string;
|
|
135
|
-
}
|
|
136
75
|
interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
|
|
137
76
|
/** Operation create time. */
|
|
138
77
|
createTime?: string;
|
|
@@ -176,10 +115,22 @@ declare namespace gapi.client {
|
|
|
176
115
|
/** Count of user events imported, but with Document information not found in the existing Branch. */
|
|
177
116
|
unjoinedEventsCount?: string;
|
|
178
117
|
}
|
|
118
|
+
interface GoogleCloudDiscoveryengineV1alphaSchema {
|
|
119
|
+
/** The JSON representation of the schema. */
|
|
120
|
+
jsonSchema?: string;
|
|
121
|
+
/**
|
|
122
|
+
* Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This
|
|
123
|
+
* field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
124
|
+
*/
|
|
125
|
+
name?: string;
|
|
126
|
+
/** The structured representation of the schema. */
|
|
127
|
+
structSchema?: { [P in string]: any };
|
|
128
|
+
}
|
|
179
129
|
interface GoogleCloudDiscoveryengineV1betaBigQuerySource {
|
|
180
130
|
/**
|
|
181
|
-
* The schema to use when parsing the data from the source. Supported values for imports: * `user_event` (default): One
|
|
182
|
-
* Document per
|
|
131
|
+
* 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
|
|
132
|
+
* 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
|
|
133
|
+
* 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.
|
|
183
134
|
*/
|
|
184
135
|
dataSchema?: string;
|
|
185
136
|
/** Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. */
|
|
@@ -230,7 +181,7 @@ declare namespace gapi.client {
|
|
|
230
181
|
* length limit of 63 characters.
|
|
231
182
|
*/
|
|
232
183
|
parentDocumentId?: string;
|
|
233
|
-
/**
|
|
184
|
+
/** The identifier of the schema located in the same data store. */
|
|
234
185
|
schemaId?: string;
|
|
235
186
|
/** The structured JSON data for the document. It should conform to the registered schema or an INVALID_ARGUMENT error is thrown. */
|
|
236
187
|
structData?: { [P in string]: any };
|
|
@@ -260,8 +211,8 @@ declare namespace gapi.client {
|
|
|
260
211
|
dataSchema?: string;
|
|
261
212
|
/**
|
|
262
213
|
* 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
|
|
263
|
-
* pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files or
|
|
264
|
-
*
|
|
214
|
+
* 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
|
|
215
|
+
* be up to 2 GB (or 100 MB if `data_schema` is `content`).
|
|
265
216
|
*/
|
|
266
217
|
inputUris?: string[];
|
|
267
218
|
}
|
|
@@ -452,6 +403,17 @@ declare namespace gapi.client {
|
|
|
452
403
|
/** Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. */
|
|
453
404
|
metadata?: { [P in string]: any };
|
|
454
405
|
}
|
|
406
|
+
interface GoogleCloudDiscoveryengineV1betaSchema {
|
|
407
|
+
/** The JSON representation of the schema. */
|
|
408
|
+
jsonSchema?: string;
|
|
409
|
+
/**
|
|
410
|
+
* Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This
|
|
411
|
+
* field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
412
|
+
*/
|
|
413
|
+
name?: string;
|
|
414
|
+
/** The structured representation of the schema. */
|
|
415
|
+
structSchema?: { [P in string]: any };
|
|
416
|
+
}
|
|
455
417
|
interface GoogleCloudDiscoveryengineV1betaSearchInfo {
|
|
456
418
|
/**
|
|
457
419
|
* 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
|
package/package.json
CHANGED
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:
|
|
6
|
+
// Revision: 20230322
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|