Skip to main content

UpdateDescriptorSet

Updates existing descriptor set objects that satisfy the specified constraints.

Parameters​

  • [optional] ref: Reference to other sets within the transaction.
  • [optional] constraints
  • [optional] properties
  • [optional] remove_props
  • [optional] with_name: Name of the set.
  • [optional] engine: Specifies the implementation for indexing and computing distances.
  • [optional] metric: Specifies the metric used to calculate distances.
  • [optional] build_index: Triggers rebuilding of the search index (Default: false).

Details​

If the ref parameter is used, constraints will be ignored.

If the ref parameter is specified, it must refer to the search results of a previous FindDescriptorSet.

The with_name parameter specifies the "name" of the DescriptorSet and is guaranteed to be unique.

For more complex searches for objects to update, a Find command must be used first within the transaction.

Examples​

Find the descriptor sets with the "source" property equal to "open_face", and remove the "valid" property:


    [{
        "UpdateDescriptorSet": {
            "constraints": {
                "source": ["==", "open_face"]
            },
            "remove_props": ["valid"]
        }
    }]

Successful response:


    [{
        "UpdateDescriptorSet": {
            "count": 1,
            "status": 0
        }
    }]

Update the "valid" property of all the descriptor sets that are connected to an entity of the class "Dataset" with a property "name" equal to "Youtube":


    [{
        "FindEntity": {
            "with_class": "Dataset",
            "_ref": 1,
            "constraints": {
                "name": ["==", "Youtube"]
            }
        }
    }, {
        "FindDescriptorSet": {
            "_ref": 2,
            "is_connected_to": {
                "ref": 1,
                "connection_class": "in_dataset"
            }
        }
    }, {
        "UpdateDescriptorSet": {
            "ref": 2,
            "properties": {
                "valid": true
            }
        }
    }]

Successful response:


    [{
        "FindEntity": {
            "returned": 0,
            "status": 0
        }
    }, {
        "FindDescriptorSet": {
            "returned": 0,
            "status": 0
        }
    }, {
        "UpdateDescriptorSet": {
            "count": 1,
            "status": 0
        }
    }]