@or-sdk/lookup 1.4.0-beta.2172.0 → 1.4.0-beta.2177.0
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/README.md +4 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -266,6 +266,7 @@ Add a custom property to an existing collection. Custom properties can be used t
|
|
|
266
266
|
- `name` (string): The name of the property, e.g. `nameOfTheAuthor`. Name should not include any space.
|
|
267
267
|
- `dataType` (string): The data type of the property. See https://weaviate.io/developers/weaviate/config-refs/schema#datatypes for the available types
|
|
268
268
|
- `description` (string, optional): An optional description of the property.
|
|
269
|
+
- `vectorize` (boolean, optional): Whether the property should be vectorized. Default is false. It will use the default vectorization method for the data type.
|
|
269
270
|
|
|
270
271
|
#### Example
|
|
271
272
|
```typescript
|
|
@@ -274,6 +275,7 @@ const property = {
|
|
|
274
275
|
name: 'author',
|
|
275
276
|
dataType: 'string',
|
|
276
277
|
description: 'Author of the document',
|
|
278
|
+
vectorize: true,
|
|
277
279
|
};
|
|
278
280
|
|
|
279
281
|
await lookup.addProperty(collectionId, property);
|
|
@@ -298,6 +300,7 @@ const collection = await lookup.getCollection(collectionId);
|
|
|
298
300
|
name: 'author',
|
|
299
301
|
dataType: 'string',
|
|
300
302
|
description: 'Author of the document',
|
|
303
|
+
vectorize: true,
|
|
301
304
|
},
|
|
302
305
|
],
|
|
303
306
|
}
|
|
@@ -1021,4 +1024,4 @@ const restore = {
|
|
|
1021
1024
|
|
|
1022
1025
|
await sdk.restoreCollection(collectionId, restore);
|
|
1023
1026
|
// No direct response, the collection restore up is started
|
|
1024
|
-
```
|
|
1027
|
+
```
|