280 lines
9 KiB
JSON
280 lines
9 KiB
JSON
{
|
|
"name": "GetDataObject",
|
|
"fully_qualified_name": "WeaviateApi.GetDataObject@0.1.0",
|
|
"description": "Retrieve a data object using collection name and UUID.\n\n",
|
|
"toolkit": {
|
|
"name": "ArcadeWeaviateApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "collection_name",
|
|
"required": true,
|
|
"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."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "className"
|
|
},
|
|
{
|
|
"name": "object_uuid",
|
|
"required": true,
|
|
"description": "Unique UUID of the object to be retrieved from 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 retrieved."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "id"
|
|
},
|
|
{
|
|
"name": "include_additional_information",
|
|
"required": false,
|
|
"description": "Specify additional info to include: `classification`, `vector`, or `interpretation`.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Include additional information, such as classification information. Allowed values include: `classification`, `vector` and `interpretation`."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "include"
|
|
},
|
|
{
|
|
"name": "required_replica_acknowledgment",
|
|
"required": false,
|
|
"description": "Specifies how many replicas must confirm a request for success. Relates to consistency level.",
|
|
"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": "target_node_name",
|
|
"required": false,
|
|
"description": "Specify the target node to fulfill the request.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The target node which should fulfill the request."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "node_name"
|
|
},
|
|
{
|
|
"name": "tenant_identifier",
|
|
"required": false,
|
|
"description": "Specify the tenant for a multi-tenant collection request.",
|
|
"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.get'.",
|
|
"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": "GET",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "include",
|
|
"tool_parameter_name": "include_additional_information",
|
|
"description": "Include additional information, such as classification information. Allowed values include: `classification`, `vector` and `interpretation`.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Include additional information, such as classification information. Allowed values include: `classification`, `vector` and `interpretation`."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "consistency_level",
|
|
"tool_parameter_name": "required_replica_acknowledgment",
|
|
"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": "node_name",
|
|
"tool_parameter_name": "target_node_name",
|
|
"description": "The target node which should fulfill the request.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The target node which should fulfill the request."
|
|
},
|
|
"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 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 retrieved.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Unique UUID of the object to be retrieved."
|
|
},
|
|
"accepted_as": "path",
|
|
"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": null,
|
|
"use_request_body_schema_mode": false,
|
|
"validate_request_body_schema": false
|
|
}
|
|
}
|