arcade-mcp/toolkits/weaviate_api/arcade_weaviate_api/wrapper_tools/ReplaceObjectReferences.json
jottakka 6bba3284a4
[MOAR][Weaviate] Weaviate Starter Toolkits (#639)
Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-21 15:50:26 -03:00

524 lines
30 KiB
JSON

{
"name": "ReplaceObjectReferences",
"fully_qualified_name": "WeaviateApi.ReplaceObjectReferences@0.1.0",
"description": "Replace existing references for an object in Weaviate.\n\nUse this tool to replace all current references of a specific property for an object in Weaviate. Specify the object's collection name, UUID, and the reference property to update. Useful for updating linked data within a dataset.",
"toolkit": {
"name": "ArcadeWeaviateApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "collection_name",
"required": true,
"description": "Name of the collection the source 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 source object belongs to."
},
"inferrable": true,
"http_endpoint_parameter_name": "className"
},
{
"name": "source_object_uuid",
"required": true,
"description": "Unique UUID of the source object to identify it for reference replacement.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique UUID of the source object."
},
"inferrable": true,
"http_endpoint_parameter_name": "id"
},
{
"name": "reference_property_name",
"required": true,
"description": "Unique name of the reference property for the source object to update.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique name of the reference property of the source object."
},
"inferrable": true,
"http_endpoint_parameter_name": "propertyName"
},
{
"name": "new_references_list",
"required": true,
"description": "An array of JSON objects representing the new list of references for the object. Each object should specify details such as class name, direct or concept references, and any classification metadata.",
"value_schema": {
"val_type": "array",
"inner_val_type": "json",
"enum": null,
"properties": null,
"inner_properties": {
"class": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "If using a concept reference (rather than a direct reference), specify the desired collection (class) name here."
},
"schema": {
"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."
},
"beacon": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "If using a direct reference, specify the URI to point to the cross-reference here. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-reference to an object"
},
"href": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "If using a direct reference, this read-only fields provides a link to the referenced resource. If 'origin' is globally configured, an absolute URI is shown - a relative URI otherwise."
},
"classification": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"overallCount": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "overall neighbors checked as part of the classification. In most cases this will equal k, but could be lower than k - for example if not enough data was present"
},
"winningCount": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "size of the winning group, a number between 1..k"
},
"losingCount": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "size of the losing group, can be 0 if the winning group size equals k"
},
"closestOverallDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The lowest distance of any neighbor, regardless of whether they were in the winning or losing group"
},
"winningDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "deprecated - do not use, to be removed in 0.23.0"
},
"meanWinningDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Mean distance of all neighbors from the winning group"
},
"closestWinningDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Closest distance of a neighbor from the winning group"
},
"closestLosingDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The lowest distance of a neighbor in the losing group. Optional. If k equals the size of the winning group, there is no losing group"
},
"losingDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "deprecated - do not use, to be removed in 0.23.0"
},
"meanLosingDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Mean distance of all neighbors from the losing group. Optional. If k equals the size of the winning group, there is no losing group."
}
},
"inner_properties": null,
"description": "This meta field contains additional info about the classified reference property"
}
},
"description": "The new list of references."
},
"inferrable": true,
"http_endpoint_parameter_name": "requestBody"
},
{
"name": "consistency_level",
"required": false,
"description": "Defines the required number of replica acknowledgements for request 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": "tenant_identifier",
"required": false,
"description": "Specifies the tenant in a request targeting a multi-tenant collection (class).",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Specifies the tenant in a request targeting a multi-tenant collection (class)."
},
"inferrable": true,
"http_endpoint_parameter_name": "tenant"
}
]
},
"output": {
"description": "Response from the API endpoint 'objects.class.references.put'.",
"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}/references/{propertyName}",
"http_method": "PUT",
"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": "tenant",
"tool_parameter_name": "tenant_identifier",
"description": "Specifies the tenant in a request targeting a multi-tenant collection (class).",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Specifies the tenant in a request targeting a multi-tenant collection (class)."
},
"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 source 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 source object belongs to."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "id",
"tool_parameter_name": "source_object_uuid",
"description": "Unique UUID of the source object.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique UUID of the source object."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "propertyName",
"tool_parameter_name": "reference_property_name",
"description": "Unique name of the reference property of the source object.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique name of the reference property of the source object."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "requestBody",
"tool_parameter_name": "new_references_list",
"description": "The new list of references.",
"value_schema": {
"val_type": "array",
"inner_val_type": "json",
"enum": null,
"properties": null,
"inner_properties": {
"class": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "If using a concept reference (rather than a direct reference), specify the desired collection (class) name here."
},
"schema": {
"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."
},
"beacon": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "If using a direct reference, specify the URI to point to the cross-reference here. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-reference to an object"
},
"href": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "If using a direct reference, this read-only fields provides a link to the referenced resource. If 'origin' is globally configured, an absolute URI is shown - a relative URI otherwise."
},
"classification": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"overallCount": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "overall neighbors checked as part of the classification. In most cases this will equal k, but could be lower than k - for example if not enough data was present"
},
"winningCount": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "size of the winning group, a number between 1..k"
},
"losingCount": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "size of the losing group, can be 0 if the winning group size equals k"
},
"closestOverallDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The lowest distance of any neighbor, regardless of whether they were in the winning or losing group"
},
"winningDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "deprecated - do not use, to be removed in 0.23.0"
},
"meanWinningDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Mean distance of all neighbors from the winning group"
},
"closestWinningDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Closest distance of a neighbor from the winning group"
},
"closestLosingDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The lowest distance of a neighbor in the losing group. Optional. If k equals the size of the winning group, there is no losing group"
},
"losingDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "deprecated - do not use, to be removed in 0.23.0"
},
"meanLosingDistance": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Mean distance of all neighbors from the losing group. Optional. If k equals the size of the winning group, there is no losing group."
}
},
"inner_properties": null,
"description": "This meta field contains additional info about the classified reference property"
}
},
"description": "The new list of references."
},
"accepted_as": "body",
"required": true,
"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\": \"The new list of references.\",\n \"content\": {\n \"application/yaml\": {\n \"schema\": {\n \"type\": \"array\",\n \"description\": \"Multiple instances of references to other objects.\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"class\": {\n \"type\": \"string\",\n \"description\": \"If using a concept reference (rather than a direct reference), specify the desired collection (class) name here.\",\n \"format\": \"uri\"\n },\n \"schema\": {\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 \"beacon\": {\n \"type\": \"string\",\n \"description\": \"If using a direct reference, specify the URI to point to the cross-reference here. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-reference to an object\",\n \"format\": \"uri\"\n },\n \"href\": {\n \"type\": \"string\",\n \"description\": \"If using a direct reference, this read-only fields provides a link to the referenced resource. If 'origin' is globally configured, an absolute URI is shown - a relative URI otherwise.\",\n \"format\": \"uri\"\n },\n \"classification\": {\n \"type\": \"object\",\n \"properties\": {\n \"overallCount\": {\n \"type\": \"number\",\n \"description\": \"overall neighbors checked as part of the classification. In most cases this will equal k, but could be lower than k - for example if not enough data was present\",\n \"format\": \"int64\"\n },\n \"winningCount\": {\n \"type\": \"number\",\n \"description\": \"size of the winning group, a number between 1..k\",\n \"format\": \"int64\"\n },\n \"losingCount\": {\n \"type\": \"number\",\n \"description\": \"size of the losing group, can be 0 if the winning group size equals k\",\n \"format\": \"int64\"\n },\n \"closestOverallDistance\": {\n \"type\": \"number\",\n \"description\": \"The lowest distance of any neighbor, regardless of whether they were in the winning or losing group\",\n \"format\": \"float32\"\n },\n \"winningDistance\": {\n \"type\": \"number\",\n \"description\": \"deprecated - do not use, to be removed in 0.23.0\",\n \"format\": \"float32\"\n },\n \"meanWinningDistance\": {\n \"type\": \"number\",\n \"description\": \"Mean distance of all neighbors from the winning group\",\n \"format\": \"float32\"\n },\n \"closestWinningDistance\": {\n \"type\": \"number\",\n \"description\": \"Closest distance of a neighbor from the winning group\",\n \"format\": \"float32\"\n },\n \"closestLosingDistance\": {\n \"type\": \"number\",\n \"description\": \"The lowest distance of a neighbor in the losing group. Optional. If k equals the size of the winning group, there is no losing group\",\n \"format\": \"float32\",\n \"nullable\": true\n },\n \"losingDistance\": {\n \"type\": \"number\",\n \"description\": \"deprecated - do not use, to be removed in 0.23.0\",\n \"format\": \"float32\",\n \"nullable\": true\n },\n \"meanLosingDistance\": {\n \"type\": \"number\",\n \"description\": \"Mean distance of all neighbors from the losing group. Optional. If k equals the size of the winning group, there is no losing group.\",\n \"format\": \"float32\",\n \"nullable\": true\n }\n },\n \"description\": \"This meta field contains additional info about the classified reference property\"\n }\n },\n \"description\": \"Either set beacon (direct reference) or set collection (class) and schema (concept reference)\"\n }\n }\n },\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"description\": \"Multiple instances of references to other objects.\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"class\": {\n \"type\": \"string\",\n \"description\": \"If using a concept reference (rather than a direct reference), specify the desired collection (class) name here.\",\n \"format\": \"uri\"\n },\n \"schema\": {\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 \"beacon\": {\n \"type\": \"string\",\n \"description\": \"If using a direct reference, specify the URI to point to the cross-reference here. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-reference to an object\",\n \"format\": \"uri\"\n },\n \"href\": {\n \"type\": \"string\",\n \"description\": \"If using a direct reference, this read-only fields provides a link to the referenced resource. If 'origin' is globally configured, an absolute URI is shown - a relative URI otherwise.\",\n \"format\": \"uri\"\n },\n \"classification\": {\n \"type\": \"object\",\n \"properties\": {\n \"overallCount\": {\n \"type\": \"number\",\n \"description\": \"overall neighbors checked as part of the classification. In most cases this will equal k, but could be lower than k - for example if not enough data was present\",\n \"format\": \"int64\"\n },\n \"winningCount\": {\n \"type\": \"number\",\n \"description\": \"size of the winning group, a number between 1..k\",\n \"format\": \"int64\"\n },\n \"losingCount\": {\n \"type\": \"number\",\n \"description\": \"size of the losing group, can be 0 if the winning group size equals k\",\n \"format\": \"int64\"\n },\n \"closestOverallDistance\": {\n \"type\": \"number\",\n \"description\": \"The lowest distance of any neighbor, regardless of whether they were in the winning or losing group\",\n \"format\": \"float32\"\n },\n \"winningDistance\": {\n \"type\": \"number\",\n \"description\": \"deprecated - do not use, to be removed in 0.23.0\",\n \"format\": \"float32\"\n },\n \"meanWinningDistance\": {\n \"type\": \"number\",\n \"description\": \"Mean distance of all neighbors from the winning group\",\n \"format\": \"float32\"\n },\n \"closestWinningDistance\": {\n \"type\": \"number\",\n \"description\": \"Closest distance of a neighbor from the winning group\",\n \"format\": \"float32\"\n },\n \"closestLosingDistance\": {\n \"type\": \"number\",\n \"description\": \"The lowest distance of a neighbor in the losing group. Optional. If k equals the size of the winning group, there is no losing group\",\n \"format\": \"float32\",\n \"nullable\": true\n },\n \"losingDistance\": {\n \"type\": \"number\",\n \"description\": \"deprecated - do not use, to be removed in 0.23.0\",\n \"format\": \"float32\",\n \"nullable\": true\n },\n \"meanLosingDistance\": {\n \"type\": \"number\",\n \"description\": \"Mean distance of all neighbors from the losing group. Optional. If k equals the size of the winning group, there is no losing group.\",\n \"format\": \"float32\",\n \"nullable\": true\n }\n },\n \"description\": \"This meta field contains additional info about the classified reference property\"\n }\n },\n \"description\": \"Either set beacon (direct reference) or set collection (class) and schema (concept reference)\"\n }\n }\n }\n },\n \"required\": true\n}",
"use_request_body_schema_mode": true,
"validate_request_body_schema": true
}
}