@maxim_mazurok/gapi.client.datastore-v1beta3 0.0.20241002 → 0.0.20241018

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 (2) hide show
  1. package/index.d.ts +39 -1
  2. package/package.json +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://datastore.googleapis.com/$discovery/rest?version=v1beta3
12
- // Revision: 20241002
12
+ // Revision: 20241018
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -150,6 +150,20 @@ declare namespace gapi.client {
150
150
  /** A filter on a property. */
151
151
  propertyFilter?: PropertyFilter;
152
152
  }
153
+ interface FindNearest {
154
+ /** Required. The Distance Measure to use, required. */
155
+ distanceMeasure?: string;
156
+ /** Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations. */
157
+ distanceResultProperty?: string;
158
+ /** Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold */
159
+ distanceThreshold?: number;
160
+ /** Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100. */
161
+ limit?: number;
162
+ /** Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. */
163
+ queryVector?: Value;
164
+ /** Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. */
165
+ vectorProperty?: PropertyReference;
166
+ }
153
167
  interface GoogleDatastoreAdminV1beta1CommonMetadata {
154
168
  /** The time the operation ended, either successfully or otherwise. */
155
169
  endTime?: string;
@@ -341,12 +355,16 @@ declare namespace gapi.client {
341
355
  interface Mutation {
342
356
  /** The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts. */
343
357
  baseVersion?: string;
358
+ /** The strategy to use when a conflict is detected. Defaults to `SERVER_VALUE`. If this is set, then `conflict_detection_strategy` must also be set. */
359
+ conflictResolutionStrategy?: string;
344
360
  /** The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only. */
345
361
  delete?: Key;
346
362
  /** The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete. */
347
363
  insert?: Entity;
348
364
  /** The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for `__key__`. This field is ignored for `delete`. If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted. */
349
365
  propertyMask?: PropertyMask;
366
+ /** Optional. The transforms to perform on the entity. This field can be set only when the operation is `insert`, `update`, or `upsert`. If present, the transforms are be applied to the entity regardless of the property mask, in order, after the operation. */
367
+ propertyTransforms?: PropertyTransform[];
350
368
  /** The entity to update. The entity must already exist. Must have a complete key path. */
351
369
  update?: Entity;
352
370
  /** The update time of the entity that this mutation is being applied to. If this does not match the current update time on the server, the mutation conflicts. */
@@ -361,6 +379,8 @@ declare namespace gapi.client {
361
379
  createTime?: string;
362
380
  /** The automatically allocated key. Set only when the mutation allocated a key. */
363
381
  key?: Key;
382
+ /** The results of applying each PropertyTransform, in the same order of the request. */
383
+ transformResults?: Value[];
364
384
  /** The update time of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the timestamp will be the update timestamp of the current entity. This field will not be set after a 'delete'. */
365
385
  updateTime?: string;
366
386
  /** The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity. */
@@ -410,6 +430,22 @@ declare namespace gapi.client {
410
430
  /** A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations. */
411
431
  name?: string;
412
432
  }
433
+ interface PropertyTransform {
434
+ /** Appends the given elements in order if they are not already present in the current property value. If the property is not an array, or if the property does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and the null value is equal to the null value. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform result will be the null value. */
435
+ appendMissingElements?: ArrayValue;
436
+ /** Adds the given value to the property's current value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If either of the given value or the current property value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follows IEEE 754 semantics. If there is positive/negative integer overflow, the property is resolved to the largest magnitude positive/negative integer. */
437
+ increment?: Value;
438
+ /** Sets the property to the maximum of its current value and the given value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If a maximum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. */
439
+ maximum?: Value;
440
+ /** Sets the property to the minimum of its current value and the given value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the input value. If a minimum operation is applied where the property and the input value are of mixed types (that is - one is an integer and one is a double) the property takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the property does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. */
441
+ minimum?: Value;
442
+ /** Optional. The name of the property. Property paths (a list of property names separated by dots (`.`)) may be used to refer to properties inside entity values. For example `foo.bar` means the property `bar` inside the entity property `foo`. If a property name contains a dot `.` or a backlslash `\`, then that name must be escaped. */
443
+ property?: string;
444
+ /** Removes all of the given elements from the array in the property. If the property is not an array, or if the property does not yet exist, it is set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and the null value is equal to the null value. This will remove all equivalent values if there are duplicates. The corresponding transform result will be the null value. */
445
+ removeAllFromArray?: ArrayValue;
446
+ /** Sets the property to the given server value. */
447
+ setToServerValue?: string;
448
+ }
413
449
  interface Query {
414
450
  /** The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`. */
415
451
  distinctOn?: PropertyReference[];
@@ -417,6 +453,8 @@ declare namespace gapi.client {
417
453
  endCursor?: string;
418
454
  /** The filter to apply. */
419
455
  filter?: Filter;
456
+ /** Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. */
457
+ findNearest?: FindNearest;
420
458
  /** The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified. */
421
459
  kind?: KindExpression[];
422
460
  /** The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.datastore-v1beta3",
3
- "version": "0.0.20241002",
3
+ "version": "0.0.20241018",
4
4
  "description": "TypeScript typings for Cloud Datastore API v1beta3",
5
5
  "repository": {
6
6
  "type": "git",