{ "name": "RetrieveCollectionSchema", "fully_qualified_name": "WeaviateApi.RetrieveCollectionSchema@0.1.0", "description": "Retrieve the schema of a specified collection.\n\nFetches the definition of a specific collection by `className`, detailing its properties, configuration, and vectorizer settings.", "toolkit": { "name": "ArcadeWeaviateApi", "description": null, "version": "0.1.0" }, "input": { "parameters": [ { "name": "collection_name", "required": true, "description": "The name of the collection to retrieve the schema for.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The name of the collection (class) to retrieve." }, "inferrable": true, "http_endpoint_parameter_name": "className" }, { "name": "ensure_strong_consistency", "required": false, "description": "If true, proxies the request to the cluster leader for strong schema consistency. Default is true.", "value_schema": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true." }, "inferrable": true, "http_endpoint_parameter_name": "consistency" } ] }, "output": { "description": "Response from the API endpoint 'schema.objects.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/schema/{className}", "http_method": "GET", "headers": {}, "parameters": [ { "name": "className", "tool_parameter_name": "collection_name", "description": "The name of the collection (class) to retrieve.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The name of the collection (class) to retrieve." }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "consistency", "tool_parameter_name": "ensure_strong_consistency", "description": "If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true.", "value_schema": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true." }, "accepted_as": "header", "required": false, "deprecated": false, "default": true, "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 } }