Weaviate API
Arcade Unoptimized
Tools that enable LLMs to interact directly with the weaviate API.
Author:Arcade
Version:
0.2.1Auth:No authentication required
81tools
81require secrets
Arcade Toolkit provides tools to interface directly with the Weaviate API, enabling developers to manage and organize data efficiently. This toolkit is essential for working with databases within Weaviate, making it easier to handle complex operations.
Capabilities
- Manage database users and roles, including assignment and permissions.
- Perform batch operations for data objects and references, improving efficiency.
- Create, update, and delete schemas and collections.
- Monitor and manage backup and replication processes for data integrity and recovery.
- Validate data object structures to ensure compliance with schema requirements.
Secrets
- API Key:
WEAVIATE_API_KEY - Server URL:
WEAVIATE_SERVER_URLUse these secrets for authenticating and connecting to your Weaviate instance.
Available tools(81)
81 of 81 tools
| Tool name | Description | Secrets | |
|---|---|---|---|
Activate a deactivated database user account.
Use this tool to activate a user with a `db` user type in the database. It should be called when re-enabling user access is needed. | 2 | ||
Add new permissions to a role without affecting existing ones.
Use this tool to assign additional permissions to a specified role within a system, ensuring that current permissions remain unchanged.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 2 | ||
Add a new property to an existing collection schema.
Use this tool to add a new property definition to a specified collection (className) within the schema. It is called when a new property needs to be incorporated into an existing data structure.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 2 | ||
Add a reference to an object's property.
This tool adds a new reference to a specified property of a data object. The object is identified by its class and UUID. Use this to link related objects within a dataset.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path, query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path, query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 2 | ||
Assign roles to a user in the system.
Use this tool to assign one or more roles to a specific user, allowing flexibility in user permissions and access control. | 2 | ||
Assign roles to a specific group.
Use this tool to assign one or more roles to a designated group, identified by its ID. | 2 | ||
Batch create cross-references between items in a collection.
Use this tool to efficiently establish multiple cross-references between items in a collection at once. Ideal for handling large datasets where establishing individual links manually would be inefficient.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 2 | ||
Register multiple data objects in a single request.
This tool registers multiple data objects in one request for efficiency. It validates metadata and schema values for each object. The operation is idempotent, meaning if an object with a given UUID already exists, it will be overwritten.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 2 | ||
Cancel a backup by its ID from a specified backend storage.
Use this tool to delete a backup using its unique ID from a specified backend storage location, ensuring the backup is no longer retrievable. | 2 | ||
Cancel an active replication operation by ID.
Use this tool to request the cancellation of an ongoing replication operation specified by its ID. The operation is stopped and marked as 'CANCELLED' but is not automatically deleted. | 2 | ||
Cancel an active replication operation.
Use this tool to remove and cancel a specific replication operation. It ensures that active processes are halted and resources are cleaned up before deletion. | 2 | ||
Check the status of a backup restoration process.
Use this tool to manually check the status of a specific backup restoration on a given backend, using the backup ID. Ideal when automatic polling is disabled. | 2 | ||
Get the current status of a backup creation process.
Use this tool to manually check the status of a backup creation process by its ID on the specified backend. Ideal for when waiting for completion is disabled or not suitable. | 2 | ||
Check if a role has specific permissions in the system.
Use this tool to verify whether a particular role possesses certain permissions within the system. It should be called when there's a need to confirm role access rights.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 2 | ||
Check if the Weaviate instance is running properly.
Use this tool to perform a basic health check on a Weaviate instance, ensuring it is running and responding to HTTP requests. Useful for monitoring and maintenance tasks. | 2 | ||
Check if the Weaviate instance is ready to accept traffic.
Use this tool to determine if the Weaviate instance has completed its startup routines and is ready for operations such as data import and queries. Ideal for readiness checks in container orchestration contexts like Kubernetes. | 2 | ||
Create a new alias for a collection in Weaviate.
This tool creates a new alias mapping between an alias name and a collection (class) in Weaviate. Use it to set up alternative names for accessing collections. | 2 | ||
Initiates backup creation for specified collections.
This tool starts the process of creating a backup for the specified collections on a designated backend storage using Weaviate. The backup is compressed using gzip by default, and the system remains operational during the backup process. Use this tool when you need to ensure data is safely backed up without interrupting service. | 2 | ||
Create a new database user and obtain an API key.
This tool is used to create a new database user by specifying a name. It returns an API key for the created user. | 2 | ||
Create a new data object in Weaviate.
This tool creates a new data object in Weaviate, ensuring that the object's metadata and schema values are validated. It's useful for adding new data objects when there is no existing object with the same ID.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 2 | ||
Create a new role with specified permissions.
Use this tool to create a new role in the system and define its permissions. It should be called when there is a need to set up access controls for new role-based functionalities.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 2 | ||
Create a new collection (class) in Weaviate.
This tool is used to define and create a new collection (class) in Weaviate. It provides explicit control over the schema definition, which is essential when `AutoSchema` is not relied upon. Use this tool to ensure accurate schema setup in a Weaviate instance.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 2 | ||
Create new tenants in a specified collection.
Use this tool to create one or more new tenants for a specified collection when multi-tenancy is enabled. Useful for managing tenants within a Weaviate database.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 2 | ||
Deactivate a database user account.
Use this tool to deactivate a user with the type 'db' in the database. Provide the user ID to deactivate their account and prevent access to the database. | 2 | ||
Delete an existing alias from the system.
This tool removes an alias from the system without affecting the underlying collection. It should be called when an alias is no longer needed. | 2 |
Page 1 of 4(25 of 81)
Get Building
Last updated on