376 lines
20 KiB
JSON
376 lines
20 KiB
JSON
{
|
|
"name": "UpdateDataObject",
|
|
"fully_qualified_name": "WeaviateApi.UpdateDataObject@0.1.0",
|
|
"description": "Update specific properties of a data object.\n\nThis tool updates properties of an existing object in a specified collection using JSON merge patch semantics. The object is identified by its collection name and UUID. Use this to modify selected fields of a data object while ensuring validation and timestamp updates.",
|
|
"toolkit": {
|
|
"name": "ArcadeWeaviateApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "collection_name",
|
|
"required": true,
|
|
"description": "Specifies the name of the collection or class the object belongs to. This identifies where the object is stored.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Name of the collection (class) the object belongs to."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "className"
|
|
},
|
|
{
|
|
"name": "object_uuid",
|
|
"required": true,
|
|
"description": "Unique UUID of the object to be patched within the specified collection.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Unique UUID of the object to be patched."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "id"
|
|
},
|
|
{
|
|
"name": "consistency_level",
|
|
"required": false,
|
|
"description": "Specify the number of replicas that must acknowledge the request for success.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Determines how many replicas must acknowledge a request before it is considered successful."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "consistency_level"
|
|
},
|
|
{
|
|
"name": "merge_patch_update",
|
|
"required": false,
|
|
"description": "RFC 7396-style JSON object specifying fields to update in the data object, including optional properties like `class`, `vectorWeights`, `properties`, and `vectors`.",
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"class": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Name of the collection (class) the object belongs to."
|
|
},
|
|
"vectorWeights": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Allow custom overrides of vector weights as math expressions. E.g. `pancake`: `7` will set the weight for the word pancake to 7 in the vectorization, whereas `w * 3` would triple the originally calculated word. This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value (string/string) object."
|
|
},
|
|
"properties": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection."
|
|
},
|
|
"id": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The UUID of the object."
|
|
},
|
|
"creationTimeUnix": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "(Response only) Timestamp of creation of this object in milliseconds since epoch UTC."
|
|
},
|
|
"lastUpdateTimeUnix": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "(Response only) Timestamp of the last object update in milliseconds since epoch UTC."
|
|
},
|
|
"vector": {
|
|
"val_type": "array",
|
|
"inner_val_type": "number",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A vector representation of the object in the Contextionary. If provided at object creation, this wil take precedence over any vectorizer setting."
|
|
},
|
|
"vectors": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A map of named vectors for multi-vector representations."
|
|
},
|
|
"tenant": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The name of the tenant the object belongs to."
|
|
},
|
|
"additional": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "(Response only) Additional meta information about a single object."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "RFC 7396-style JSON merge patch object containing the fields to update."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "requestBody"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'objects.class.patch'.",
|
|
"available_modes": [
|
|
"value",
|
|
"error",
|
|
"null"
|
|
],
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
}
|
|
},
|
|
"requirements": {
|
|
"authorization": null,
|
|
"secrets": [
|
|
{
|
|
"key": "WEAVIATE_API_KEY"
|
|
},
|
|
{
|
|
"key": "WEAVIATE_SERVER_URL"
|
|
}
|
|
],
|
|
"metadata": null
|
|
},
|
|
"deprecation_message": null,
|
|
"metadata": {
|
|
"object_type": "api_wrapper_tool",
|
|
"version": "1.1.0",
|
|
"description": "Tools that enable LLMs to interact directly with the weaviate API."
|
|
},
|
|
"http_endpoint": {
|
|
"metadata": {
|
|
"object_type": "http_endpoint",
|
|
"version": "1.2.0",
|
|
"description": ""
|
|
},
|
|
"url": "{weaviate_server_url}/v1/objects/{className}/{id}",
|
|
"http_method": "PATCH",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "consistency_level",
|
|
"tool_parameter_name": "consistency_level",
|
|
"description": "Determines how many replicas must acknowledge a request before it is considered successful.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Determines how many replicas must acknowledge a request before it is considered successful."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "className",
|
|
"tool_parameter_name": "collection_name",
|
|
"description": "Name of the collection (class) the object belongs to.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Name of the collection (class) the object belongs to."
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "id",
|
|
"tool_parameter_name": "object_uuid",
|
|
"description": "Unique UUID of the object to be patched.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Unique UUID of the object to be patched."
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "requestBody",
|
|
"tool_parameter_name": "merge_patch_update",
|
|
"description": "RFC 7396-style JSON merge patch object containing the fields to update.",
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"class": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Name of the collection (class) the object belongs to."
|
|
},
|
|
"vectorWeights": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Allow custom overrides of vector weights as math expressions. E.g. `pancake`: `7` will set the weight for the word pancake to 7 in the vectorization, whereas `w * 3` would triple the originally calculated word. This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value (string/string) object."
|
|
},
|
|
"properties": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection."
|
|
},
|
|
"id": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The UUID of the object."
|
|
},
|
|
"creationTimeUnix": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "(Response only) Timestamp of creation of this object in milliseconds since epoch UTC."
|
|
},
|
|
"lastUpdateTimeUnix": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "(Response only) Timestamp of the last object update in milliseconds since epoch UTC."
|
|
},
|
|
"vector": {
|
|
"val_type": "array",
|
|
"inner_val_type": "number",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A vector representation of the object in the Contextionary. If provided at object creation, this wil take precedence over any vectorizer setting."
|
|
},
|
|
"vectors": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A map of named vectors for multi-vector representations."
|
|
},
|
|
"tenant": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The name of the tenant the object belongs to."
|
|
},
|
|
"additional": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "(Response only) Additional meta information about a single object."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "RFC 7396-style JSON merge patch object containing the fields to update."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
}
|
|
],
|
|
"documentation_urls": [],
|
|
"secrets": [
|
|
{
|
|
"arcade_key": "WEAVIATE_API_KEY",
|
|
"parameter_name": "Authorization",
|
|
"accepted_as": "header",
|
|
"formatted_value": "Bearer {authorization}",
|
|
"description": "",
|
|
"is_auth_token": false
|
|
},
|
|
{
|
|
"arcade_key": "WEAVIATE_SERVER_URL",
|
|
"parameter_name": "weaviate_server_url",
|
|
"accepted_as": "path",
|
|
"formatted_value": null,
|
|
"description": "",
|
|
"is_auth_token": false
|
|
}
|
|
],
|
|
"request_body_spec": "{\n \"description\": \"RFC 7396-style JSON merge patch object containing the fields to update.\",\n \"content\": {\n \"application/yaml\": {\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"class\": {\n \"type\": \"string\",\n \"description\": \"Name of the collection (class) the object belongs to.\"\n },\n \"vectorWeights\": {\n \"type\": \"object\",\n \"description\": \"Allow custom overrides of vector weights as math expressions. E.g. `pancake`: `7` will set the weight for the word pancake to 7 in the vectorization, whereas `w * 3` would triple the originally calculated word. This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value (string/string) object.\"\n },\n \"properties\": {\n \"type\": \"object\",\n \"description\": \"Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection.\"\n },\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The UUID of the object.\",\n \"format\": \"uuid\"\n },\n \"creationTimeUnix\": {\n \"type\": \"integer\",\n \"description\": \"(Response only) Timestamp of creation of this object in milliseconds since epoch UTC.\",\n \"format\": \"int64\"\n },\n \"lastUpdateTimeUnix\": {\n \"type\": \"integer\",\n \"description\": \"(Response only) Timestamp of the last object update in milliseconds since epoch UTC.\",\n \"format\": \"int64\"\n },\n \"vector\": {\n \"type\": \"array\",\n \"description\": \"A vector representation of the object in the Contextionary. If provided at object creation, this wil take precedence over any vectorizer setting.\",\n \"items\": {\n \"type\": \"number\",\n \"format\": \"float\"\n }\n },\n \"vectors\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"object\",\n \"description\": \"A vector representation of the object. If provided at object creation, this wil take precedence over any vectorizer setting.\"\n },\n \"description\": \"A map of named vectors for multi-vector representations.\"\n },\n \"tenant\": {\n \"type\": \"string\",\n \"description\": \"The name of the tenant the object belongs to.\"\n },\n \"additional\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"object\",\n \"properties\": {}\n },\n \"description\": \"(Response only) Additional meta information about a single object.\"\n }\n }\n }\n },\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"class\": {\n \"type\": \"string\",\n \"description\": \"Name of the collection (class) the object belongs to.\"\n },\n \"vectorWeights\": {\n \"type\": \"object\",\n \"description\": \"Allow custom overrides of vector weights as math expressions. E.g. `pancake`: `7` will set the weight for the word pancake to 7 in the vectorization, whereas `w * 3` would triple the originally calculated word. This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value (string/string) object.\"\n },\n \"properties\": {\n \"type\": \"object\",\n \"description\": \"Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection.\"\n },\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The UUID of the object.\",\n \"format\": \"uuid\"\n },\n \"creationTimeUnix\": {\n \"type\": \"integer\",\n \"description\": \"(Response only) Timestamp of creation of this object in milliseconds since epoch UTC.\",\n \"format\": \"int64\"\n },\n \"lastUpdateTimeUnix\": {\n \"type\": \"integer\",\n \"description\": \"(Response only) Timestamp of the last object update in milliseconds since epoch UTC.\",\n \"format\": \"int64\"\n },\n \"vector\": {\n \"type\": \"array\",\n \"description\": \"A vector representation of the object in the Contextionary. If provided at object creation, this wil take precedence over any vectorizer setting.\",\n \"items\": {\n \"type\": \"number\",\n \"format\": \"float\"\n }\n },\n \"vectors\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"object\",\n \"description\": \"A vector representation of the object. If provided at object creation, this wil take precedence over any vectorizer setting.\"\n },\n \"description\": \"A map of named vectors for multi-vector representations.\"\n },\n \"tenant\": {\n \"type\": \"string\",\n \"description\": \"The name of the tenant the object belongs to.\"\n },\n \"additional\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"object\",\n \"properties\": {}\n },\n \"description\": \"(Response only) Additional meta information about a single object.\"\n }\n }\n }\n }\n },\n \"required\": false\n}",
|
|
"use_request_body_schema_mode": true,
|
|
"validate_request_body_schema": true
|
|
}
|
|
}
|