|
530 | 530 | "operations": {
|
531 | 531 | "methods": {
|
532 | 532 | "cancel": {
|
533 |
| - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", |
| 533 | + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", |
534 | 534 | "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
|
535 | 535 | "httpMethod": "POST",
|
536 | 536 | "id": "datastore.projects.operations.cancel",
|
|
654 | 654 | }
|
655 | 655 | }
|
656 | 656 | },
|
657 |
| - "revision": "20240317", |
| 657 | + "revision": "20241204", |
658 | 658 | "rootUrl": "https://datastore.googleapis.com/",
|
659 | 659 | "schemas": {
|
660 | 660 | "Aggregation": {
|
|
1064 | 1064 | },
|
1065 | 1065 | "type": "object"
|
1066 | 1066 | },
|
| 1067 | + "FindNearest": { |
| 1068 | + "description": "Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.", |
| 1069 | + "id": "FindNearest", |
| 1070 | + "properties": { |
| 1071 | + "distanceMeasure": { |
| 1072 | + "description": "Required. The Distance Measure to use, required.", |
| 1073 | + "enum": [ |
| 1074 | + "DISTANCE_MEASURE_UNSPECIFIED", |
| 1075 | + "EUCLIDEAN", |
| 1076 | + "COSINE", |
| 1077 | + "DOT_PRODUCT" |
| 1078 | + ], |
| 1079 | + "enumDescriptions": [ |
| 1080 | + "Should not be set.", |
| 1081 | + "Measures the EUCLIDEAN distance between the vectors. See [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn more. The resulting distance decreases the more similar two vectors are.", |
| 1082 | + "COSINE distance compares vectors based on the angle between them, which allows you to measure similarity that isn't based on the vectors magnitude. We recommend using DOT_PRODUCT with unit normalized vectors instead of COSINE distance, which is mathematically equivalent with better performance. See [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn more about COSINE similarity and COSINE distance. The resulting COSINE distance decreases the more similar two vectors are.", |
| 1083 | + "Similar to cosine but is affected by the magnitude of the vectors. See [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to learn more. The resulting distance increases the more similar two vectors are." |
| 1084 | + ], |
| 1085 | + "type": "string" |
| 1086 | + }, |
| 1087 | + "distanceResultProperty": { |
| 1088 | + "description": "Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations.", |
| 1089 | + "type": "string" |
| 1090 | + }, |
| 1091 | + "distanceThreshold": { |
| 1092 | + "description": "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", |
| 1093 | + "format": "double", |
| 1094 | + "type": "number" |
| 1095 | + }, |
| 1096 | + "limit": { |
| 1097 | + "description": "Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100.", |
| 1098 | + "format": "int32", |
| 1099 | + "type": "integer" |
| 1100 | + }, |
| 1101 | + "queryVector": { |
| 1102 | + "$ref": "Value", |
| 1103 | + "description": "Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions." |
| 1104 | + }, |
| 1105 | + "vectorProperty": { |
| 1106 | + "$ref": "PropertyReference", |
| 1107 | + "description": "Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned." |
| 1108 | + } |
| 1109 | + }, |
| 1110 | + "type": "object" |
| 1111 | + }, |
1067 | 1112 | "GoogleDatastoreAdminV1CommonMetadata": {
|
1068 | 1113 | "description": "Metadata common to all Datastore Admin operations.",
|
1069 | 1114 | "id": "GoogleDatastoreAdminV1CommonMetadata",
|
|
1937 | 1982 | "format": "int64",
|
1938 | 1983 | "type": "string"
|
1939 | 1984 | },
|
| 1985 | + "conflictResolutionStrategy": { |
| 1986 | + "description": "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.", |
| 1987 | + "enum": [ |
| 1988 | + "STRATEGY_UNSPECIFIED", |
| 1989 | + "SERVER_VALUE", |
| 1990 | + "FAIL" |
| 1991 | + ], |
| 1992 | + "enumDescriptions": [ |
| 1993 | + "Unspecified. Defaults to `SERVER_VALUE`.", |
| 1994 | + "The server entity is kept.", |
| 1995 | + "The whole commit request fails." |
| 1996 | + ], |
| 1997 | + "type": "string" |
| 1998 | + }, |
1940 | 1999 | "delete": {
|
1941 | 2000 | "$ref": "Key",
|
1942 | 2001 | "description": "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."
|
|
1949 | 2008 | "$ref": "PropertyMask",
|
1950 | 2009 | "description": "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."
|
1951 | 2010 | },
|
| 2011 | + "propertyTransforms": { |
| 2012 | + "description": "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.", |
| 2013 | + "items": { |
| 2014 | + "$ref": "PropertyTransform" |
| 2015 | + }, |
| 2016 | + "type": "array" |
| 2017 | + }, |
1952 | 2018 | "update": {
|
1953 | 2019 | "$ref": "Entity",
|
1954 | 2020 | "description": "The entity to update. The entity must already exist. Must have a complete key path."
|
|
1982 | 2048 | "$ref": "Key",
|
1983 | 2049 | "description": "The automatically allocated key. Set only when the mutation allocated a key."
|
1984 | 2050 | },
|
| 2051 | + "transformResults": { |
| 2052 | + "description": "The results of applying each PropertyTransform, in the same order of the request.", |
| 2053 | + "items": { |
| 2054 | + "$ref": "Value" |
| 2055 | + }, |
| 2056 | + "type": "array" |
| 2057 | + }, |
1985 | 2058 | "updateTime": {
|
1986 | 2059 | "description": "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'.",
|
1987 | 2060 | "format": "google-datetime",
|
|
2156 | 2229 | },
|
2157 | 2230 | "type": "object"
|
2158 | 2231 | },
|
| 2232 | + "PropertyTransform": { |
| 2233 | + "description": "A transformation of an entity property.", |
| 2234 | + "id": "PropertyTransform", |
| 2235 | + "properties": { |
| 2236 | + "appendMissingElements": { |
| 2237 | + "$ref": "ArrayValue", |
| 2238 | + "description": "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." |
| 2239 | + }, |
| 2240 | + "increment": { |
| 2241 | + "$ref": "Value", |
| 2242 | + "description": "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." |
| 2243 | + }, |
| 2244 | + "maximum": { |
| 2245 | + "$ref": "Value", |
| 2246 | + "description": "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." |
| 2247 | + }, |
| 2248 | + "minimum": { |
| 2249 | + "$ref": "Value", |
| 2250 | + "description": "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." |
| 2251 | + }, |
| 2252 | + "property": { |
| 2253 | + "description": "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.", |
| 2254 | + "type": "string" |
| 2255 | + }, |
| 2256 | + "removeAllFromArray": { |
| 2257 | + "$ref": "ArrayValue", |
| 2258 | + "description": "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." |
| 2259 | + }, |
| 2260 | + "setToServerValue": { |
| 2261 | + "description": "Sets the property to the given server value.", |
| 2262 | + "enum": [ |
| 2263 | + "SERVER_VALUE_UNSPECIFIED", |
| 2264 | + "REQUEST_TIME" |
| 2265 | + ], |
| 2266 | + "enumDescriptions": [ |
| 2267 | + "Unspecified. This value must not be used.", |
| 2268 | + "The time at which the server processed the request, with millisecond precision. If used on multiple properties (same or different entities) in a transaction, all the properties will get the same server timestamp." |
| 2269 | + ], |
| 2270 | + "type": "string" |
| 2271 | + } |
| 2272 | + }, |
| 2273 | + "type": "object" |
| 2274 | + }, |
2159 | 2275 | "Query": {
|
2160 |
| - "description": "A query for entities.", |
| 2276 | + "description": "A query for entities. The query stages are executed in the following order: 1. kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6. limit 7. find_nearest", |
2161 | 2277 | "id": "Query",
|
2162 | 2278 | "properties": {
|
2163 | 2279 | "distinctOn": {
|
|
2176 | 2292 | "$ref": "Filter",
|
2177 | 2293 | "description": "The filter to apply."
|
2178 | 2294 | },
|
| 2295 | + "findNearest": { |
| 2296 | + "$ref": "FindNearest", |
| 2297 | + "description": "Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector." |
| 2298 | + }, |
2179 | 2299 | "kind": {
|
2180 | 2300 | "description": "The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.",
|
2181 | 2301 | "items": {
|
|
0 commit comments