/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
'/': {
/** Get links to other endpoints to help discover the REST API. */
get: operations['weaviate.root'];
};
'/.well-known/live': {
/** Indicates if the Weaviate instance is running and responsive to basic HTTP requests. Primarily used for health checks, such as Kubernetes liveness probes. */
get: operations['weaviate.wellknown.liveness'];
};
'/.well-known/ready': {
/** Indicates if the Weaviate instance has completed its startup routines and is prepared to accept user traffic (data import, queries, etc.). Used for readiness checks, such as Kubernetes readiness probes. */
get: operations['weaviate.wellknown.readiness'];
};
'/.well-known/openid-configuration': {
/** Provides OpenID Connect (OIDC) discovery information if OIDC authentication is configured for Weaviate. Returns details like the token issuer URL, client ID, and required scopes. */
get: {
responses: {
/** OIDC configuration details returned successfully. */
200: {
schema: {
/** @description The OIDC issuer URL to redirect to for authentication. */
href?: string;
/** @description The OAuth Client ID configured for Weaviate. */
clientId?: string;
/** @description The required OAuth scopes for authentication. */
scopes?: string[];
};
};
/** OIDC provider is not configured for this Weaviate instance. */
404: unknown;
/** An internal server error occurred while retrieving OIDC configuration. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
};
'/replication/replicate': {
/** Begins an asynchronous operation to move or copy a specific shard replica from its current node to a designated target node. The operation involves copying data, synchronizing, and potentially decommissioning the source replica. */
post: operations['replicate'];
/** Schedules all replication operations for deletion across all collections, shards, and nodes. */
delete: operations['deleteAllReplications'];
};
'/replication/replicate/force-delete': {
/** USE AT OWN RISK! Synchronously force delete operations from the FSM. This will not perform any checks on which state the operation is in so may lead to data corruption or loss. It is recommended to first scale the number of replication engine workers to 0 before calling this endpoint to ensure no operations are in-flight. */
post: operations['forceDeleteReplications'];
};
'/replication/replicate/{id}': {
/** Fetches the current status and detailed information for a specific replication operation, identified by its unique ID. Optionally includes historical data of the operation's progress if requested. */
get: operations['replicationDetails'];
/** Removes a specific replication operation. If the operation is currently active, it will be cancelled and its resources cleaned up before the operation is deleted. */
delete: operations['deleteReplication'];
};
'/replication/replicate/list': {
/** Retrieves a list of currently registered replication operations, optionally filtered by collection, shard, or node ID. */
get: operations['listReplication'];
};
'/replication/replicate/{id}/cancel': {
/** Requests the cancellation of an active replication operation identified by its ID. The operation will be stopped, but its record will remain in the `CANCELLED` state (can't be resumed) and will not be automatically deleted. */
post: operations['cancelReplication'];
};
'/replication/sharding-state': {
/** Fetches the current sharding state, including replica locations and statuses, for all collections or a specified collection. If a shard name is provided along with a collection, the state for that specific shard is returned. */
get: operations['getCollectionShardingState'];
};
'/replication/scale': {
/** Computes and returns a replication scale plan for a given collection and desired replication factor. The plan includes, for each shard, a list of nodes to be added and a list of nodes to be removed. */
get: operations['getReplicationScalePlan'];
/** Apply a replication scaling plan that specifies nodes to add or remove per shard for a given collection. */
post: operations['applyReplicationScalePlan'];
};
'/users/own-info': {
/** Get information about the currently authenticated user, including username and assigned roles. */
get: operations['getOwnInfo'];
};
'/users/db': {
/** Retrieves a list of all database (`db` user type) users with their roles and status information. */
get: operations['listAllUsers'];
};
'/users/db/{user_id}': {
/** Retrieve detailed information about a specific database user (`db` user type), including their roles, status, and type. */
get: operations['getUserInfo'];
/** Create a new database (`db` user type) user with the specified name. Returns an API key for the newly created user. */
post: operations['createUser'];
/** Delete a database user. You can't delete your current user. */
delete: operations['deleteUser'];
};
'/users/db/{user_id}/rotate-key': {
/** Revoke the current API key for the specified database user (`db` user type) and generate a new one. */
post: operations['rotateUserApiKey'];
};
'/users/db/{user_id}/activate': {
/** Activate a deactivated database user (`db` user type). */
post: operations['activateUser'];
};
'/users/db/{user_id}/deactivate': {
/** Deactivate a database user (`db` user type). */
post: operations['deactivateUser'];
};
'/authz/roles': {
/** Get all roles and their assigned permissions. */
get: operations['getRoles'];
/** Create a new role with the specified permissions. */
post: operations['createRole'];
};
'/authz/roles/{id}/add-permissions': {
/** Add new permissions to an existing role without affecting current permissions. */
post: operations['addPermissions'];
};
'/authz/roles/{id}/remove-permissions': {
/** Permissions can be revoked from a specified role. Removing all permissions from a role will delete the role itself. */
post: operations['removePermissions'];
};
'/authz/roles/{id}': {
/** Fetch a role by its name. */
get: operations['getRole'];
/** Deleting a role will remove it from the system, and revoke the associated permissions from all users who had this role. */
delete: operations['deleteRole'];
};
'/authz/roles/{id}/has-permission': {
/** Check whether a role has the specified permissions. */
post: operations['hasPermission'];
};
'/authz/roles/{id}/users': {
/** Get all the users (`db` + `oidc`) who have been assigned a specific role. Deprecated, will be removed when v1.29 is not supported anymore. */
get: operations['getUsersForRoleDeprecated'];
};
'/authz/roles/{id}/user-assignments': {
/** Fetch a list of users which have the specified role. */
get: operations['getUsersForRole'];
};
'/authz/roles/{id}/group-assignments': {
/** Retrieves a list of all groups that have been assigned a specific role, identified by its name. */
get: operations['getGroupsForRole'];
};
'/authz/users/{id}/roles': {
/** Retrieve the roles assigned to a specific user (`db` + `oidc`). Deprecated, will be removed when 1.29 is not supported anymore */
get: operations['getRolesForUserDeprecated'];
};
'/authz/users/{id}/roles/{userType}': {
/** Get all the roles for a specific user (`db` or `oidc`). */
get: operations['getRolesForUser'];
};
'/authz/users/{id}/assign': {
/** Assign one or more roles to a user. Users can have multiple roles. */
post: operations['assignRoleToUser'];
};
'/authz/users/{id}/revoke': {
/** Remove one or more roles from a user. */
post: operations['revokeRoleFromUser'];
};
'/authz/groups/{id}/assign': {
/** Assign roles to the specified group. */
post: operations['assignRoleToGroup'];
};
'/authz/groups/{id}/revoke': {
/** Revoke roles from the specified group. */
post: operations['revokeRoleFromGroup'];
};
'/authz/groups/{id}/roles/{groupType}': {
/** Retrieves a list of all roles assigned to a specific group. The group must be identified by both its name (`id`) and its type (`db` or `oidc`). */
get: operations['getRolesForGroup'];
};
'/authz/groups/{groupType}': {
/** Retrieves a list of all available group names for a specified group type (`oidc` or `db`). */
get: operations['getGroups'];
};
'/objects': {
/** Retrieves a list of data objects. By default, objects are returned in reverse order of creation. Requires a collection name (`class`) parameter to specify which collection's objects to list, otherwise, returns an empty list. */
get: operations['objects.list'];
/** Creates a new data object. The object's metadata and schema values are validated before creation.
**Note (batch import)**:
If you plan on importing a large number of objects, using the `/batch/objects` endpoint is significantly more efficient than sending multiple single requests.
**Note (idempotence)**:
This operation (POST) fails if an object with the provided ID already exists. To update an existing object, use the PUT or PATCH methods. */
post: operations['objects.create'];
};
'/objects/{id}': {
/** Get a specific object based on its UUID. Also available as Websocket bus.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */
get: operations['objects.get'];
/** Updates an object based on its UUID. Given meta-data and schema values are validated. `lastUpdateTimeUnix` is set to the time this function is called.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */
put: operations['objects.update'];
/** Deletes an object from the database based on its UUID.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */
delete: operations['objects.delete'];
/** Checks if an object exists in the system based on its UUID.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */
head: operations['objects.head'];
/** Update an object based on its UUID (using patch semantics). This method supports json-merge style patch semantics (RFC 7396). Provided meta-data and schema values are validated. `lastUpdateTimeUnix` is set to the time this function is called.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */
patch: operations['objects.patch'];
};
'/objects/{className}/{id}': {
/** Get a data object based on its collection name (`className`) and UUID (`id`). */
get: operations['objects.class.get'];
/** Replaces properties of an existing data object. The object is identified by its collection name (`className`) and UUID (`id`). The request body must contain the complete object definition with the new property values. */
put: operations['objects.class.put'];
/** Removes a data object from a specific collection, identified by its collection name (`className`) and UUID (`id`).
**Note on deleting references (legacy format):**
For backward compatibility with older beacon formats (lacking a collection name), deleting a reference requires the beacon in the request to exactly match the stored format. Beacons always use `localhost` as the host, indicating the target is within the same Weaviate instance. */
delete: operations['objects.class.delete'];
/** Verifies the existence of a specific data object within a collection (class), identified by its collection name (`className`) and UUID (`id`), without returning the object itself.
This is faster than a GET request as it avoids retrieving and processing object data. Existence is confirmed by a 204 No Content status code, while non-existence results in a 404 Not Found. */
head: operations['objects.class.head'];
/** Updates specific properties of an existing data object using JSON merge patch semantics (RFC 7396). The object is identified by its collection name (`className`) and UUID (`id`). Only the fields provided in the request body are modified. Metadata and schema values are validated, and the object's `lastUpdateTimeUnix` is updated. */
patch: operations['objects.class.patch'];
};
'/objects/{id}/references/{propertyName}': {
/** Replace all references in cross-reference property of an object.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}/references/{propertyName}` endpoint instead. */
put: operations['objects.references.update'];
/** Add a reference to a specific property of a data object.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}/references/{propertyName}` endpoint instead. */
post: operations['objects.references.create'];
/** Delete the single reference that is given in the body from the list of references that this property has.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}/references/{propertyName}` endpoint instead. */
delete: operations['objects.references.delete'];
};
'/objects/{className}/{id}/references/{propertyName}': {
/** Replaces all existing references for a specific reference property (`propertyName`) on a source data object. The source object is identified by its collection name (`className`) and UUID (`id`). The new set of references is provided in the request body. */
put: operations['objects.class.references.put'];
/** Adds a new reference to a reference property (`propertyName`) on a source data object. The source object is identified by its collection name (`className`) and UUID (`id`). The reference to add is specified in the request body. */
post: operations['objects.class.references.create'];
/** Removes a specific reference from a reference property (`propertyName`) of a source data object. The source object is identified by its collection name (`className`) and UUID (`id`). The reference to remove is specified in the request body. */
delete: operations['objects.class.references.delete'];
};
'/objects/validate': {
/** Checks if a data object's structure conforms to the specified collection schema and metadata rules without actually storing the object.
A successful validation returns a 200 OK status code with no body. If validation fails, an error response with details is returned. */
post: operations['objects.validate'];
};
'/batch/objects': {
/** Registers multiple data objects in a single request for efficiency. Metadata and schema values for each object are validated.
**Note (idempotence)**:
This operation is idempotent based on the object UUIDs provided. If an object with a given UUID already exists, it will be overwritten (similar to a PUT operation for that specific object within the batch). */
post: operations['batch.objects.create'];
/** Removes multiple data objects based on a filter specified in the request body.
Deletion occurs based on the filter criteria provided in the `where` clause. There is a configurable limit (default 10,000, set via `QUERY_MAXIMUM_RESULTS`) on how many objects can be deleted in a single batch request to prevent excessive resource usage. Objects are deleted in the order they match the filter. To delete more objects than the limit allows, repeat the request until no more matching objects are found. */
delete: operations['batch.objects.delete'];
};
'/batch/references': {
/** Batch create cross-references between collection items in bulk. */
post: operations['batch.references.create'];
};
'/graphql': {
/** Executes a single GraphQL query provided in the request body. Use this endpoint for all Weaviate data queries and exploration. */
post: operations['graphql.post'];
};
'/graphql/batch': {
/** Executes multiple GraphQL queries provided in the request body as an array. Allows performing several queries in a single network request for efficiency. */
post: operations['graphql.batch'];
};
'/meta': {
/** Provides meta-information about the running Weaviate instance, including its version, loaded modules, and network hostname. This information can be useful for monitoring, compatibility checks, or inter-instance communication. */
get: operations['meta.get'];
};
'/tokenize': {
/** Tokenizes the provided text using the specified tokenization method. This is a stateless utility endpoint useful for debugging and understanding how text will be processed during indexing and querying. The response includes both the indexed tokens (as stored in the inverted index) and query tokens (after optional stopword removal). */
post: operations['tokenize'];
};
'/schema': {
/** Retrieves the definitions of all collections (classes) currently in the database schema. */
get: operations['schema.dump'];
/** Defines and creates a new collection (class).
If [`AutoSchema`](https://docs.weaviate.io/weaviate/config-refs/collections#auto-schema) is enabled (not recommended for production), Weaviate might attempt to infer schema from data during import. Manual definition via this endpoint provides explicit control. */
post: operations['schema.objects.create'];
};
'/schema/{className}': {
/** Retrieve the definition of a specific collection (`className`), including its properties, configuration, and vectorizer settings. */
get: operations['schema.objects.get'];
/** Updates the configuration settings of an existing collection (`className`) based on the provided definition. Note: This operation modifies mutable settings specified in the request body. It does not add properties (use `POST /schema/{className}/properties` for that) or change the collection name. */
put: operations['schema.objects.update'];
/** Removes a collection definition from the schema. WARNING: This action permanently deletes all data objects stored within the collection. */
delete: operations['schema.objects.delete'];
};
'/schema/{className}/properties': {
/** Adds a new property definition to an existing collection (`className`) definition. */
post: operations['schema.objects.properties.add'];
};
'/schema/{className}/properties/{propertyName}/index/{indexName}': {
/** Deletes an inverted index of a specific property within a collection (`className`). The index to delete is identified by `indexName` and must be one of `filterable`, `searchable`, or `rangeFilters`. */
delete: operations['schema.objects.properties.delete'];
};
'/schema/{className}/properties/{propertyName}/tokenize': {
/** Tokenizes the provided text using the tokenization method configured for the specified property. This endpoint automatically applies the property's tokenization setting and the collection's stopword configuration, making it useful for understanding exactly how text will be processed for a given property during indexing and querying. */
post: operations['schema.objects.properties.tokenize'];
};
'/schema/{className}/vectors/{vectorIndexName}/index': {
/** Deletes a specific vector index within a collection (`className`). The vector index to delete is identified by `vectorIndexName`. */
delete: operations['schema.objects.vectors.delete'];
};
'/schema/{className}/shards': {
/** Retrieves the status of all shards associated with the specified collection (`className`). For multi-tenant collections, use the `tenant` query parameter to retrieve status for a specific tenant's shards. */
get: operations['schema.objects.shards.get'];
};
'/schema/{className}/shards/{shardName}': {
/** Updates the status of a specific shard within a collection (e.g., sets it to `READY` or `READONLY`). This is typically used after resolving an underlying issue (like disk space) that caused a shard to become non-operational. There is also a convenience function in each client to set the status of all shards of a collection. */
put: operations['schema.objects.shards.update'];
};
'/schema/{className}/tenants': {
/** Retrieves a list of all tenants currently associated with the specified collection. */
get: operations['tenants.get'];
/** Updates the activity status (e.g., `ACTIVE`, `INACTIVE`, etc.) of one or more specified tenants within a collection (`className`). */
put: operations['tenants.update'];
/** Creates one or more new tenants for a specified collection (`className`). Multi-tenancy must be enabled for the collection via its definition. */
post: operations['tenants.create'];
/** Deletes one or more specified tenants from a collection (`className`). WARNING: This action permanently deletes all data associated with the specified tenants. */
delete: operations['tenants.delete'];
};
'/schema/{className}/tenants/{tenantName}': {
/** Retrieves details about a specific tenant within the given collection (`className`), such as its current activity status. */
get: operations['tenants.get.one'];
/** Checks for the existence of a specific tenant within the given collection (`className`). */
head: operations['tenant.exists'];
};
'/aliases': {
/** Retrieve a list of all aliases in the system. Results can be filtered by specifying a collection (class) name to get aliases for a specific collection only. */
get: operations['aliases.get'];
/** Create a new alias mapping between an alias name and a collection (class). The alias acts as an alternative name for accessing the collection. */
post: operations['aliases.create'];
};
'/aliases/{aliasName}': {
/** Retrieve details about a specific alias by its name, including which collection (class) it points to. */
get: operations['aliases.get.alias'];
/** Update an existing alias to point to a different collection (class). This allows you to redirect an alias from one collection to another without changing the alias name. */
put: operations['aliases.update'];
/** Remove an existing alias from the system. This will delete the alias mapping but will not affect the underlying collection (class). */
delete: operations['aliases.delete'];
};
'/backups/{backend}': {
/** List all created backups IDs, Status */
get: operations['backups.list'];
/** Initiates the creation of a backup for specified collections on a designated backend storage.
Notes:
- Backups are compressed using gzip by default.
- Weaviate remains operational during the backup process. */
post: operations['backups.create'];
};
'/backups/{backend}/{id}': {
/** Checks the status of a specific backup creation process identified by its ID on the specified backend.
Client libraries often provide a 'wait for completion' feature that polls this endpoint automatically. Use this endpoint for manual status checks or if 'wait for completion' is disabled. */
get: operations['backups.create.status'];
/** Cancels an ongoing backup operation identified by its ID. */
delete: operations['backups.cancel'];
};
'/backups/{backend}/{id}/restore': {
/** Checks the status of a specific backup restoration process identified by the backup ID on the specified backend.
Client libraries often provide a 'wait for completion' feature that polls this endpoint automatically. Use this endpoint for manual status checks or if 'wait for completion' is disabled. */
get: operations['backups.restore.status'];
/** Initiates the restoration of collections from a specified backup located on a designated backend.
Requirements:
- Target cluster must have the same number of nodes as the source cluster where the backup was created.
- Collections included in the restore must not already exist on the target cluster.
- Node names must match between the backup and the target cluster. */
post: operations['backups.restore'];
/** Cancels an ongoing backup restoration process identified by its ID on the specified backend storage. */
delete: operations['backups.restore.cancel'];
};
'/export/{backend}': {
/** Initiates an export operation on the specified backend storage (S3, GCS, Azure, or filesystem). The output format is controlled by the required 'file_format' field in the request body (currently only 'parquet' is supported). Each collection is exported to a separate file. */
post: operations['export.create'];
};
'/export/{backend}/{id}': {
/** Retrieves the current status of an export operation, including progress for each collection being exported. */
get: operations['export.status'];
/** Cancels an ongoing export operation identified by its ID. */
delete: operations['export.cancel'];
};
'/cluster/statistics': {
/** Provides statistics about the internal Raft consensus protocol state for the Weaviate cluster. */
get: operations['cluster.get.statistics'];
};
'/nodes': {
/** Retrieves status information about all nodes in the cluster. Use the `output` query parameter to control the level of detail. */
get: operations['nodes.get'];
};
'/nodes/{className}': {
/** Retrieves status information only for the nodes that host shards for the specified collection (`className`). Use the `output` query parameter to control the level of detail. */
get: operations['nodes.get.class'];
};
'/tasks': {
get: operations['distributedTasks.get'];
};
'/classifications/': {
/** Initiates a background classification task based on the provided parameters. Use the GET /classifications/{id} endpoint to monitor the status and retrieve results. */
post: operations['classifications.post'];
};
'/classifications/{id}': {
/** Retrieves the status, metadata, and results (if completed) of a classification task identified by its unique ID. */
get: operations['classifications.get'];
};
'/mcp': {
/** Opens an SSE stream for receiving MCP server-sent events. */
get: operations['mcp.get'];
/** MCP Streamable HTTP endpoint. Handles JSON-RPC requests for tool discovery and invocation. */
post: operations['mcp.post'];
/** Terminates an MCP session. */
delete: operations['mcp.delete'];
};
}
export interface definitions {
/**
* @description The type of the user. `db` users are managed by Weaviate, `oidc` users are managed by an external OIDC provider.
* @enum {string}
*/
UserTypeInput: 'db' | 'oidc';
/**
* @description If the group contains OIDC or database users.
* @enum {string}
*/
GroupType: 'oidc';
/**
* @description The type of the user. `db_user` users are created through the `users` API, `db_env_user` users are created through environment variables, and `oidc` users are managed by an external OIDC provider.
* @enum {string}
*/
UserTypeOutput: 'db_user' | 'db_env_user' | 'oidc';
UserOwnInfo: {
/** @description The groups associated with the user. */
groups?: string[];
roles?: definitions['Role'][];
/** @description The name (ID) of the user. */
username: string;
};
DBUserInfo: {
/** @description The roles associated with the user. */
roles: string[];
/** @description The name (ID) of the user. */
userId: string;
/**
* @description Type of the returned user.
* @enum {string}
*/
dbUserType: 'db_user' | 'db_env_user';
/** @description Activity status of the returned user. */
active: boolean;
/**
* Format: date-time
* @description Date and time in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
*/
createdAt?: unknown;
/** @description First 3 letters of the associated API key. */
apiKeyFirstLetters?: unknown;
/**
* Format: date-time
* @description Date and time in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
*/
lastUsedAt?: unknown;
};
UserApiKey: {
/** @description The API key associated with the user. */
apikey: string;
};
Role: {
/** @description The name (ID) of the role. */
name: string;
permissions: definitions['Permission'][];
};
/** @description Permissions attached to a role. */
Permission: {
/** @description Resources applicable for backup actions. */
backups?: {
/**
* @description A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections.
* @default *
*/
collection?: string;
};
/** @description Resources applicable for data actions. */
data?: {
/**
* @description A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections.
* @default *
*/
collection?: string;
/**
* @description A string that specifies which tenants this permission applies to. Can be an exact tenant name or a regex pattern. The default value `*` applies the permission to all tenants.
* @default *
*/
tenant?: string;
/**
* @description A string that specifies which objects this permission applies to. Can be an exact object ID or a regex pattern. The default value `*` applies the permission to all objects.
* @default *
*/
object?: string;
};
/** @description Resources applicable for cluster actions. */
nodes?: {
/**
* @description Whether to allow (verbose) returning shards and stats data in the response.
* @default minimal
* @enum {string}
*/
verbosity?: 'verbose' | 'minimal';
/**
* @description A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections.
* @default *
*/
collection?: string;
};
/** @description Resources applicable for user actions. */
users?: {
/**
* @description A string that specifies which users this permission applies to. Can be an exact user name or a regex pattern. The default value `*` applies the permission to all users.
* @default *
*/
users?: string;
};
/** @description Resources applicable for group actions. */
groups?: {
/**
* @description A string that specifies which groups this permission applies to. Can be an exact group name or a regex pattern. The default value `*` applies the permission to all groups.
* @default *
*/
group?: string;
groupType?: definitions['GroupType'];
};
/** @description Resources applicable for tenant actions. */
tenants?: {
/**
* @description A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections.
* @default *
*/
collection?: string;
/**
* @description A string that specifies which tenants this permission applies to. Can be an exact tenant name or a regex pattern. The default value `*` applies the permission to all tenants.
* @default *
*/
tenant?: string;
};
/** @description Resources applicable for role actions. */
roles?: {
/**
* @description A string that specifies which roles this permission applies to. Can be an exact role name or a regex pattern. The default value `*` applies the permission to all roles.
* @default *
*/
role?: string;
/**
* @description Set the scope for the manage role permission.
* @default match
* @enum {string}
*/
scope?: 'all' | 'match';
};
/** @description Resources applicable for collection and/or tenant actions. */
collections?: {
/**
* @description A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections.
* @default *
*/
collection?: string;
};
/** @description resources applicable for replicate actions */
replicate?: {
/**
* @description string or regex. if a specific collection name, if left empty it will be ALL or *
* @default *
*/
collection?: string;
/**
* @description string or regex. if a specific shard name, if left empty it will be ALL or *
* @default *
*/
shard?: string;
};
/** @description Resource definition for alias-related actions and permissions. Used to specify which aliases and collections can be accessed or modified. */
aliases?: {
/**
* @description A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections.
* @default *
*/
collection?: string;
/**
* @description A string that specifies which aliases this permission applies to. Can be an exact alias name or a regex pattern. The default value `*` applies the permission to all aliases.
* @default *
*/
alias?: string;
};
/** @description resources applicable for MCP actions */
mcp?: {
[key: string]: unknown;
};
/**
* @description Allowed actions in weaviate.
* @enum {string}
*/
action: 'manage_backups' | 'read_cluster' | 'create_data' | 'read_data' | 'update_data' | 'delete_data' | 'read_nodes' | 'create_roles' | 'read_roles' | 'update_roles' | 'delete_roles' | 'create_collections' | 'read_collections' | 'update_collections' | 'delete_collections' | 'assign_and_revoke_users' | 'create_users' | 'read_users' | 'update_users' | 'delete_users' | 'create_tenants' | 'read_tenants' | 'update_tenants' | 'delete_tenants' | 'create_replicate' | 'read_replicate' | 'update_replicate' | 'delete_replicate' | 'create_aliases' | 'read_aliases' | 'update_aliases' | 'delete_aliases' | 'assign_and_revoke_groups' | 'read_groups' | 'create_mcp' | 'read_mcp' | 'update_mcp';
};
/** @description List of roles. */
RolesListResponse: definitions['Role'][];
Link: {
/** @description Target of the link. */
href?: string;
/** @description Relationship if both resources are related, e.g. 'next', 'previous', 'parent', etc. */
rel?: string;
/** @description Human readable name of the resource group. */
name?: string;
/** @description Weaviate documentation about this resource group. */
documentationHref?: string;
};
Principal: {
/** @description The username that was extracted either from the authentication information */
username?: string;
groups?: string[];
userType?: definitions['UserTypeInput'];
};
/** @description An array of available words and contexts. */
C11yWordsResponse: {
/** @description Weighted results for all words */
concatenatedWord?: {
concatenatedWord?: string;
singleWords?: unknown[];
concatenatedVector?: definitions['C11yVector'];
concatenatedNearestNeighbors?: definitions['C11yNearestNeighbors'];
};
/** @description Weighted results for per individual word */
individualWords?: {
word?: string;
present?: boolean;
info?: {
vector?: definitions['C11yVector'];
nearestNeighbors?: definitions['C11yNearestNeighbors'];
};
}[];
};
/** @description A resource describing an extension to the contextinoary, containing both the identifier and the definition of the extension */
C11yExtension: {
/**
* @description The new concept you want to extend. Must be an all-lowercase single word, or a space delimited compound word. Examples: 'foobarium', 'my custom concept'
* @example foobarium
*/
concept?: string;
/** @description A list of space-delimited words or a sentence describing what the custom concept is about. Avoid using the custom concept itself. An Example definition for the custom concept 'foobarium': would be 'a naturally occurring element which can only be seen by programmers' */
definition?: string;
/**
* Format: float
* @description Weight of the definition of the new concept where 1='override existing definition entirely' and 0='ignore custom definition'. Note that if the custom concept is not present in the contextionary yet, the weight cannot be less than 1.
*/
weight?: number;
};
/** @description C11y function to show the nearest neighbors to a word. */
C11yNearestNeighbors: {
word?: string;
/** Format: float */
distance?: number;
}[];
/** @description A vector representation of the object in the Contextionary. If provided at object creation, this wil take precedence over any vectorizer setting. */
C11yVector: number[];
/** @description A vector representation of the object. If provided at object creation, this wil take precedence over any vectorizer setting. */
Vector: {
[key: string]: unknown;
};
/** @description A map of named vectors for multi-vector representations. */
Vectors: {
[key: string]: definitions['Vector'];
};
Deprecation: {
/** @description The id that uniquely identifies this particular deprecation (mostly used internally). */
id?: string;
/** @description Whether the problematic API functionality is deprecated (planned to be removed) or already removed. */
status?: string;
/** @description Describes which API is affected, usually one of: REST, GraphQL and gRPC. */
apiType?: string;
/** @description What this deprecation is about. */
msg?: string;
/** @description User-required object to not be affected by the (planned) removal. */
mitigation?: string;
/** @description The deprecation was introduced in this version. */
sinceVersion?: string;
/** @description A best-effort guess of which upcoming version will remove the feature entirely. */
plannedRemovalVersion?: string;
/** @description If the feature has already been removed, it was removed in this version. */
removedIn?: string;
/**
* Format: date-time
* @description If the feature has already been removed, it was removed at this timestamp.
*/
removedTime?: string;
/**
* Format: date-time
* @description The deprecation was introduced at this timestamp.
*/
sinceTime?: string;
/** @description The locations within the specified API affected by this deprecation. */
locations?: string[];
};
/** @description An error response returned by Weaviate endpoints. */
ErrorResponse: {
error?: {
message?: string;
}[];
};
/** @description Request to create a new export operation */
ExportCreateRequest: {
/** @description Unique identifier for this export. Must be URL-safe. */
id: string;
/**
* @description Output file format for the export.
* @enum {string}
*/
file_format: 'parquet';
/** @description List of collection names to include in the export. Cannot be used with 'exclude'. */
include?: string[];
/** @description List of collection names to exclude from the export. Cannot be used with 'include'. */
exclude?: string[];
};
/** @description Response from creating an export operation */
ExportCreateResponse: {
/** @description Unique identifier for this export */
id?: string;
/** @description The backend storage system used */
backend?: string;
/** @description Full path where the export is being written */
path?: string;
/**
* @description Current status of the export
* @enum {string}
*/
status?: 'STARTED';
/**
* Format: date-time
* @description When the export started
*/
startedAt?: string;
/** @description List of collections being exported */
classes?: string[];
};
/** @description Current status of an export operation */
ExportStatusResponse: {
/** @description Unique identifier for this export */
id?: string;
/** @description The backend storage system used */
backend?: string;
/** @description Full path where the export is stored */
path?: string;
/**
* @description Current status of the export
* @enum {string}
*/
status?: 'STARTED' | 'TRANSFERRING' | 'SUCCESS' | 'FAILED' | 'CANCELED';
/**
* Format: date-time
* @description When the export started
*/
startedAt?: string;
/**
* Format: date-time
* @description When the export completed (successfully, with failure, or was canceled)
*/
completedAt?: string;
/**
* Format: int64
* @description Duration of the export in milliseconds
*/
tookInMs?: number;
/** @description List of collections in this export */
classes?: string[];
/** @description Per-shard progress: className -> shardName -> status */
shardStatus?: {
[key: string]: {
[key: string]: definitions['ShardProgress'];
};
};
/** @description Error message if export failed */
error?: string;
};
/** @description Progress information for exporting a single shard */
ShardProgress: {
/**
* @description Status of this shard's export
* @enum {string}
*/
status?: 'TRANSFERRING' | 'SUCCESS' | 'FAILED' | 'SKIPPED';
/**
* Format: int64
* @description Number of objects exported from this shard
*/
objectsExported?: number;
/** @description Error message if this shard's export failed */
error?: string;
/** @description Reason why this shard was skipped (e.g. tenant status) */
skipReason?: string;
};
/** @description An error response caused by a GraphQL query. */
GraphQLError: {
locations?: {
/** Format: int64 */
column?: number;
/** Format: int64 */
line?: number;
}[];
message?: string;
path?: string[];
};
/** @description GraphQL query based on: http://facebook.github.io/graphql/. */
GraphQLQuery: {
/** @description The name of the operation if multiple exist in the query. */
operationName?: string;
/** @description Query based on GraphQL syntax. */
query?: string;
/** @description Additional variables for the query. */
variables?: {
[key: string]: unknown;
};
};
/** @description A list of GraphQL queries. */
GraphQLQueries: definitions['GraphQLQuery'][];
/** @description GraphQL based response: http://facebook.github.io/graphql/. */
GraphQLResponse: {
/** @description GraphQL data object. */
data?: {
[key: string]: definitions['JsonObject'];
};
/** @description Array with errors. */
errors?: definitions['GraphQLError'][];
};
/** @description A list of GraphQL responses. */
GraphQLResponses: definitions['GraphQLResponse'][];
/** @description Configure the inverted index built into Weaviate. See [Reference: Inverted index](https://docs.weaviate.io/weaviate/config-refs/indexing/inverted-index#inverted-index-parameters) for details. */
InvertedIndexConfig: {
/**
* Format: int
* @description Asynchronous index clean up happens every n seconds (default: 60).
*/
cleanupIntervalSeconds?: number;
bm25?: definitions['BM25Config'];
stopwords?: definitions['StopwordConfig'];
/** @description Index each object by its internal timestamps (default: `false`). */
indexTimestamps?: boolean;
/** @description Index each object with the null state (default: `false`). */
indexNullState?: boolean;
/** @description Index length of properties (default: `false`). */
indexPropertyLength?: boolean;
/** @description Using BlockMax WAND for query execution (default: `false`, will be `true` for new collections created after 1.30). */
usingBlockMaxWAND?: boolean;
/** @description User-defined dictionary for tokenization. */
tokenizerUserDict?: definitions['TokenizerUserDictConfig'][];
/** @description User-defined named stopword lists. Each key is a preset name that can be referenced by a property's textAnalyzer.stopwordPreset field. The value is an array of stopword strings. */
stopwordPresets?: {
[key: string]: string[];
};
};
/** @description Configure how replication is executed in a cluster */
ReplicationConfig: {
/** @description Number of times a collection (class) is replicated (default: 1). */
factor?: number;
/** @description Enable asynchronous replication (default: `false`). */
asyncEnabled?: boolean;
/** @description Configuration parameters for asynchronous replication. */
asyncConfig?: definitions['ReplicationAsyncConfig'];
/**
* @description Conflict resolution strategy for deleted objects.
* @enum {string}
*/
deletionStrategy?: 'NoAutomatedResolution' | 'DeleteOnConflict' | 'TimeBasedResolution';
};
/** @description Tuning parameters for the BM25 algorithm. */
BM25Config: {
/**
* Format: float
* @description Calibrates term-weight scaling based on the term frequency within a document (default: 1.2).
*/
k1?: number;
/**
* Format: float
* @description Calibrates term-weight scaling based on the document length (default: 0.75).
*/
b?: number;
};
/** @description Fine-grained control over stopword list usage. */
StopwordConfig: {
/** @description Pre-existing list of common words by language (default: `en`). Options: [`en`, `none`]. */
preset?: string;
/** @description Stopwords to be considered additionally (default: []). Can be any array of custom strings. */
additions?: string[];
/** @description Stopwords to be removed from consideration (default: []). Can be any array of custom strings. */
removals?: string[];
};
/** @description A list of pairs of strings that should be replaced with another string during tokenization. */
TokenizerUserDictConfig: {
/** @description The tokenizer to which the user dictionary should be applied. Currently, only the `kagame` ja and kr tokenizers supports user dictionaries. */
tokenizer?: string;
replacements?: {
/** @description The string to be replaced. */
source: string;
/** @description The string to replace with. */
target: string;
}[];
};
/** @description Request body for the generic tokenize endpoint. */
TokenizeRequest: {
/** @description The text to tokenize. */
text: string;
/**
* @description The tokenization method to apply.
* @enum {string}
*/
tokenization: 'word' | 'lowercase' | 'whitespace' | 'field' | 'trigram' | 'gse' | 'kagome_kr' | 'kagome_ja' | 'gse_ch';
/** @description Optional text analyzer configuration (e.g. ASCII folding). */
analyzerConfig?: definitions['TextAnalyzerConfig'];
/** @description Optional named stopword configurations. Each key is a preset name that can be referenced by analyzerConfig.stopwordPreset. Each value is a StopwordConfig (with optional preset, additions, and removals). */
stopwordPresets?: {
[key: string]: definitions['StopwordConfig'];
};
};
/** @description Response from the tokenize endpoint. */
TokenizeResponse: {
/** @description The tokenization method that was applied. */
tokenization?: string;
/** @description The text analyzer configuration that was used, if any. */
analyzerConfig?: definitions['TextAnalyzerConfig'];
/** @description The stopword configuration that was used, if any. */
stopwordConfig?: definitions['StopwordConfig'];
/** @description The tokens as they would be stored in the inverted index. */
indexed?: string[];
/** @description The tokens as they would be used for query matching (e.g., after stopword removal). */
query?: string[];
};
/** @description Request body for the property-specific tokenize endpoint. */
PropertyTokenizeRequest: {
/** @description The text to tokenize using the property's configured tokenization. */
text: string;
};
/** @description Configuration related to multi-tenancy within a collection (class) */
MultiTenancyConfig: {
/** @description Whether or not multi-tenancy is enabled for this collection (class) (default: `false`). */
enabled?: boolean;
/** @description Nonexistent tenants should (not) be created implicitly (default: `false`). */
autoTenantCreation?: boolean;
/** @description Existing tenants should (not) be turned HOT implicitly when they are accessed and in another activity status (default: `false`). */
autoTenantActivation?: boolean;
};
/** @description Configuration of objects' time-to-live */
ObjectTtlConfig: {
/** @description Whether or not object ttl is enabled for this collection (default: `false`). */
enabled?: boolean;
/** @description Interval (in seconds) to be added to `deleteOn` value, denoting object's expiration time. Has to be positive for `deleteOn` set to `_creationTimeUnix` or `_lastUpdateTimeUnix`, any for custom property (default: `0`). */
defaultTtl?: number;
/** @description Name of the property holding base time to compute object's expiration time (ttl = value of deleteOn property + defaultTtl). Can be set to `_creationTimeUnix`, `_lastUpdateTimeUnix` or custom property of `date` datatype. */
deleteOn?: string;
/** @description Whether remove from resultset expired, but not yet deleted by background process objects (default: `false`). */
filterExpiredObjects?: boolean;
};
/** @description JSON object value. */
JsonObject: {
[key: string]: unknown;
};
/** @description Contains meta information of the current Weaviate instance. */
Meta: {
/**
* Format: url
* @description The url of the host.
*/
hostname?: string;
/** @description The Weaviate server version. */
version?: string;
/** @description Module-specific meta information. */
modules?: {
[key: string]: unknown;
};
/** @description Max message size for GRPC connection in bytes. */
grpcMaxMessageSize?: number;
};
/** @description Multiple instances of references to other objects. */
MultipleRef: definitions['SingleRef'][];
/** @description Specifies the parameters required to initiate a shard replica movement operation between two nodes for a given collection and shard. This request defines the source and target node, the collection and type of transfer. */
ReplicationReplicateReplicaRequest: {
/** @description The name of the Weaviate node currently hosting the shard replica that needs to be moved or copied. */
sourceNode: string;
/** @description The name of the Weaviate node where the new shard replica will be created as part of the movement or copy operation. */
targetNode: string;
/** @description The name of the collection to which the target shard belongs. */
collection: string;
/** @description The name of the shard whose replica is to be moved or copied. */
shard: string;
/**
* @description Specifies the type of replication operation to perform. `COPY` creates a new replica on the target node while keeping the source replica. `MOVE` creates a new replica on the target node and then removes the source replica upon successful completion. Defaults to `COPY` if omitted.
* @default COPY
* @enum {string}
*/
type?: 'COPY' | 'MOVE';
};
/** @description Contains the unique identifier for a successfully initiated asynchronous replica movement operation. This ID can be used to track the progress of the operation. */
ReplicationReplicateReplicaResponse: {
/**
* Format: uuid
* @description The unique identifier (ID) assigned to the registered replication operation.
*/
id: string;
};
/** @description Provides the detailed sharding state for one or more collections, including the distribution of shards and their replicas across the cluster nodes. */
ReplicationShardingStateResponse: {
shardingState?: definitions['ReplicationShardingState'];
};
/** @description Defines a complete plan for scaling replication within a collection. Each shard entry specifies nodes to remove and nodes to add. Added nodes may either be initialized empty (null) or created by replicating data from a source node specified as a string. If a source node is also marked for removal in the same shard, it represents a move operation and can only be used once as a source for that shard. If a source node is not marked for removal, it represents a copy operation and can be used as the source for multiple additions in that shard. Nodes listed in 'removeNodes' cannot also appear as targets in 'addNodes' for the same shard, and the same node cannot be specified for both addition and removal in a single shard. */
ReplicationScalePlan: {
/**
* Format: uuid
* @description A unique identifier for this replication scaling plan, useful for tracking and auditing purposes.
*/
planId: string;
/** @description The name of the collection to which this replication scaling plan applies. */
collection: string;
/** @description A mapping of shard names to their corresponding scaling actions. Each key corresponds to a shard name, and its value defines which nodes should be removed and which should be added for that shard. If a source node listed for an addition is also in 'removeNodes' for the same shard, that addition is treated as a move operation. Such a node can appear only once as a source in that shard. Otherwise, if the source node is not being removed, it represents a copy operation and can be referenced multiple times as a source for additions. */
shardScaleActions: {
[key: string]: {
/** @description List of node identifiers from which replicas of this shard should be removed. Nodes listed here must not appear in 'addNodes' for the same shard, and cannot be used as a source node for any addition in this shard except in the implicit move case, where they appear as both a source and a node to remove. */
removeNodes?: string[];
/** @description A mapping of target node identifiers to their addition configuration. Each key represents a target node where a new replica will be added. The value may be null, which means an empty replica will be created, or a string specifying the source node from which shard data will be copied. If the source node is also marked for removal in the same shard, this addition is treated as a move operation, and that source node can only appear once as a source node for that shard. If the source node is not being removed, it can be used as the source for multiple additions (copy operations). */
addNodes?: {
[key: string]: unknown;
};
};
};
};
/** @description Response for the POST /replication/scale endpoint containing the list of initiated shard copy operation IDs. */
ReplicationScaleApplyResponse: {
/** @description List of shard copy operation IDs created during scaling. */
operationIds: string[];
/**
* Format: uuid
* @description The unique identifier of the replication scaling plan that generated these operations.
*/
planId: string;
/** @description The name of the collection associated with this replication scaling plan. */
collection: string;
};
/** @description Represents a shard and lists the nodes that currently host its replicas. */
ReplicationShardReplicas: {
shard?: string;
replicas?: string[];
};
/** @description Details the sharding layout for a specific collection, mapping each shard to its set of replicas across the cluster. */
ReplicationShardingState: {
/** @description The name of the collection. */
collection?: string;
/** @description An array detailing each shard within the collection and the nodes hosting its replicas. */
shards?: definitions['ReplicationShardReplicas'][];
};
/** @description Represents an error encountered during a replication operation, including its timestamp and a human-readable message. */
ReplicationReplicateDetailsReplicaStatusError: {
/**
* Format: int64
* @description The unix timestamp in ms when the error occurred. This is an approximate time and so should not be used for precise timing.
*/
whenErroredUnixMs?: number;
/** @description A human-readable message describing the error. */
message?: string;
};
/** @description Represents the current or historical status of a shard replica involved in a replication operation, including its operational state and any associated errors. */
ReplicationReplicateDetailsReplicaStatus: {
/**
* @description The current operational state of the replica during the replication process.
* @enum {string}
*/
state?: 'REGISTERED' | 'HYDRATING' | 'FINALIZING' | 'DEHYDRATING' | 'READY' | 'CANCELLED';
/**
* Format: int64
* @description The UNIX timestamp in ms when this state was first entered. This is an approximate time and so should not be used for precise timing.
*/
whenStartedUnixMs?: number;
/** @description A list of error messages encountered by this replica during the replication operation, if any. */
errors?: definitions['ReplicationReplicateDetailsReplicaStatusError'][];
};
/** @description Provides a comprehensive overview of a specific replication operation, detailing its unique ID, the involved collection, shard, source and target nodes, transfer type, current status, and optionally, its status history. */
ReplicationReplicateDetailsReplicaResponse: {
/**
* Format: uuid
* @description The unique identifier (ID) of this specific replication operation.
*/
id: string;
/** @description The name of the shard involved in this replication operation. */
shard: string;
/** @description The name of the collection to which the shard being replicated belongs. */
collection: string;
/** @description The identifier of the node from which the replica is being moved or copied (the source node). */
sourceNode: string;
/** @description The identifier of the node to which the replica is being moved or copied (the target node). */
targetNode: string;
/**
* @description Indicates whether the operation is a `COPY` (source replica remains) or a `MOVE` (source replica is removed after successful transfer).
* @enum {string}
*/
type: 'COPY' | 'MOVE';
/** @description Whether the replica operation can't be cancelled. */
uncancelable?: boolean;
/** @description Whether the replica operation is scheduled for cancellation. */
scheduledForCancel?: boolean;
/** @description Whether the replica operation is scheduled for deletion. */
scheduledForDelete?: boolean;
/** @description An object detailing the current operational state of the replica movement and any errors encountered. */
status: definitions['ReplicationReplicateDetailsReplicaStatus'];
/** @description An array detailing the historical sequence of statuses the replication operation has transitioned through, if requested and available. */
statusHistory?: definitions['ReplicationReplicateDetailsReplicaStatus'][];
/**
* Format: int64
* @description The UNIX timestamp in ms when the replication operation was initiated. This is an approximate time and so should not be used for precise timing.
*/
whenStartedUnixMs?: number;
};
/** @description Specifies the parameters available when force deleting replication operations. */
ReplicationReplicateForceDeleteRequest: {
/**
* Format: uuid
* @description The unique identifier (ID) of the replication operation to be forcefully deleted.
*/
id?: string;
/** @description The name of the collection to which the shard being replicated belongs. */
collection?: string;
/** @description The identifier of the shard involved in the replication operations. */
shard?: string;
/** @description The name of the target node where the replication operations are registered. */
node?: string;
/**
* @description If true, the operation will not actually delete anything but will return the expected outcome of the deletion.
* @default false
*/
dryRun?: boolean;
};
/** @description Provides the UUIDs that were successfully force deleted as part of the replication operation. If dryRun is true, this will return the expected outcome without actually deleting anything. */
ReplicationReplicateForceDeleteResponse: {
/** @description The unique identifiers (IDs) of the replication operations that were forcefully deleted. */
deleted?: string[];
/** @description Indicates whether the operation was a dry run (true) or an actual deletion (false). */
dryRun?: boolean;
};
/** @description A single peer in the network. */
PeerUpdate: {
/**
* Format: uuid
* @description The session ID of the peer.
*/
id?: string;
/** @description Human readable name. */
name?: string;
/**
* Format: uri
* @description The location where the peer is exposed to the internet.
*/
uri?: string;
/** @description The latest known hash of the peer's schema. */
schemaHash?: string;
};
/** @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. */
VectorWeights: {
[key: string]: unknown;
};
/** @description Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection. */
PropertySchema: {
[key: string]: unknown;
};
/** @description Definitions of semantic schemas (also see: https://github.com/weaviate/weaviate-semantic-schemas). */
Schema: {
/** @description Semantic classes that are available. */
classes?: definitions['Class'][];
/**
* Format: email
* @description Email of the maintainer.
*/
maintainer?: string;
/** @description Name of the schema. */
name?: string;
};
Class: {
/** @description Name of the collection (formerly 'class') (required). Multiple words should be concatenated in CamelCase, e.g. `ArticleAuthor`. */
class?: string;
/** @description Configure named vectors. Either use this field or `vectorizer`, `vectorIndexType`, and `vectorIndexConfig` fields. Available from `v1.24.0`. */
vectorConfig?: {
[key: string]: definitions['VectorConfig'];
};
/** @description Name of the vector index type to use for the collection (e.g. `hnsw` or `flat`). */
vectorIndexType?: string;
/** @description Vector-index config, that is specific to the type of index selected in vectorIndexType */
vectorIndexConfig?: {
[key: string]: unknown;
};
/** @description Manage how the index should be sharded and distributed in the cluster */
shardingConfig?: {
[key: string]: unknown;
};
replicationConfig?: definitions['ReplicationConfig'];
invertedIndexConfig?: definitions['InvertedIndexConfig'];
multiTenancyConfig?: definitions['MultiTenancyConfig'];
objectTtlConfig?: definitions['ObjectTtlConfig'];
/** @description Specify how the vectors for this collection should be determined. The options are either `none` - this means you have to import a vector with each object yourself - or the name of a module that provides vectorization capabilities, such as `text2vec-weaviate`. If left empty, it will use the globally configured default ([`DEFAULT_VECTORIZER_MODULE`](https://docs.weaviate.io/deploy/configuration/env-vars)) which can itself either be `none` or a specific module. */
vectorizer?: string;
/** @description Configuration specific to modules in a collection context. */
moduleConfig?: {
[key: string]: unknown;
};
/** @description Description of the collection for metadata purposes. */
description?: string;
/** @description Define properties of the collection. */
properties?: definitions['Property'][];
};
Property: {
/** @description Data type of the property (required). If it starts with a capital (for example Person), may be a reference to another type. */
dataType?: string[];
/** @description Description of the property. */
description?: string;
/** @description Configuration specific to modules in a collection context. */
moduleConfig?: {
[key: string]: unknown;
};
/** @description The name of the property (required). Multiple words should be concatenated in camelCase, e.g. `nameOfAuthor`. */
name?: string;
/** @description (Deprecated). Whether to include this property in the inverted index. If `false`, this property cannot be used in `where` filters, `bm25` or `hybrid` search.
Unrelated to vectorization behavior (deprecated as of v1.19; use indexFilterable or/and indexSearchable instead) */
indexInverted?: boolean;
/** @description Whether to include this property in the filterable, Roaring Bitmap index. If `false`, this property cannot be used in `where` filters.
Note: Unrelated to vectorization behavior. */
indexFilterable?: boolean;
/** @description Optional. Should this property be indexed in the inverted index. Defaults to true. Applicable only to properties of data type text and text[]. If you choose false, you will not be able to use this property in bm25 or hybrid search. This property has no affect on vectorization decisions done by modules */
indexSearchable?: boolean;
/** @description Whether to include this property in the filterable, range-based Roaring Bitmap index. Provides better performance for range queries compared to filterable index in large datasets. Applicable only to properties of data type int, number, date. */
indexRangeFilters?: boolean;
/**
* @description Determines how a property is indexed. This setting applies to `text` and `text[]` data types. The following tokenization methods are available:
- `word` (default): Splits the text on any non-alphanumeric characters and lowercases the tokens.
- `lowercase`: Splits the text on whitespace and lowercases the tokens.
- `whitespace`: Splits the text on whitespace. This tokenization is case-sensitive.
- `field`: Indexes the entire property value as a single token after trimming whitespace.
- `trigram`: Splits the property into rolling trigrams (three-character sequences).
- `gse`: Uses the `gse` tokenizer, suitable for Chinese language text. [See `gse` docs](https://pkg.go.dev/github.com/go-ego/gse#section-readme).
- `kagome_ja`: Uses the `Kagome` tokenizer with a Japanese (IPA) dictionary. [See `kagome` docs](https://github.com/ikawaha/kagome).
- `kagome_kr`: Uses the `Kagome` tokenizer with a Korean dictionary. [See `kagome` docs](https://github.com/ikawaha/kagome).
See [Reference: Tokenization](https://docs.weaviate.io/weaviate/config-refs/collections#tokenization) for details.
* @enum {string}
*/
tokenization?: 'word' | 'lowercase' | 'whitespace' | 'field' | 'trigram' | 'gse' | 'kagome_kr' | 'kagome_ja' | 'gse_ch';
/** @description The properties of the nested object(s). Applies to object and object[] data types. */
nestedProperties?: definitions['NestedProperty'][];
/**
* @description If set to false, allows multiple references to the same target object within this property. Setting it to true will enforce uniqueness of references within this property. By default, this is set to true.
* @default true
*/
disableDuplicatedReferences?: boolean;
textAnalyzer?: definitions['TextAnalyzerConfig'];
};
/** @description Text analysis options for a property. The asciiFold setting is immutable after creation, while the asciiFoldIgnore list can be updated later; changes to asciiFoldIgnore only affect newly indexed data and do not retroactively re-index existing data. Applies only to text and text[] data types that use an inverted index (searchable or filterable). */
TextAnalyzerConfig: {
/** @description If true, accent/diacritic marks are folded to their base characters during indexing and search. For example, 'école' matches 'ecole'. Defaults to false. */
asciiFold?: boolean;
/** @description If provided, specifies a list of characters that should be excluded from ascii folding. For example, if ['é'] is provided, then 'é' will not be folded to 'e' during indexing and search. This list can be updated after the property is created, but updates only affect documents indexed after the change. */
asciiFoldIgnore?: string[];
/** @description Stopword preset name. Overrides the collection-level invertedIndexConfig.stopwords for this property. Only applies to properties using 'word' tokenization. Can be a built-in preset ('en', 'none') or a user-defined preset from invertedIndexConfig.stopwordPresets. */
stopwordPreset?: string;
};
VectorConfig: {
/** @description Configuration of a specific vectorizer used by this vector */
vectorizer?: {
[key: string]: unknown;
};
/** @description Name of the vector index to use, eg. (HNSW) */
vectorIndexType?: string;
/** @description Vector-index config, that is specific to the type of index selected in vectorIndexType */
vectorIndexConfig?: {
[key: string]: unknown;
};
};
NestedProperty: {
dataType?: string[];
description?: string;
name?: string;
indexFilterable?: boolean;
indexSearchable?: boolean;
indexRangeFilters?: boolean;
/** @enum {string} */
tokenization?: 'word' | 'lowercase' | 'whitespace' | 'field' | 'trigram' | 'gse' | 'kagome_kr' | 'kagome_ja' | 'gse_ch';
/** @description The properties of the nested object(s). Applies to object and object[] data types. */
nestedProperties?: definitions['NestedProperty'][];
textAnalyzer?: definitions['TextAnalyzerConfig'];
};
/** @description The status of all the shards of a Class */
ShardStatusList: definitions['ShardStatusGetResponse'][];
/** @description Response body of shard status get request */
ShardStatusGetResponse: {
/** @description Name of the shard */
name?: string;
/** @description Status of the shard */
status?: string;
/** @description Size of the vector queue of the shard */
vectorQueueSize?: number;
};
/** @description The status of a single shard */
ShardStatus: {
/** @description Status of the shard */
status?: string;
};
/** @description The definition of a backup create metadata */
BackupCreateStatusResponse: {
/** @description The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed. */
id?: string;
/** @description Backup backend name e.g. filesystem, gcs, s3. */
backend?: string;
/** @description Destination path of backup files valid for the selected backend. */
path?: string;
/** @description error message if creation failed */
error?: string;
/**
* @description phase of backup creation process
* @default STARTED
* @enum {string}
*/
status?: 'STARTED' | 'TRANSFERRING' | 'TRANSFERRED' | 'FINALIZING' | 'SUCCESS' | 'FAILED' | 'CANCELLING' | 'CANCELED';
/**
* Format: date-time
* @description Timestamp when the backup process started
*/
startedAt?: string;
/**
* Format: date-time
* @description Timestamp when the backup process completed (successfully or with failure)
*/
completedAt?: string;
/**
* Format: float64
* @description Size of the backup in Gibs
*/
size?: number;
};
/** @description The definition of a backup restore metadata. */
BackupRestoreStatusResponse: {
/** @description The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed. */
id?: string;
/** @description Backup backend name e.g. filesystem, gcs, s3. */
backend?: string;
/** @description Destination path of backup files valid for the selected backup backend, contains bucket and path. */
path?: string;
/** @description Error message if backup restoration failed. */
error?: string;
/**
* @description Phase of backup restoration process.
* @default STARTED
* @enum {string}
*/
status?: 'STARTED' | 'TRANSFERRING' | 'TRANSFERRED' | 'FINALIZING' | 'SUCCESS' | 'FAILED' | 'CANCELLING' | 'CANCELED';
};
/** @description Backup custom configuration. */
BackupConfig: {
/** @description Name of the endpoint, e.g. s3.amazonaws.com. */
Endpoint?: string;
/** @description Name of the bucket, container, volume, etc. */
Bucket?: string;
/** @description Path or key within the bucket. */
Path?: string;
/**
* @description Desired CPU core utilization ranging from 1%-80%
* @default 50
*/
CPUPercentage?: number;
/** @description Deprecated, has no effect. */
ChunkSize?: number;
/**
* @description compression level used by compression algorithm
* @default DefaultCompression
* @enum {string}
*/
CompressionLevel?: 'DefaultCompression' | 'BestSpeed' | 'BestCompression' | 'ZstdDefaultCompression' | 'ZstdBestSpeed' | 'ZstdBestCompression' | 'NoCompression';
};
/** @description Backup custom configuration */
RestoreConfig: {
/** @description name of the endpoint, e.g. s3.amazonaws.com */
Endpoint?: string;
/** @description Name of the bucket, container, volume, etc */
Bucket?: string;
/** @description Path within the bucket */
Path?: string;
/**
* @description Desired CPU core utilization ranging from 1%-80%
* @default 50
*/
CPUPercentage?: number;
/**
* @description How roles should be restored
* @default noRestore
* @enum {string}
*/
rolesOptions?: 'noRestore' | 'all';
/**
* @description How users should be restored
* @default noRestore
* @enum {string}
*/
usersOptions?: 'noRestore' | 'all';
};
/** @description Request body for creating a backup for a set of collections. */
BackupCreateRequest: {
/** @description The ID of the backup (required). Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed. */
id?: string;
/** @description Custom configuration for the backup creation process */
config?: definitions['BackupConfig'];
/** @description List of collections to include in the backup creation process. If not set, all collections are included. Cannot be used together with `exclude`. */
include?: string[];
/** @description List of collections to exclude from the backup creation process. If not set, all collections are included. Cannot be used together with `include`. */
exclude?: string[];
/**
* @description The ID of an existing backup to use as the base for a file-based incremental backup. If set, only files that have changed since the base backup will be included in the new backup.
* @default null
*/
incremental_base_backup_id?: string;
};
/** @description The definition of a backup create response body */
BackupCreateResponse: {
/** @description The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed. */
id?: string;
/** @description The list of collections (classes) for which the backup creation process was started. */
classes?: string[];
/** @description Backup backend name e.g. filesystem, gcs, s3. */
backend?: string;
/** @description Name of the bucket, container, volume, etc */
bucket?: string;
/** @description Path within bucket of backup */
path?: string;
/** @description error message if creation failed */
error?: string;
/**
* @description phase of backup creation process
* @default STARTED
* @enum {string}
*/
status?: 'STARTED' | 'TRANSFERRING' | 'TRANSFERRED' | 'FINALIZING' | 'SUCCESS' | 'FAILED' | 'CANCELLING' | 'CANCELED';
};
/** @description The definition of a backup create response body. */
BackupListResponse: {
/** @description The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed. */
id?: string;
/** @description The list of collections (classes) for which the backup process was started. */
classes?: string[];
/**
* @description Status of backup process.
* @enum {string}
*/
status?: 'STARTED' | 'TRANSFERRING' | 'TRANSFERRED' | 'FINALIZING' | 'SUCCESS' | 'FAILED' | 'CANCELLING' | 'CANCELED';
/**
* Format: date-time
* @description Timestamp when the backup process started
*/
startedAt?: string;
/**
* Format: date-time
* @description Timestamp when the backup process completed (successfully or with failure)
*/
completedAt?: string;
/**
* Format: float64
* @description Size of the backup in Gibs
*/
size?: number;
}[];
/** @description Request body for restoring a backup for a set of collections (classes). */
BackupRestoreRequest: {
/** @description Custom configuration for the backup restoration process. */
config?: definitions['RestoreConfig'];
/** @description List of collections (classes) to include in the backup restoration process. */
include?: string[];
/** @description List of collections (classes) to exclude from the backup restoration process. */
exclude?: string[];
/** @description Allows overriding the node names stored in the backup with different ones. Useful when restoring backups to a different environment. */
node_mapping?: {
[key: string]: string;
};
/** @description Allows ovewriting the collection alias if there is a conflict */
overwriteAlias?: boolean;
};
/** @description The definition of a backup restore response body. */
BackupRestoreResponse: {
/** @description The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed. */
id?: string;
/** @description The list of collections (classes) for which the backup restoration process was started. */
classes?: string[];
/** @description Backup backend name e.g. filesystem, gcs, s3. */
backend?: string;
/** @description Destination path of backup files valid for the selected backend. */
path?: string;
/** @description Error message if backup restoration failed. */
error?: string;
/**
* @description Phase of backup restoration process.
* @default STARTED
* @enum {string}
*/
status?: 'STARTED' | 'TRANSFERRING' | 'TRANSFERRED' | 'FINALIZING' | 'SUCCESS' | 'FAILED' | 'CANCELLING' | 'CANCELED';
};
/** @description The summary of Weaviate's statistics. */
NodeStats: {
/**
* Format: int
* @description The count of Weaviate's shards. To see this value, set `output` to `verbose`.
*/
shardCount?: number;
/**
* Format: int64
* @description The total number of objects in DB.
*/
objectCount?: number;
};
/** @description The summary of a nodes batch queue congestion status. */
BatchStats: {
/**
* Format: int
* @description How many objects are currently in the batch queue.
*/
queueLength?: number;
/**
* Format: int
* @description How many objects are approximately processed from the batch queue per second.
*/
ratePerSecond?: number;
};
/** @description The definition of a node shard status response body */
NodeShardStatus: {
/** @description The name of the shard. */
name?: string;
/** @description The name of shard's collection (class). */
class?: string;
/**
* Format: int64
* @description The number of objects in shard.
*/
objectCount?: number;
/** @description The status of the vector indexing process. */
vectorIndexingStatus?: string;
/** @description The status of vector compression/quantization. */
compressed?: boolean;
/**
* Format: int64
* @description The length of the vector indexing queue.
*/
vectorQueueLength?: number;
/** @description The load status of the shard. */
loaded?: boolean;
/** @description The status of the async replication. */
asyncReplicationStatus?: definitions['AsyncReplicationStatus'][];
/**
* Format: int64
* @description Number of replicas for the shard.
*/
numberOfReplicas?: unknown;
/**
* Format: int64
* @description Minimum number of replicas for the shard.
*/
replicationFactor?: unknown;
};
/** @description The status of the async replication. */
AsyncReplicationStatus: {
/**
* Format: uint64
* @description The number of objects propagated in the most recent iteration.
*/
objectsPropagated?: number;
/**
* Format: int64
* @description The start time of the most recent iteration.
*/
startDiffTimeUnixMillis?: number;
/** @description The target node of the replication, if set, otherwise empty. */
targetNode?: string;
};
/** @description Configuration for asynchronous replication. */
ReplicationAsyncConfig: {
/**
* Format: int64
* @description Maximum number of async replication workers.
*/
maxWorkers?: number;
/**
* Format: int64
* @description Height of the hashtree used for diffing.
*/
hashtreeHeight?: number;
/**
* Format: int64
* @description Base frequency in milliseconds at which async replication runs diff calculations.
*/
frequency?: number;
/**
* Format: int64
* @description Frequency in milliseconds at which async replication runs while propagation is active.
*/
frequencyWhilePropagating?: number;
/**
* Format: int64
* @description Interval in milliseconds at which liveness of target nodes is checked.
*/
aliveNodesCheckingFrequency?: number;
/**
* Format: int64
* @description Interval in seconds at which async replication logs its status.
*/
loggingFrequency?: number;
/**
* Format: int64
* @description Maximum number of object keys included in a single diff batch.
*/
diffBatchSize?: number;
/**
* Format: int64
* @description Timeout in seconds for computing a diff against a single node.
*/
diffPerNodeTimeout?: number;
/**
* Format: int64
* @description Overall timeout in seconds for the pre-propagation phase.
*/
prePropagationTimeout?: number;
/**
* Format: int64
* @description Timeout in seconds for propagating batch of changes to a node.
*/
propagationTimeout?: number;
/**
* Format: int64
* @description Maximum number of objects to propagate in a single async replication run.
*/
propagationLimit?: number;
/**
* Format: int64
* @description Delay in milliseconds before newly added or updated objects are propagated.
*/
propagationDelay?: number;
/**
* Format: int64
* @description Maximum number of concurrent propagation workers.
*/
propagationConcurrency?: number;
/**
* Format: int64
* @description Number of objects to include in a single propagation batch.
*/
propagationBatchSize?: number;
};
/** @description The definition of a backup node status response body */
NodeStatus: {
/** @description The name of the node. */
name?: string;
/**
* @description Node's status.
* @default HEALTHY
* @enum {string}
*/
status?: 'HEALTHY' | 'UNHEALTHY' | 'UNAVAILABLE' | 'TIMEOUT';
/** @description The version of Weaviate. */
version?: string;
/** @description The gitHash of Weaviate. */
gitHash?: string;
/** @description Weaviate overall statistics. */
stats?: definitions['NodeStats'];
/** @description Weaviate batch statistics. */
batchStats?: definitions['BatchStats'];
/** @description The list of the shards with it's statistics. */
shards?: definitions['NodeShardStatus'][];
/**
* @description Which mode of operation the node is running in.
* @enum {string}
*/
operationalMode?: 'ReadWrite' | 'WriteOnly' | 'ReadOnly' | 'ScaleOut';
};
/** @description The status of all of the Weaviate nodes */
NodesStatusResponse: {
nodes?: definitions['NodeStatus'][];
};
/** @description Distributed task metadata. */
DistributedTask: {
/** @description The ID of the task. */
id?: string;
/** @description The version of the task. */
version?: number;
/** @description The status of the task. */
status?: string;
/**
* Format: date-time
* @description The time when the task was created.
*/
startedAt?: string;
/**
* Format: date-time
* @description The time when the task was finished.
*/
finishedAt?: string;
/** @description The nodes that finished the task. */
finishedNodes?: string[];
/** @description The high level reason why the task failed. */
error?: string;
/** @description The payload of the task. */
payload?: {
[key: string]: unknown;
};
/** @description Units of the task. Only present for tasks that use unit tracking. */
units?: definitions['DistributedTaskUnit'][];
};
/** @description A unit of a distributed task. */
DistributedTaskUnit: {
/** @description The ID of the unit. */
id?: string;
/** @description The node that owns this unit. */
nodeId?: string;
/** @description The status of the unit. */
status?: string;
/**
* Format: float
* @description The progress of the unit (0.0 to 1.0).
*/
progress?: number;
/** @description The error message if the unit failed. */
error?: string;
/**
* Format: date-time
* @description The time when the unit was last updated.
*/
updatedAt?: string;
/**
* Format: date-time
* @description The time when the unit finished.
*/
finishedAt?: string;
};
/** @description Active distributed tasks by namespace. */
DistributedTasks: {
[key: string]: definitions['DistributedTask'][];
};
/** @description The definition of Raft statistics. */
RaftStatistics: {
appliedIndex?: string;
commitIndex?: string;
fsmPending?: string;
lastContact?: string;
lastLogIndex?: string;
lastLogTerm?: string;
lastSnapshotIndex?: string;
lastSnapshotTerm?: string;
/** @description Weaviate Raft nodes. */
latestConfiguration?: {
[key: string]: unknown;
};
latestConfigurationIndex?: string;
numPeers?: string;
protocolVersion?: string;
protocolVersionMax?: string;
protocolVersionMin?: string;
snapshotVersionMax?: string;
snapshotVersionMin?: string;
state?: string;
term?: string;
};
/** @description The definition of node statistics. */
Statistics: {
/** @description The name of the node. */
name?: string;
/**
* @description Node's status.
* @default HEALTHY
* @enum {string}
*/
status?: 'HEALTHY' | 'UNHEALTHY' | 'UNAVAILABLE' | 'TIMEOUT';
bootstrapped?: boolean;
dbLoaded?: boolean;
/** Format: uint64 */
initialLastAppliedIndex?: number;
lastAppliedIndex?: number;
isVoter?: boolean;
leaderId?: {
[key: string]: unknown;
};
leaderAddress?: {
[key: string]: unknown;
};
open?: boolean;
ready?: boolean;
candidates?: {
[key: string]: unknown;
};
/** @description Weaviate Raft statistics. */
raft?: definitions['RaftStatistics'];
};
/** @description The cluster statistics of all of the Weaviate nodes */
ClusterStatisticsResponse: {
statistics?: definitions['Statistics'][];
synchronized?: boolean;
};
/** @description Either set beacon (direct reference) or set collection (class) and schema (concept reference) */
SingleRef: {
/**
* Format: uri
* @description If using a concept reference (rather than a direct reference), specify the desired collection (class) name here.
*/
class?: string;
/** @description If using a concept reference (rather than a direct reference), specify the desired properties here */
schema?: definitions['PropertySchema'];
/**
* Format: uri
* @description If using a direct reference, specify the URI to point to the cross-reference here. Should be in the form of weaviate://localhost/ for the example of a local cross-reference to an object
*/
beacon?: string;
/**
* Format: uri
* @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.
*/
href?: string;
/** @description Additional Meta information about classifications if the item was part of one */
classification?: definitions['ReferenceMetaClassification'];
};
/** @description (Response only) Additional meta information about a single object. */
AdditionalProperties: {
[key: string]: {
[key: string]: unknown;
};
};
/** @description This meta field contains additional info about the classified reference property */
ReferenceMetaClassification: {
/**
* Format: int64
* @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
*/
overallCount?: number;
/**
* Format: int64
* @description size of the winning group, a number between 1..k
*/
winningCount?: number;
/**
* Format: int64
* @description size of the losing group, can be 0 if the winning group size equals k
*/
losingCount?: number;
/**
* Format: float32
* @description The lowest distance of any neighbor, regardless of whether they were in the winning or losing group
*/
closestOverallDistance?: number;
/**
* Format: float32
* @description deprecated - do not use, to be removed in 0.23.0
*/
winningDistance?: number;
/**
* Format: float32
* @description Mean distance of all neighbors from the winning group
*/
meanWinningDistance?: number;
/**
* Format: float32
* @description Closest distance of a neighbor from the winning group
*/
closestWinningDistance?: number;
/**
* Format: float32
* @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
*/
closestLosingDistance?: number;
/**
* Format: float32
* @description deprecated - do not use, to be removed in 0.23.0
*/
losingDistance?: number;
/**
* Format: float32
* @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.
*/
meanLosingDistance?: number;
};
BatchReference: {
/**
* Format: uri
* @description Long-form beacon-style URI to identify the source of the cross-reference, including the property name. Should be in the form of `weaviate://localhost/objects///`, where `` and `` must represent the cross-reference property of the source class to be used.
* @example weaviate://localhost/Zoo/a5d09582-4239-4702-81c9-92a6e0122bb4/hasAnimals
*/
from?: string;
/**
* Format: uri
* @description Short-form URI to point to the cross-reference. Should be in the form of `weaviate://localhost/` for the example of a local cross-reference to an object.
* @example weaviate://localhost/97525810-a9a5-4eb0-858a-71449aeb007f
*/
to?: string;
/** @description Name of the reference tenant. */
tenant?: string;
};
BatchReferenceResponse: definitions['BatchReference'] & {
/**
* Format: object
* @description Results for this specific reference.
*/
result?: {
/**
* @default SUCCESS
* @enum {string}
*/
status?: 'SUCCESS' | 'FAILED';
errors?: definitions['ErrorResponse'];
};
};
GeoCoordinates: {
/**
* Format: float
* @description The latitude of the point on earth in decimal form.
*/
latitude?: number;
/**
* Format: float
* @description The longitude of the point on earth in decimal form.
*/
longitude?: number;
};
PhoneNumber: {
/** @description The raw input as the phone number is present in your raw data set. It will be parsed into the standardized formats if valid. */
input?: string;
/** @description Read-only. Parsed result in the international format (e.g. `+49 123 456789`). */
internationalFormatted?: string;
/** @description Optional. The ISO 3166-1 alpha-2 country code. This is used to figure out the correct `countryCode` and international format if only a national number (e.g. `0123 4567`) is provided. */
defaultCountry?: string;
/**
* Format: uint64
* @description Read-only. The numerical country code (e.g. `49`).
*/
countryCode?: number;
/**
* Format: uint64
* @description Read-only. The numerical representation of the national part.
*/
national?: number;
/** @description Read-only. Parsed result in the national format (e.g. `0123 456789`). */
nationalFormatted?: string;
/** @description Read-only. Indicates whether the parsed number is a valid phone number. */
valid?: boolean;
};
Object: {
/** @description Name of the collection (class) the object belongs to. */
class?: string;
vectorWeights?: definitions['VectorWeights'];
properties?: definitions['PropertySchema'];
/**
* Format: uuid
* @description The UUID of the object.
*/
id?: string;
/**
* Format: int64
* @description (Response only) Timestamp of creation of this object in milliseconds since epoch UTC.
*/
creationTimeUnix?: number;
/**
* Format: int64
* @description (Response only) Timestamp of the last object update in milliseconds since epoch UTC.
*/
lastUpdateTimeUnix?: number;
/** @description This field returns vectors associated with the object. C11yVector, Vector or Vectors values are possible. */
vector?: definitions['C11yVector'];
/** @description This field returns vectors associated with the object. */
vectors?: definitions['Vectors'];
/** @description The name of the tenant the object belongs to. */
tenant?: string;
additional?: definitions['AdditionalProperties'];
};
ObjectsGetResponse: definitions['Object'] & {
deprecations?: definitions['Deprecation'][];
} & {
/**
* Format: object
* @description Results for this specific object.
*/
result?: {
/**
* @default SUCCESS
* @enum {string}
*/
status?: 'SUCCESS' | 'FAILED';
errors?: definitions['ErrorResponse'];
};
};
BatchDelete: {
/** @description Outlines how to find the objects to be deleted. */
match?: {
/**
* @description The name of the collection (class) from which to delete objects.
* @example City
*/
class?: string;
/** @description Filter to limit the objects to be deleted. */
where?: definitions['WhereFilter'];
};
/**
* @description Controls the verbosity of the output, possible values are: `minimal`, `verbose`. Defaults to `minimal`.
* @default minimal
*/
output?: string;
/**
* Format: int64
* @description Timestamp of deletion in milliseconds since epoch UTC.
*/
deletionTimeUnixMilli?: number;
/**
* @description If true, the call will show which objects would be matched using the specified filter without deleting any objects.
Depending on the configured verbosity, you will either receive a count of affected objects, or a list of IDs.
* @default false
*/
dryRun?: boolean;
};
/** @description Delete Objects response. */
BatchDeleteResponse: {
/** @description Outlines how to find the objects to be deleted. */
match?: {
/**
* @description The name of the collection (class) from which to delete objects.
* @example City
*/
class?: string;
/** @description Filter to limit the objects to be deleted. */
where?: definitions['WhereFilter'];
};
/**
* @description Controls the verbosity of the output, possible values are: `minimal`, `verbose`. Defaults to `minimal`.
* @default minimal
*/
output?: string;
/**
* Format: int64
* @description Timestamp of deletion in milliseconds since epoch UTC.
*/
deletionTimeUnixMilli?: number;
/**
* @description If true, objects will not be deleted yet, but merely listed. Defaults to false.
* @default false
*/
dryRun?: boolean;
results?: {
/**
* Format: int64
* @description How many objects were matched by the filter.
*/
matches?: number;
/**
* Format: int64
* @description The most amount of objects that can be deleted in a single query, equals [`QUERY_MAXIMUM_RESULTS`](https://docs.weaviate.io/deploy/configuration/env-vars#QUERY_MAXIMUM_RESULTS).
*/
limit?: number;
/**
* Format: int64
* @description How many objects were successfully deleted in this round.
*/
successful?: number;
/**
* Format: int64
* @description How many objects should have been deleted but could not be deleted.
*/
failed?: number;
/** @description With output set to `minimal` only objects with error occurred will the be described. Successfully deleted objects would be omitted. Output set to `verbose` will list all of the objects with their respective statuses. */
objects?: {
/**
* Format: uuid
* @description The UUID of the object.
*/
id?: string;
/**
* @default SUCCESS
* @enum {string}
*/
status?: 'SUCCESS' | 'DRYRUN' | 'FAILED';
errors?: definitions['ErrorResponse'];
}[];
};
};
/** @description List of objects. */
ObjectsListResponse: {
/** @description The actual list of objects. */
objects?: definitions['Object'][];
deprecations?: definitions['Deprecation'][];
/**
* Format: int64
* @description The total number of objects for the query. The number of items in a response may be smaller due to paging.
*/
totalResults?: number;
};
/** @description Manage classifications, trigger them and view status of past classifications. */
Classification: {
/**
* Format: uuid
* @description ID to uniquely identify this classification run.
* @example ee722219-b8ec-4db1-8f8d-5150bb1a9e0c
*/
id?: string;
/**
* @description The name of the collection (class) which is used in this classification.
* @example City
*/
class?: string;
/**
* @description Which ref-property to set as part of the classification.
* @example [
* "inCountry"
* ]
*/
classifyProperties?: string[];
/**
* @description Base the text-based classification on these fields (of type text).
* @example [
* "description"
* ]
*/
basedOnProperties?: string[];
/**
* @description Status of this classification.
* @example running
* @enum {string}
*/
status?: 'running' | 'completed' | 'failed';
/** @description Additional meta information about the classification. */
meta?: definitions['ClassificationMeta'];
/** @description Which algorithm to use for classifications. */
type?: string;
/** @description Classification-type specific settings. */
settings?: {
[key: string]: unknown;
};
/**
* @description Error message if status == failed.
* @default
* @example classify xzy: something went wrong
*/
error?: string;
filters?: {
/** @description Limit the objects to be classified. */
sourceWhere?: definitions['WhereFilter'];
/** @description Limit the training objects to be considered during the classification. Can only be used on types with explicit training sets, such as 'knn'. */
trainingSetWhere?: definitions['WhereFilter'];
/** @description Limit the possible sources when using an algorithm which doesn't really on training data, e.g. 'contextual'. When using an algorithm with a training set, such as 'knn', limit the training set instead. */
targetWhere?: definitions['WhereFilter'];
};
};
/** @description Additional information to a specific classification. */
ClassificationMeta: {
/**
* Format: date-time
* @description Time when this classification was started.
* @example 2017-07-21T17:32:28Z
*/
started?: string;
/**
* Format: date-time
* @description Time when this classification finished.
* @example 2017-07-21T17:32:28Z
*/
completed?: string;
/**
* @description Number of objects which were taken into consideration for classification.
* @example 147
*/
count?: number;
/**
* @description Number of objects successfully classified.
* @example 140
*/
countSucceeded?: number;
/**
* @description Number of objects which could not be classified - see error message for details.
* @example 7
*/
countFailed?: number;
};
/** @description Filter search results using a where filter. */
WhereFilter: {
/** @description Combine multiple where filters, requires 'And' or 'Or' operator. */
operands?: definitions['WhereFilter'][];
/**
* @description Operator to use.
* @example GreaterThanEqual
* @enum {string}
*/
operator?: 'And' | 'Or' | 'Equal' | 'Like' | 'NotEqual' | 'GreaterThan' | 'GreaterThanEqual' | 'LessThan' | 'LessThanEqual' | 'WithinGeoRange' | 'IsNull' | 'ContainsAny' | 'ContainsAll' | 'ContainsNone' | 'Not';
/**
* @description Path to the property currently being filtered.
* @example [
* "inCity",
* "city",
* "name"
* ]
*/
path?: string[];
/**
* Format: int64
* @description value as integer
* @example 2000
*/
valueInt?: number;
/**
* Format: float64
* @description value as number/float
* @example 3.14
*/
valueNumber?: number;
/**
* @description value as boolean
* @example false
*/
valueBoolean?: boolean;
/**
* @description value as text (deprecated as of v1.19; alias for valueText)
* @example my search term
*/
valueString?: string;
/**
* @description value as text
* @example my search term
*/
valueText?: string;
/**
* @description value as date (as string)
* @example TODO
*/
valueDate?: string;
/**
* @description value as integer
* @example [100, 200]
*/
valueIntArray?: number[];
/**
* @description value as number/float
* @example [
* 3.14
* ]
*/
valueNumberArray?: number[];
/**
* @description value as boolean
* @example [
* true,
* false
* ]
*/
valueBooleanArray?: boolean[];
/**
* @description value as text (deprecated as of v1.19; alias for valueText)
* @example [
* "my search term"
* ]
*/
valueStringArray?: string[];
/**
* @description value as text
* @example [
* "my search term"
* ]
*/
valueTextArray?: string[];
/**
* @description value as date (as string)
* @example TODO
*/
valueDateArray?: string[];
/** @description value as geo coordinates and distance */
valueGeoRange?: definitions['WhereFilterGeoRange'];
};
/** @description Filter within a distance of a georange. */
WhereFilterGeoRange: {
geoCoordinates?: definitions['GeoCoordinates'];
distance?: {
/** Format: float64 */
max?: number;
};
};
/** @description Attributes representing a single tenant within Weaviate. */
Tenant: {
/** @description The name of the tenant (required). */
name?: string;
/**
* @description The activity status of the tenant, which determines if it is queryable and where its data is stored.
Available Statuses:
- `ACTIVE`: The tenant is fully operational and ready for queries. Data is stored on local, hot storage.
- `INACTIVE`: The tenant is not queryable. Data is stored locally.
- `OFFLOADED`: The tenant is inactive and its data is stored in a remote cloud backend.
Usage Rules:
- On Create: This field is optional and defaults to `ACTIVE`. Allowed values are `ACTIVE` and `INACTIVE`.
- On Update: This field is required. Allowed values are `ACTIVE`, `INACTIVE`, and `OFFLOADED`.
Read-Only Statuses:
The following statuses are set by the server and indicate a tenant is transitioning between states:
- `OFFLOADING`
- `ONLOADING`
Note on Deprecated Names:
For backward compatibility, deprecated names are still accepted and are mapped to their modern equivalents: `HOT` (now `ACTIVE`), `COLD` (now `INACTIVE`), `FROZEN` (now `OFFLOADED`), `FREEZING` (now `OFFLOADING`), `UNFREEZING` (now `ONLOADING`).
* @enum {string}
*/
activityStatus?: 'ACTIVE' | 'INACTIVE' | 'OFFLOADED' | 'OFFLOADING' | 'ONLOADING' | 'HOT' | 'COLD' | 'FROZEN' | 'FREEZING' | 'UNFREEZING';
};
/** @description Represents the mapping between an alias name and a collection. An alias provides an alternative name for accessing a collection. */
Alias: {
/** @description The unique name of the alias that serves as an alternative identifier for the collection. */
alias?: string;
/** @description The name of the collection (class) to which this alias is mapped. */
class?: string;
};
/** @description Response object containing a list of alias mappings. */
AliasResponse: {
/** @description Array of alias objects, each containing an alias-to-collection mapping. */
aliases?: definitions['Alias'][];
};
}
export interface parameters {
/** @description A threshold UUID of the objects to retrieve after, using an UUID-based ordering. This object is not part of the set.
Must be used with collection name (`class`), typically in conjunction with `limit`.
Note `after` cannot be used with `offset` or `sort`.
For a null value similar to offset=0, set an empty string in the request, i.e. `after=` or `after`. */
CommonAfterParameterQuery: string;
/**
* Format: int64
* @description The starting index of the result window. Note `offset` will retrieve `offset+limit` results and return `limit` results from the object with index `offset` onwards. Limited by the value of `QUERY_MAXIMUM_RESULTS`.
Should be used in conjunction with `limit`.
Cannot be used with `after`.
* @default 0
*/
CommonOffsetParameterQuery: number;
/**
* Format: int64
* @description The maximum number of items to be returned per page. The default is 25 unless set otherwise as an environment variable.
*/
CommonLimitParameterQuery: number;
/** @description Include additional information, such as classification information. Allowed values include: `classification`, `vector` and `interpretation`. */
CommonIncludeParameterQuery: string;
/** @description Determines how many replicas must acknowledge a request before it is considered successful. */
CommonConsistencyLevelParameterQuery: string;
/** @description Specifies the tenant in a request targeting a multi-tenant collection (class). */
CommonTenantParameterQuery: string;
/** @description The target node which should fulfill the request. */
CommonNodeNameParameterQuery: string;
/** @description Name(s) of the property to sort by - e.g. `city`, or `country,city`. */
CommonSortParameterQuery: string;
/** @description Order parameter to tell how to order (asc or desc) data within given field. Should be used in conjunction with `sort` parameter. If providing multiple `sort` values, provide multiple `order` values in corresponding order, e.g.: `sort=author_name,title&order=desc,asc`. */
CommonOrderParameterQuery: string;
/** @description The collection from which to query objects.
Note that if the collection name (`class`) is not provided, the response will not include any objects. */
CommonClassParameterQuery: string;
/**
* @description Controls the verbosity of the output, possible values are: `minimal`, `verbose`. Defaults to `minimal`.
* @default minimal
*/
CommonOutputVerbosityParameterQuery: string;
}
export interface operations {
/** Get links to other endpoints to help discover the REST API. */
'weaviate.root': {
responses: {
/** Weaviate is alive and ready. */
200: {
schema: {
links?: definitions['Link'][];
};
};
};
};
/** Indicates if the Weaviate instance is running and responsive to basic HTTP requests. Primarily used for health checks, such as Kubernetes liveness probes. */
'weaviate.wellknown.liveness': {
responses: {
/** The application is alive and responding to HTTP requests. */
200: unknown;
};
};
/** Indicates if the Weaviate instance has completed its startup routines and is prepared to accept user traffic (data import, queries, etc.). Used for readiness checks, such as Kubernetes readiness probes. */
'weaviate.wellknown.readiness': {
responses: {
/** The application is ready to serve traffic. */
200: unknown;
/** The application is not ready to serve traffic. Traffic should be directed to other available replicas if applicable. */
503: unknown;
};
};
/** Begins an asynchronous operation to move or copy a specific shard replica from its current node to a designated target node. The operation involves copying data, synchronizing, and potentially decommissioning the source replica. */
replicate: {
parameters: {
body: {
body: definitions['ReplicationReplicateReplicaRequest'];
};
};
responses: {
/** Replication operation registered successfully. ID of the operation is returned. */
200: {
schema: definitions['ReplicationReplicateReplicaResponse'];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
/** Replica movement operations are disabled. */
501: {
schema: definitions['ErrorResponse'];
};
};
};
/** Schedules all replication operations for deletion across all collections, shards, and nodes. */
deleteAllReplications: {
responses: {
/** Replication operation registered successfully */
204: never;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
/** Replica movement operations are disabled. */
501: {
schema: definitions['ErrorResponse'];
};
};
};
/** USE AT OWN RISK! Synchronously force delete operations from the FSM. This will not perform any checks on which state the operation is in so may lead to data corruption or loss. It is recommended to first scale the number of replication engine workers to 0 before calling this endpoint to ensure no operations are in-flight. */
forceDeleteReplications: {
parameters: {
body: {
body?: definitions['ReplicationReplicateForceDeleteRequest'];
};
};
responses: {
/** Replication operations force deleted successfully. */
200: {
schema: definitions['ReplicationReplicateForceDeleteResponse'];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Fetches the current status and detailed information for a specific replication operation, identified by its unique ID. Optionally includes historical data of the operation's progress if requested. */
replicationDetails: {
parameters: {
path: {
/** The ID of the replication operation to get details for. */
id: string;
};
query: {
/** Whether to include the history of the replication operation. */
includeHistory?: boolean;
};
};
responses: {
/** The details of the replication operation. */
200: {
schema: definitions['ReplicationReplicateDetailsReplicaResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden. */
403: {
schema: definitions['ErrorResponse'];
};
/** Shard replica operation not found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
/** Replica movement operations are disabled. */
501: {
schema: definitions['ErrorResponse'];
};
};
};
/** Removes a specific replication operation. If the operation is currently active, it will be cancelled and its resources cleaned up before the operation is deleted. */
deleteReplication: {
parameters: {
path: {
/** The ID of the replication operation to delete. */
id: string;
};
};
responses: {
/** Successfully deleted. */
204: never;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden. */
403: {
schema: definitions['ErrorResponse'];
};
/** Shard replica operation not found. */
404: unknown;
/** The operation is not in a deletable state, e.g. it is a MOVE op in the DEHYDRATING state. */
409: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
/** Replica movement operations are disabled. */
501: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves a list of currently registered replication operations, optionally filtered by collection, shard, or node ID. */
listReplication: {
parameters: {
query: {
/** The name of the target node to get details for. */
targetNode?: string;
/** The name of the collection to get details for. */
collection?: string;
/** The shard to get details for. */
shard?: string;
/** Whether to include the history of the replication operation. */
includeHistory?: boolean;
};
};
responses: {
/** The details of the replication operations. */
200: {
schema: definitions['ReplicationReplicateDetailsReplicaResponse'][];
};
/** Bad request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
/** Replica movement operations are disabled. */
501: {
schema: definitions['ErrorResponse'];
};
};
};
/** Requests the cancellation of an active replication operation identified by its ID. The operation will be stopped, but its record will remain in the `CANCELLED` state (can't be resumed) and will not be automatically deleted. */
cancelReplication: {
parameters: {
path: {
/** The ID of the replication operation to cancel. */
id: string;
};
};
responses: {
/** Successfully cancelled. */
204: never;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Shard replica operation not found. */
404: unknown;
/** The operation is not in a cancellable state, e.g. it is READY or is a MOVE op in the DEHYDRATING state. */
409: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
/** Replica movement operations are disabled. */
501: {
schema: definitions['ErrorResponse'];
};
};
};
/** Fetches the current sharding state, including replica locations and statuses, for all collections or a specified collection. If a shard name is provided along with a collection, the state for that specific shard is returned. */
getCollectionShardingState: {
parameters: {
query: {
/** The collection name to get the sharding state for. */
collection?: string;
/** The shard to get the sharding state for. */
shard?: string;
};
};
responses: {
/** Successfully retrieved sharding state. */
200: {
schema: definitions['ReplicationShardingStateResponse'];
};
/** Bad request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Collection or shard not found. */
404: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
/** Replica movement operations are disabled. */
501: {
schema: definitions['ErrorResponse'];
};
};
};
/** Computes and returns a replication scale plan for a given collection and desired replication factor. The plan includes, for each shard, a list of nodes to be added and a list of nodes to be removed. */
getReplicationScalePlan: {
parameters: {
query: {
/** The collection name to get the scaling plan for. */
collection: string;
/** The desired replication factor to scale to. Must be a positive integer greater than zero. */
replicationFactor: number;
};
};
responses: {
/** Replication scale plan showing node additions and removals per shard. */
200: {
schema: definitions['ReplicationScalePlan'];
};
/** Bad request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Collection not found. */
404: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
/** Replica movement operations are disabled. */
501: {
schema: definitions['ErrorResponse'];
};
};
};
/** Apply a replication scaling plan that specifies nodes to add or remove per shard for a given collection. */
applyReplicationScalePlan: {
parameters: {
body: {
/** The replication scaling plan specifying the collection and its shard-level replica adjustments. */
body: definitions['ReplicationScalePlan'];
};
};
responses: {
/** List of replication shard copy operation IDs initiated for the scale operation */
200: {
schema: definitions['ReplicationScaleApplyResponse'];
};
/** Bad request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Collection not found. */
404: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
/** Replica movement operations are disabled. */
501: {
schema: definitions['ErrorResponse'];
};
};
};
/** Get information about the currently authenticated user, including username and assigned roles. */
getOwnInfo: {
responses: {
/** Info about the user. */
200: {
schema: definitions['UserOwnInfo'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
/** Replica movement operations are disabled. */
501: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves a list of all database (`db` user type) users with their roles and status information. */
listAllUsers: {
parameters: {
query: {
/** Whether to include the last time the users were utilized. */
includeLastUsedTime?: boolean;
};
};
responses: {
/** Info about the users. */
200: {
schema: definitions['DBUserInfo'][];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieve detailed information about a specific database user (`db` user type), including their roles, status, and type. */
getUserInfo: {
parameters: {
path: {
/** The name of the user. */
user_id: string;
};
query: {
/** Whether to include the last used time of the given user */
includeLastUsedTime?: boolean;
};
};
responses: {
/** Info about the user. */
200: {
schema: definitions['DBUserInfo'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** User not found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Create a new database (`db` user type) user with the specified name. Returns an API key for the newly created user. */
createUser: {
parameters: {
path: {
/** The name of the user. */
user_id: string;
};
body: {
body?: {
/**
* @description EXPERIMENTAL, DONT USE. THIS WILL BE REMOVED AGAIN. - import api key from static user
* @default false
*/
import?: boolean;
/**
* Format: date-time
* @description EXPERIMENTAL, DONT USE. THIS WILL BE REMOVED AGAIN. - set the given time as creation time
*/
createTime?: string;
};
};
};
responses: {
/** User created successfully and API key returned. */
201: {
schema: definitions['UserApiKey'];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** User not found. */
404: {
schema: definitions['ErrorResponse'];
};
/** A user with the specified name already exists. */
409: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Delete a database user. You can't delete your current user. */
deleteUser: {
parameters: {
path: {
/** The name of the user. */
user_id: string;
};
};
responses: {
/** Successfully deleted. */
204: never;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** User not found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Revoke the current API key for the specified database user (`db` user type) and generate a new one. */
rotateUserApiKey: {
parameters: {
path: {
/** The name of the user. */
user_id: string;
};
};
responses: {
/** API key successfully updated. */
200: {
schema: definitions['UserApiKey'];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** User not found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Activate a deactivated database user (`db` user type). */
activateUser: {
parameters: {
path: {
/** The name of the user. */
user_id: string;
};
};
responses: {
/** User successfully activated. */
200: unknown;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** User not found. */
404: unknown;
/** User already activated. */
409: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Deactivate a database user (`db` user type). */
deactivateUser: {
parameters: {
path: {
/** The name of the user. */
user_id: string;
};
body: {
body?: {
/**
* @description Whether the API key should be revoked when deactivating the user.
* @default false
*/
revoke_key?: boolean;
};
};
};
responses: {
/** User successfully deactivated. */
200: unknown;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** User not found. */
404: unknown;
/** User already deactivated. */
409: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Get all roles and their assigned permissions. */
getRoles: {
responses: {
/** Successful response. */
200: {
schema: definitions['RolesListResponse'];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Create a new role with the specified permissions. */
createRole: {
parameters: {
body: {
body: definitions['Role'];
};
};
responses: {
/** Role created successfully. */
201: unknown;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Role already exists. */
409: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Add new permissions to an existing role without affecting current permissions. */
addPermissions: {
parameters: {
path: {
/** The name (ID) of the role being modified. */
id: string;
};
body: {
body: {
/** @description Permissions to be added to the role. */
permissions: definitions['Permission'][];
} & {
name: unknown;
};
};
};
responses: {
/** Permissions added successfully. */
200: unknown;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** No role found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Permissions can be revoked from a specified role. Removing all permissions from a role will delete the role itself. */
removePermissions: {
parameters: {
path: {
/** The name of the role being modified. */
id: string;
};
body: {
body: {
/** @description Permissions to remove from the role. */
permissions: definitions['Permission'][];
};
};
};
responses: {
/** Permissions removed successfully. */
200: unknown;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** No role found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Fetch a role by its name. */
getRole: {
parameters: {
path: {
/** The name of the role. */
id: string;
};
};
responses: {
/** Successful response. */
200: {
schema: definitions['Role'];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** No role found. */
404: unknown;
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Deleting a role will remove it from the system, and revoke the associated permissions from all users who had this role. */
deleteRole: {
parameters: {
path: {
/** The name of the role. */
id: string;
};
};
responses: {
/** Successfully deleted. */
204: never;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Check whether a role has the specified permissions. */
hasPermission: {
parameters: {
path: {
/** The name of the role. */
id: string;
};
body: {
/** The permissions to be checked. */
body: definitions['Permission'];
};
};
responses: {
/** Permission check was successful. */
200: {
schema: boolean;
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Get all the users (`db` + `oidc`) who have been assigned a specific role. Deprecated, will be removed when v1.29 is not supported anymore. */
getUsersForRoleDeprecated: {
parameters: {
path: {
/** The name of the role. */
id: string;
};
};
responses: {
/** Users assigned to this role. */
200: {
schema: string[];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** No role found. */
404: unknown;
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Fetch a list of users which have the specified role. */
getUsersForRole: {
parameters: {
path: {
/** The name (ID) of the role. */
id: string;
};
};
responses: {
/** Users assigned to this role. */
200: {
schema: ({
userId?: string;
userType: definitions['UserTypeOutput'];
} & {
name: unknown;
})[];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** No role found. */
404: unknown;
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves a list of all groups that have been assigned a specific role, identified by its name. */
getGroupsForRole: {
parameters: {
path: {
/** The unique name of the role. */
id: string;
};
};
responses: {
/** Successfully retrieved the list of groups that have the role assigned. */
200: {
schema: ({
groupId?: string;
groupType: definitions['GroupType'];
} & {
name: unknown;
})[];
};
/** Bad request */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The specified role was not found. */
404: unknown;
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieve the roles assigned to a specific user (`db` + `oidc`). Deprecated, will be removed when 1.29 is not supported anymore */
getRolesForUserDeprecated: {
parameters: {
path: {
/** The name of the user. */
id: string;
};
};
responses: {
/** Roles assigned to the user. */
200: {
schema: definitions['RolesListResponse'];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** No roles found for specified user. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Get all the roles for a specific user (`db` or `oidc`). */
getRolesForUser: {
parameters: {
path: {
/** The name of the user. */
id: string;
/** The type of the user. */
userType: 'oidc' | 'db';
};
query: {
/** Whether to include detailed role information like its assigned permissions. */
includeFullRoles?: boolean;
};
};
responses: {
/** Roles assigned to the user. */
200: {
schema: definitions['RolesListResponse'];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** No roles found for specified user. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Assign one or more roles to a user. Users can have multiple roles. */
assignRoleToUser: {
parameters: {
path: {
/** The name of the user. */
id: string;
};
body: {
body: {
/** @description The roles that are assigned to the specified user. */
roles?: string[];
userType?: definitions['UserTypeInput'];
};
};
};
responses: {
/** Role assigned successfully. */
200: unknown;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Specified role or user not found. */
404: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Remove one or more roles from a user. */
revokeRoleFromUser: {
parameters: {
path: {
/** The name of the user. */
id: string;
};
body: {
body: {
/** @description The roles to revoke from the specified user. */
roles?: string[];
userType?: definitions['UserTypeInput'];
};
};
};
responses: {
/** Roles revoked successfully. */
200: unknown;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Specified role or user not found. */
404: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Assign roles to the specified group. */
assignRoleToGroup: {
parameters: {
path: {
/** The name of the group. */
id: string;
};
body: {
body: {
/** @description The roles to assign to the specified group. */
roles?: string[];
groupType?: definitions['GroupType'];
};
};
};
responses: {
/** Roles assigned successfully. */
200: unknown;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Role or group not found. */
404: unknown;
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Revoke roles from the specified group. */
revokeRoleFromGroup: {
parameters: {
path: {
/** The name of the group. */
id: string;
};
body: {
body: {
/** @description The roles to revoke from the specified group. */
roles?: string[];
groupType?: definitions['GroupType'];
};
};
};
responses: {
/** Roles revoked successfully. */
200: unknown;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Role or group not found. */
404: unknown;
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves a list of all roles assigned to a specific group. The group must be identified by both its name (`id`) and its type (`db` or `oidc`). */
getRolesForGroup: {
parameters: {
path: {
/** The unique name of the group. */
id: string;
/** The type of the group. */
groupType: 'oidc';
};
query: {
/** If true, the response will include the full role definitions with all associated permissions. If false, only role names are returned. */
includeFullRoles?: boolean;
};
};
responses: {
/** A list of roles assigned to the specified group. */
200: {
schema: definitions['RolesListResponse'];
};
/** Bad request */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The specified group was not found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves a list of all available group names for a specified group type (`oidc` or `db`). */
getGroups: {
parameters: {
path: {
/** The type of group to retrieve. */
groupType: 'oidc';
};
};
responses: {
/** A list of group names for the specified type. */
200: {
schema: string[];
};
/** Bad request */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves a list of data objects. By default, objects are returned in reverse order of creation. Requires a collection name (`class`) parameter to specify which collection's objects to list, otherwise, returns an empty list. */
'objects.list': {
parameters: {
query: {
/** A threshold UUID of the objects to retrieve after, using an UUID-based ordering. This object is not part of the set.
Must be used with collection name (`class`), typically in conjunction with `limit`.
Note `after` cannot be used with `offset` or `sort`.
For a null value similar to offset=0, set an empty string in the request, i.e. `after=` or `after`. */
after?: parameters['CommonAfterParameterQuery'];
/** The starting index of the result window. Note `offset` will retrieve `offset+limit` results and return `limit` results from the object with index `offset` onwards. Limited by the value of `QUERY_MAXIMUM_RESULTS`.
Should be used in conjunction with `limit`.
Cannot be used with `after`. */
offset?: parameters['CommonOffsetParameterQuery'];
/** The maximum number of items to be returned per page. The default is 25 unless set otherwise as an environment variable. */
limit?: parameters['CommonLimitParameterQuery'];
/** Include additional information, such as classification information. Allowed values include: `classification`, `vector` and `interpretation`. */
include?: parameters['CommonIncludeParameterQuery'];
/** Name(s) of the property to sort by - e.g. `city`, or `country,city`. */
sort?: parameters['CommonSortParameterQuery'];
/** Order parameter to tell how to order (asc or desc) data within given field. Should be used in conjunction with `sort` parameter. If providing multiple `sort` values, provide multiple `order` values in corresponding order, e.g.: `sort=author_name,title&order=desc,asc`. */
order?: parameters['CommonOrderParameterQuery'];
/** The collection from which to query objects.
Note that if the collection name (`class`) is not provided, the response will not include any objects. */
class?: parameters['CommonClassParameterQuery'];
/** Specifies the tenant in a request targeting a multi-tenant collection (class). */
tenant?: parameters['CommonTenantParameterQuery'];
};
};
responses: {
/** Successful response containing the list of objects. If the collection name (`class`) is not provided, the response will not include any objects. */
200: {
schema: definitions['ObjectsListResponse'];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Successful query result but no matching objects were found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the specified collection exists. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Creates a new data object. The object's metadata and schema values are validated before creation.
**Note (batch import)**:
If you plan on importing a large number of objects, using the `/batch/objects` endpoint is significantly more efficient than sending multiple single requests.
**Note (idempotence)**:
This operation (POST) fails if an object with the provided ID already exists. To update an existing object, use the PUT or PATCH methods. */
'objects.create': {
parameters: {
body: {
/** The object to be created. */
body: definitions['Object'];
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
};
};
responses: {
/** Object created successfully. */
200: {
schema: definitions['Object'];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the collection exists and the object properties are valid. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Get a specific object based on its UUID. Also available as Websocket bus.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */
'objects.get': {
parameters: {
path: {
/** Unique UUID of the object to be retrieved. */
id: string;
};
query: {
/** Include additional information, such as classification information. Allowed values include: `classification`, `vector` and `interpretation`. */
include?: parameters['CommonIncludeParameterQuery'];
};
};
responses: {
/** Successful response containing the object. */
200: {
schema: definitions['Object'];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Object not found. */
404: unknown;
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Updates an object based on its UUID. Given meta-data and schema values are validated. `lastUpdateTimeUnix` is set to the time this function is called.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */
'objects.update': {
parameters: {
path: {
/** Unique UUID of the object to be replaced. */
id: string;
};
body: {
/** The object definition to replace the existing object with. */
body: definitions['Object'];
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
};
};
responses: {
/** Object replaced successfully. */
200: {
schema: definitions['Object'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Object not found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the collection exists and the object properties are valid. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Deletes an object from the database based on its UUID.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */
'objects.delete': {
parameters: {
path: {
/** Unique UUID of the object to be deleted. */
id: string;
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
/** Specifies the tenant in a request targeting a multi-tenant collection (class). */
tenant?: parameters['CommonTenantParameterQuery'];
};
};
responses: {
/** Object deleted successfully. */
204: never;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Object not found. */
404: unknown;
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Checks if an object exists in the system based on its UUID.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */
'objects.head': {
parameters: {
path: {
/** Unique UUID of the object to check. */
id: string;
};
};
responses: {
/** Object exists. */
204: never;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Object does not exist. */
404: unknown;
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Update an object based on its UUID (using patch semantics). This method supports json-merge style patch semantics (RFC 7396). Provided meta-data and schema values are validated. `lastUpdateTimeUnix` is set to the time this function is called.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */
'objects.patch': {
parameters: {
path: {
/** Unique UUID of the object to be patched. */
id: string;
};
body: {
/** RFC 7396-style JSON merge patch object containing the fields to update. */
body?: definitions['Object'];
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
};
};
responses: {
/** Object patched successfully. */
204: never;
/** Malformed patch request body. */
400: unknown;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Object not found. */
404: unknown;
/** The patch object is valid JSON but is unprocessable for other reasons (e.g., invalid schema). */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Get a data object based on its collection name (`className`) and UUID (`id`). */
'objects.class.get': {
parameters: {
path: {
/** Name of the collection (class) the object belongs to. */
className: string;
/** Unique UUID of the object to be retrieved. */
id: string;
};
query: {
/** Include additional information, such as classification information. Allowed values include: `classification`, `vector` and `interpretation`. */
include?: parameters['CommonIncludeParameterQuery'];
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
/** The target node which should fulfill the request. */
node_name?: parameters['CommonNodeNameParameterQuery'];
/** Specifies the tenant in a request targeting a multi-tenant collection (class). */
tenant?: parameters['CommonTenantParameterQuery'];
};
};
responses: {
/** Successful response containing the object. */
200: {
schema: definitions['Object'];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Object not found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Replaces properties of an existing data object. The object is identified by its collection name (`className`) and UUID (`id`). The request body must contain the complete object definition with the new property values. */
'objects.class.put': {
parameters: {
path: {
/** Name of the collection (class) the object belongs to. */
className: string;
/** Unique UUID of the object to be replaced. */
id: string;
};
body: {
/** The object definition to replace the existing object with. */
body: definitions['Object'];
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
};
};
responses: {
/** Object replaced successfully. */
200: {
schema: definitions['Object'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Object not found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the collection exists and the object properties are valid. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Removes a data object from a specific collection, identified by its collection name (`className`) and UUID (`id`).
**Note on deleting references (legacy format):**
For backward compatibility with older beacon formats (lacking a collection name), deleting a reference requires the beacon in the request to exactly match the stored format. Beacons always use `localhost` as the host, indicating the target is within the same Weaviate instance. */
'objects.class.delete': {
parameters: {
path: {
/** Name of the collection (class) the object belongs to. */
className: string;
/** Unique UUID of the object to be deleted. */
id: string;
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
/** Specifies the tenant in a request targeting a multi-tenant collection (class). */
tenant?: parameters['CommonTenantParameterQuery'];
};
};
responses: {
/** Object deleted successfully. */
204: never;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Object not found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Verifies the existence of a specific data object within a collection (class), identified by its collection name (`className`) and UUID (`id`), without returning the object itself.
This is faster than a GET request as it avoids retrieving and processing object data. Existence is confirmed by a 204 No Content status code, while non-existence results in a 404 Not Found. */
'objects.class.head': {
parameters: {
path: {
/** Name of the collection (class) the object belongs to. */
className: string;
/** Unique UUID of the object to check. */
id: string;
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
/** Specifies the tenant in a request targeting a multi-tenant collection (class). */
tenant?: parameters['CommonTenantParameterQuery'];
};
};
responses: {
/** Object exists. */
204: never;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Object does not exist. */
404: unknown;
/** Invalid data provided. Please check the values in your request (e.g., invalid UUID format). */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Updates specific properties of an existing data object using JSON merge patch semantics (RFC 7396). The object is identified by its collection name (`className`) and UUID (`id`). Only the fields provided in the request body are modified. Metadata and schema values are validated, and the object's `lastUpdateTimeUnix` is updated. */
'objects.class.patch': {
parameters: {
path: {
/** Name of the collection (class) the object belongs to. */
className: string;
/** Unique UUID of the object to be patched. */
id: string;
};
body: {
/** RFC 7396-style JSON merge patch object containing the fields to update. */
body?: definitions['Object'];
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
};
};
responses: {
/** Object patched successfully. */
204: never;
/** Malformed patch request body. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Object not found. */
404: unknown;
/** The patch object is valid JSON but is unprocessable for other reasons (e.g., invalid schema). */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Replace all references in cross-reference property of an object.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}/references/{propertyName}` endpoint instead. */
'objects.references.update': {
parameters: {
path: {
/** Unique UUID of the source object. */
id: string;
/** Unique name of the reference property of the source object. */
propertyName: string;
};
body: {
/** The new list of references. */
body: definitions['MultipleRef'];
};
query: {
/** Specifies the tenant in a request targeting a multi-tenant collection (class). */
tenant?: parameters['CommonTenantParameterQuery'];
};
};
responses: {
/** References replaced successfully. */
200: unknown;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the property exists and is a reference type. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Add a reference to a specific property of a data object.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}/references/{propertyName}` endpoint instead. */
'objects.references.create': {
parameters: {
path: {
/** Unique UUID of the source object. */
id: string;
/** Unique name of the reference property of the source object. */
propertyName: string;
};
body: {
/** The reference to add. */
body: definitions['SingleRef'];
};
query: {
/** Specifies the tenant in a request targeting a multi-tenant collection (class). */
tenant?: parameters['CommonTenantParameterQuery'];
};
};
responses: {
/** Reference added successfully. */
200: unknown;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the property exists and is a reference type. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Delete the single reference that is given in the body from the list of references that this property has.
**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}/references/{propertyName}` endpoint instead. */
'objects.references.delete': {
parameters: {
path: {
/** Unique UUID of the source object. */
id: string;
/** Unique name of the reference property of the source object. */
propertyName: string;
};
body: {
/** The reference to remove. */
body: definitions['SingleRef'];
};
query: {
/** Specifies the tenant in a request targeting a multi-tenant collection (class). */
tenant?: parameters['CommonTenantParameterQuery'];
};
};
responses: {
/** Reference deleted successfully. */
204: never;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Object or reference not found. */
404: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Replaces all existing references for a specific reference property (`propertyName`) on a source data object. The source object is identified by its collection name (`className`) and UUID (`id`). The new set of references is provided in the request body. */
'objects.class.references.put': {
parameters: {
path: {
/** Name of the collection (class) the source object belongs to. */
className: string;
/** Unique UUID of the source object. */
id: string;
/** Unique name of the reference property of the source object. */
propertyName: string;
};
body: {
/** The new list of references. */
body: definitions['MultipleRef'];
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
/** Specifies the tenant in a request targeting a multi-tenant collection (class). */
tenant?: parameters['CommonTenantParameterQuery'];
};
};
responses: {
/** References replaced successfully. */
200: unknown;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Source object not found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the property exists and is a reference type. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Adds a new reference to a reference property (`propertyName`) on a source data object. The source object is identified by its collection name (`className`) and UUID (`id`). The reference to add is specified in the request body. */
'objects.class.references.create': {
parameters: {
path: {
/** Name of the collection (class) the source object belongs to. */
className: string;
/** Unique UUID of the source object. */
id: string;
/** Unique name of the reference property of the source object. */
propertyName: string;
};
body: {
/** The reference to add. */
body: definitions['SingleRef'];
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
/** Specifies the tenant in a request targeting a multi-tenant collection (class). */
tenant?: parameters['CommonTenantParameterQuery'];
};
};
responses: {
/** Reference added successfully. */
200: unknown;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Source object not found. */
404: unknown;
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the property exists and is a reference type. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Removes a specific reference from a reference property (`propertyName`) of a source data object. The source object is identified by its collection name (`className`) and UUID (`id`). The reference to remove is specified in the request body. */
'objects.class.references.delete': {
parameters: {
path: {
/** Name of the collection (class) the source object belongs to. */
className: string;
/** Unique UUID of the source object. */
id: string;
/** Unique name of the reference property of the source object. */
propertyName: string;
};
body: {
/** The reference to remove. */
body: definitions['SingleRef'];
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
/** Specifies the tenant in a request targeting a multi-tenant collection (class). */
tenant?: parameters['CommonTenantParameterQuery'];
};
};
responses: {
/** Reference deleted successfully. */
204: never;
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Object or reference not found. */
404: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the property exists and is a reference type. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Checks if a data object's structure conforms to the specified collection schema and metadata rules without actually storing the object.
A successful validation returns a 200 OK status code with no body. If validation fails, an error response with details is returned. */
'objects.validate': {
parameters: {
body: {
/** The object definition to validate. */
body: definitions['Object'];
};
};
responses: {
/** Object is valid according to the schema. */
200: unknown;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Request body is well-formed but the object is invalid according to the schema. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Registers multiple data objects in a single request for efficiency. Metadata and schema values for each object are validated.
**Note (idempotence)**:
This operation is idempotent based on the object UUIDs provided. If an object with a given UUID already exists, it will be overwritten (similar to a PUT operation for that specific object within the batch). */
'batch.objects.create': {
parameters: {
body: {
/** The request body containing the objects to be created. */
body: {
/** @description Controls which fields are returned in the response for each object. Default is `ALL`. */
fields?: ('ALL' | 'class' | 'schema' | 'id' | 'creationTimeUnix')[];
/** @description Array of objects to be created. */
objects?: definitions['Object'][];
};
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
};
};
responses: {
/** Request processed successfully. Individual object statuses are provided in the response body. */
200: {
schema: definitions['ObjectsGetResponse'][];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the collection exists and the object properties are valid. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Removes multiple data objects based on a filter specified in the request body.
Deletion occurs based on the filter criteria provided in the `where` clause. There is a configurable limit (default 10,000, set via `QUERY_MAXIMUM_RESULTS`) on how many objects can be deleted in a single batch request to prevent excessive resource usage. Objects are deleted in the order they match the filter. To delete more objects than the limit allows, repeat the request until no more matching objects are found. */
'batch.objects.delete': {
parameters: {
body: {
/** The request body containing the match filter and output configuration. */
body: definitions['BatchDelete'];
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
/** Specifies the tenant in a request targeting a multi-tenant collection (class). */
tenant?: parameters['CommonTenantParameterQuery'];
};
};
responses: {
/** Request processed successfully. See response body for matching objects and deletion results. */
200: {
schema: definitions['BatchDeleteResponse'];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid data provided. Please check the values in your request (e.g., invalid filter). */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while trying to fulfill the request. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Batch create cross-references between collection items in bulk. */
'batch.references.create': {
parameters: {
body: {
/** A list of references to be batched. The ideal size depends on the used database connector. Please see the documentation of the used connector for help. */
body: definitions['BatchReference'][];
};
query: {
/** Determines how many replicas must acknowledge a request before it is considered successful. */
consistency_level?: parameters['CommonConsistencyLevelParameterQuery'];
};
};
responses: {
/** Request Successful. Warning: A successful request does not guarantee that every batched reference was successfully created. Inspect the response body to see which references succeeded and which failed. */
200: {
schema: definitions['BatchReferenceResponse'][];
};
/** Malformed request. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. Ensure the collection exists and the object properties are valid. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Executes a single GraphQL query provided in the request body. Use this endpoint for all Weaviate data queries and exploration. */
'graphql.post': {
parameters: {
body: {
/** The GraphQL query to execute, including the query string and optional variables. */
body: definitions['GraphQLQuery'];
};
};
responses: {
/** Query executed successfully. The response body contains the query result. */
200: {
schema: definitions['GraphQLResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred during query execution. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Executes multiple GraphQL queries provided in the request body as an array. Allows performing several queries in a single network request for efficiency. */
'graphql.batch': {
parameters: {
body: {
/** An array containing multiple GraphQL query objects to execute in batch. */
body: definitions['GraphQLQueries'];
};
};
responses: {
/** Batch request processed successfully. The response body contains an array of results corresponding to the input queries. */
200: {
schema: definitions['GraphQLResponses'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** The request syntax is correct, but the server couldn't process it due to semantic issues. Please check the values in your request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred during batch query execution. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Provides meta-information about the running Weaviate instance, including its version, loaded modules, and network hostname. This information can be useful for monitoring, compatibility checks, or inter-instance communication. */
'meta.get': {
responses: {
/** Successfully retrieved meta information. */
200: {
schema: definitions['Meta'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred while retrieving meta information. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Tokenizes the provided text using the specified tokenization method. This is a stateless utility endpoint useful for debugging and understanding how text will be processed during indexing and querying. The response includes both the indexed tokens (as stored in the inverted index) and query tokens (after optional stopword removal). */
tokenize: {
parameters: {
body: {
body: definitions['TokenizeRequest'];
};
};
responses: {
/** Successfully tokenized the text. */
200: {
schema: definitions['TokenizeResponse'];
};
/** Invalid or malformed request body. */
400: unknown;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Request binding or validation error. Check the ErrorResponse for details. */
422: {
schema: definitions['ErrorResponse'];
};
/** An unexpected error occurred while tokenizing the text. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves the definitions of all collections (classes) currently in the database schema. */
'schema.dump': {
parameters: {
header: {
/** If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true. */
consistency?: boolean;
};
};
responses: {
/** Successfully retrieved the database schema. */
200: {
schema: definitions['Schema'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while retrieving the schema. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Defines and creates a new collection (class).
If [`AutoSchema`](https://docs.weaviate.io/weaviate/config-refs/collections#auto-schema) is enabled (not recommended for production), Weaviate might attempt to infer schema from data during import. Manual definition via this endpoint provides explicit control. */
'schema.objects.create': {
parameters: {
body: {
/** The definition of the collection (class) to create. */
objectClass: definitions['Class'];
};
};
responses: {
/** Collection created successfully and its definition returned. */
200: {
schema: definitions['Class'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid collection definition provided. Check the definition structure and properties. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred during collection creation. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieve the definition of a specific collection (`className`), including its properties, configuration, and vectorizer settings. */
'schema.objects.get': {
parameters: {
path: {
/** The name of the collection (class) to retrieve. */
className: string;
};
header: {
/** If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true. */
consistency?: boolean;
};
};
responses: {
/** Successfully retrieved the collection definition. */
200: {
schema: definitions['Class'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Collection not found. */
404: unknown;
/** An error occurred while retrieving the collection definition. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Updates the configuration settings of an existing collection (`className`) based on the provided definition. Note: This operation modifies mutable settings specified in the request body. It does not add properties (use `POST /schema/{className}/properties` for that) or change the collection name. */
'schema.objects.update': {
parameters: {
path: {
/** The name of the collection (class) to update. */
className: string;
};
body: {
/** The updated collection definition containing the settings to modify. */
objectClass: definitions['Class'];
};
};
responses: {
/** Collection settings updated successfully. */
200: {
schema: definitions['Class'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Collection not found. */
404: {
schema: definitions['ErrorResponse'];
};
/** Invalid update attempt. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while updating the collection. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Removes a collection definition from the schema. WARNING: This action permanently deletes all data objects stored within the collection. */
'schema.objects.delete': {
parameters: {
path: {
/** The name of the collection (class) to delete. */
className: string;
};
};
responses: {
/** Collection deleted successfully. */
200: unknown;
/** Could not delete the collection. See the error response for details. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** An error occurred during collection deletion. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Adds a new property definition to an existing collection (`className`) definition. */
'schema.objects.properties.add': {
parameters: {
path: {
/** The name of the collection (class) to add the property to. */
className: string;
};
body: {
/** The definition of the property to add. */
body: definitions['Property'];
};
};
responses: {
/** Property added successfully and its definition returned. */
200: {
schema: definitions['Property'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid property definition provided. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while adding the property. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Deletes an inverted index of a specific property within a collection (`className`). The index to delete is identified by `indexName` and must be one of `filterable`, `searchable`, or `rangeFilters`. */
'schema.objects.properties.delete': {
parameters: {
path: {
/** The name of the collection (class) containing the property. */
className: string;
/** The name of the property whose inverted index should be deleted. */
propertyName: string;
/** The name of the inverted index to delete from the property. */
indexName: 'filterable' | 'searchable' | 'rangeFilters';
};
};
responses: {
/** Index deleted successfully. */
200: unknown;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid index, property or collection provided. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while deleting the index. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Tokenizes the provided text using the tokenization method configured for the specified property. This endpoint automatically applies the property's tokenization setting and the collection's stopword configuration, making it useful for understanding exactly how text will be processed for a given property during indexing and querying. */
'schema.objects.properties.tokenize': {
parameters: {
path: {
/** The name of the collection (class) containing the property. */
className: string;
/** The name of the property whose tokenization configuration should be used. */
propertyName: string;
};
body: {
body: definitions['PropertyTokenizeRequest'];
};
};
responses: {
/** Successfully tokenized the text using the property's configuration. */
200: {
schema: definitions['TokenizeResponse'];
};
/** Invalid request body, missing required fields, or property does not have tokenization configured. */
400: unknown;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Collection or property not found. */
404: unknown;
/** Validation error, such as invalid class or property configuration for tokenization. */
422: {
schema: definitions['ErrorResponse'];
};
/** Unexpected server error while tokenizing the text. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Deletes a specific vector index within a collection (`className`). The vector index to delete is identified by `vectorIndexName`. */
'schema.objects.vectors.delete': {
parameters: {
path: {
/** The name of the collection (class) containing the property. */
className: string;
/** The name of the vector index. */
vectorIndexName: string;
};
};
responses: {
/** Vector index deleted successfully. */
200: unknown;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid vector index or collection provided. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while deleting the vector index. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves the status of all shards associated with the specified collection (`className`). For multi-tenant collections, use the `tenant` query parameter to retrieve status for a specific tenant's shards. */
'schema.objects.shards.get': {
parameters: {
path: {
/** The name of the collection (class) whose shards to query. */
className: string;
};
query: {
/** The name of the tenant for which to retrieve shard statuses (only applicable for multi-tenant collections). */
tenant?: string;
};
};
responses: {
/** Shard statuses retrieved successfully. */
200: {
schema: definitions['ShardStatusList'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Collection not found. */
404: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while retrieving shard statuses. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Updates the status of a specific shard within a collection (e.g., sets it to `READY` or `READONLY`). This is typically used after resolving an underlying issue (like disk space) that caused a shard to become non-operational. There is also a convenience function in each client to set the status of all shards of a collection. */
'schema.objects.shards.update': {
parameters: {
path: {
/** The name of the collection (class) containing the shard. */
className: string;
/** The name of the shard to update. */
shardName: string;
};
body: {
/** The shard status object containing the desired new status. */
body: definitions['ShardStatus'];
};
};
responses: {
/** Shard status updated successfully. */
200: {
schema: definitions['ShardStatus'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Collection or shard not found. */
404: {
schema: definitions['ErrorResponse'];
};
/** Invalid update attempt */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while updating the shard status. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves a list of all tenants currently associated with the specified collection. */
'tenants.get': {
parameters: {
path: {
/** The name of the collection (class) whose tenants to list. */
className: string;
};
header: {
/** If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true. */
consistency?: boolean;
};
};
responses: {
/** Successfully retrieved tenants. */
200: {
schema: definitions['Tenant'][];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while listing tenants. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Updates the activity status (e.g., `ACTIVE`, `INACTIVE`, etc.) of one or more specified tenants within a collection (`className`). */
'tenants.update': {
parameters: {
path: {
/** The name of the collection (class) containing the tenants. */
className: string;
};
body: {
/** An array of tenant objects specifying the tenants to update and their desired new status. */
body: definitions['Tenant'][];
};
};
responses: {
/** Tenant statuses updated successfully. */
200: {
schema: definitions['Tenant'][];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid update request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while updating tenants. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Creates one or more new tenants for a specified collection (`className`). Multi-tenancy must be enabled for the collection via its definition. */
'tenants.create': {
parameters: {
path: {
/** The name of the multi-tenant enabled collection (class). */
className: string;
};
body: {
/** An array of tenant objects to create. */
body: definitions['Tenant'][];
};
};
responses: {
/** Tenants created successfully. */
200: {
schema: definitions['Tenant'][];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while creating tenants. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Deletes one or more specified tenants from a collection (`className`). WARNING: This action permanently deletes all data associated with the specified tenants. */
'tenants.delete': {
parameters: {
path: {
/** The name of the collection (class) from which to delete tenants. */
className: string;
};
body: {
/** An array of tenant names to delete. */
tenants: string[];
};
};
responses: {
/** Tenants deleted successfully. */
200: unknown;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while deleting tenants. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves details about a specific tenant within the given collection (`className`), such as its current activity status. */
'tenants.get.one': {
parameters: {
path: {
/** The name of the collection (class) containing the tenant. */
className: string;
/** The name of the tenant to retrieve. */
tenantName: string;
};
header: {
/** If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true. */
consistency?: boolean;
};
};
responses: {
/** Successfully retrieved tenant details. */
200: {
schema: definitions['Tenant'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Tenant or collection not found. */
404: unknown;
/** Invalid request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred while retrieving the tenant. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Checks for the existence of a specific tenant within the given collection (`className`). */
'tenant.exists': {
parameters: {
path: {
/** The name of the collection (class) to check within. */
className: string;
/** The name of the tenant to check for. */
tenantName: string;
};
header: {
/** If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true. */
consistency?: boolean;
};
};
responses: {
/** The tenant exists in the specified collection. */
200: unknown;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Tenant or collection not found. */
404: unknown;
/** Invalid request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error occurred during the check. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieve a list of all aliases in the system. Results can be filtered by specifying a collection (class) name to get aliases for a specific collection only. */
'aliases.get': {
parameters: {
query: {
/** Optional filter to retrieve aliases for a specific collection (class) only. If not provided, returns all aliases. */
class?: string;
};
};
responses: {
/** Successfully retrieved the list of aliases */
200: {
schema: definitions['AliasResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid collection (class) parameter provided */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Create a new alias mapping between an alias name and a collection (class). The alias acts as an alternative name for accessing the collection. */
'aliases.create': {
parameters: {
body: {
body: definitions['Alias'];
};
};
responses: {
/** Successfully created a new alias for the specified collection (class) */
200: {
schema: definitions['Alias'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid create alias request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieve details about a specific alias by its name, including which collection (class) it points to. */
'aliases.get.alias': {
parameters: {
path: {
aliasName: string;
};
};
responses: {
/** Successfully retrieved the alias details. */
200: {
schema: definitions['Alias'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Not Found - Alias does not exist */
404: {
schema: definitions['ErrorResponse'];
};
/** Invalid alias name provided. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Update an existing alias to point to a different collection (class). This allows you to redirect an alias from one collection to another without changing the alias name. */
'aliases.update': {
parameters: {
path: {
aliasName: string;
};
body: {
body: {
/** @description The new collection (class) that the alias should point to. */
class?: string;
};
};
};
responses: {
/** Successfully updated the alias to point to the new collection (class). */
200: {
schema: definitions['Alias'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Not Found - Alias does not exist */
404: {
schema: definitions['ErrorResponse'];
};
/** Invalid update alias request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Remove an existing alias from the system. This will delete the alias mapping but will not affect the underlying collection (class). */
'aliases.delete': {
parameters: {
path: {
aliasName: string;
};
};
responses: {
/** Successfully deleted the alias. */
204: never;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Not Found - Alias does not exist */
404: {
schema: definitions['ErrorResponse'];
};
/** Invalid delete alias request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** List all created backups IDs, Status */
'backups.list': {
parameters: {
path: {
/** Specifies the backend storage system to list backups from (e.g., `filesystem`, `gcs`, `s3`, `azure`). */
backend: string;
};
query: {
/** Order of returned list of backups based on creation time. (asc or desc) */
order?: 'asc' | 'desc';
};
};
responses: {
/** Successfully retrieved the list of backups in progress. */
200: {
schema: definitions['BackupListResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid request to list backups. */
422: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred while listing backups. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Initiates the creation of a backup for specified collections on a designated backend storage.
Notes:
- Backups are compressed using gzip by default.
- Weaviate remains operational during the backup process. */
'backups.create': {
parameters: {
path: {
/** Specifies the backend storage system where the backup will be stored (e.g., `filesystem`, `gcs`, `s3`, `azure`). */
backend: string;
};
body: {
/** Details of the backup request, including the backup ID and collections to include or exclude. */
body: definitions['BackupCreateRequest'];
};
};
responses: {
/** Backup creation process initiated successfully. Check the status endpoint for progress. */
200: {
schema: definitions['BackupCreateResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid backup creation request. Check the request body and backend configuration. */
422: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred during backup initiation. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Checks the status of a specific backup creation process identified by its ID on the specified backend.
Client libraries often provide a 'wait for completion' feature that polls this endpoint automatically. Use this endpoint for manual status checks or if 'wait for completion' is disabled. */
'backups.create.status': {
parameters: {
path: {
/** Specifies the backend storage system where the backup resides (e.g., `filesystem`, `gcs`, `s3`, `azure`). */
backend: string;
/** The unique identifier of the backup. Must be URL-safe and compatible with filesystem paths (only lowercase, numbers, underscore, minus characters allowed). */
id: string;
};
query: {
/** Optional: Specifies the bucket, container, or volume name if required by the backend. */
bucket?: string;
/** Optional: Specifies the path within the bucket/container/volume if the backup is not at the root. */
path?: string;
};
};
responses: {
/** Successfully retrieved the status of the backup creation process. */
200: {
schema: definitions['BackupCreateStatusResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Backup not found on the specified backend with the given ID. */
404: {
schema: definitions['ErrorResponse'];
};
/** Invalid request to check backup creation status. */
422: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred while checking backup status. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Cancels an ongoing backup operation identified by its ID. */
'backups.cancel': {
parameters: {
path: {
/** Specifies the backend storage system where the backup resides (e.g., `filesystem`, `gcs`, `s3`, `azure`). */
backend: string;
/** The unique identifier of the backup to cancel. Must be URL-safe and compatible with filesystem paths (only lowercase, numbers, underscore, minus characters allowed). */
id: string;
};
query: {
/** Optional: Specifies the bucket, container, or volume name if required by the backend. */
bucket?: string;
/** Optional: Specifies the path within the bucket/container/volume if the backup is not at the root. */
path?: string;
};
};
responses: {
/** Backup canceled successfully. */
204: never;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid backup cancellation request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred during backup cancellation. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Checks the status of a specific backup restoration process identified by the backup ID on the specified backend.
Client libraries often provide a 'wait for completion' feature that polls this endpoint automatically. Use this endpoint for manual status checks or if 'wait for completion' is disabled. */
'backups.restore.status': {
parameters: {
path: {
/** Specifies the backend storage system where the backup resides (e.g., `filesystem`, `gcs`, `s3`, `azure`). */
backend: string;
/** The unique identifier of the backup being restored. Must be URL-safe and compatible with filesystem paths (only lowercase, numbers, underscore, minus characters allowed). */
id: string;
};
query: {
/** Optional: Specifies the bucket, container, or volume name if required by the backend. */
bucket?: string;
/** Optional: Specifies the path within the bucket. */
path?: string;
};
};
responses: {
/** Successfully retrieved the status of the backup restoration process. */
200: {
schema: definitions['BackupRestoreStatusResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Backup not found on the specified backend with the given ID. */
404: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred while checking restore status. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Initiates the restoration of collections from a specified backup located on a designated backend.
Requirements:
- Target cluster must have the same number of nodes as the source cluster where the backup was created.
- Collections included in the restore must not already exist on the target cluster.
- Node names must match between the backup and the target cluster. */
'backups.restore': {
parameters: {
path: {
/** Specifies the backend storage system where the backup resides (e.g., `filesystem`, `gcs`, `s3`, `azure`). */
backend: string;
/** The unique identifier of the backup to restore from. Must be URL-safe and compatible with filesystem paths (only lowercase, numbers, underscore, minus characters allowed). */
id: string;
};
body: {
/** Details of the restore request, including collections to include or exclude and node mapping if necessary. */
body: definitions['BackupRestoreRequest'];
};
};
responses: {
/** Backup restoration process initiated successfully. Check the status endpoint for progress. */
200: {
schema: definitions['BackupRestoreResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Backup not found on the specified backend with the given ID. */
404: {
schema: definitions['ErrorResponse'];
};
/** Invalid backup restoration request. Check requirements and request body. */
422: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred during restore initiation. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Cancels an ongoing backup restoration process identified by its ID on the specified backend storage. */
'backups.restore.cancel': {
parameters: {
path: {
/** Specifies the backend storage system where the backup resides (e.g., `filesystem`, `gcs`, `s3`, `azure`). */
backend: string;
/** The unique identifier of the backup restoration to cancel. Must be URL-safe and compatible with filesystem paths (only lowercase, numbers, underscore, minus characters allowed). */
id: string;
};
query: {
/** Optional: Specifies the bucket, container, or volume name if required by the backend. */
bucket?: string;
/** Optional: Specifies the path within the bucket/container/volume if the backup is not at the root. */
path?: string;
};
};
responses: {
/** Backup restoration cancelled successfully. */
204: never;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid backup restoration cancellation request. */
422: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred during backup restoration cancellation. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Initiates an export operation on the specified backend storage (S3, GCS, Azure, or filesystem). The output format is controlled by the required 'file_format' field in the request body (currently only 'parquet' is supported). Each collection is exported to a separate file. */
'export.create': {
parameters: {
path: {
/** The backend storage system to use for the export (e.g., `filesystem`, `gcs`, `s3`, `azure`). */
backend: string;
};
body: {
body: definitions['ExportCreateRequest'];
};
};
responses: {
/** Successfully started export operation */
200: {
schema: definitions['ExportCreateResponse'];
};
/** Unauthorized or invalid credentials */
401: unknown;
/** Forbidden - insufficient permissions */
403: {
schema: definitions['ErrorResponse'];
};
/** Export already exists or another export is already in progress */
409: {
schema: definitions['ErrorResponse'];
};
/** Invalid export request */
422: {
schema: definitions['ErrorResponse'];
};
/** Internal server error occurred while starting export */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves the current status of an export operation, including progress for each collection being exported. */
'export.status': {
parameters: {
path: {
/** The backend storage system where the export is stored. */
backend: string;
/** The unique identifier of the export. */
id: string;
};
};
responses: {
/** Successfully retrieved export status */
200: {
schema: definitions['ExportStatusResponse'];
};
/** Unauthorized or invalid credentials */
401: unknown;
/** Forbidden - insufficient permissions */
403: {
schema: definitions['ErrorResponse'];
};
/** Export not found */
404: {
schema: definitions['ErrorResponse'];
};
/** Invalid request (e.g., unsupported backend) */
422: {
schema: definitions['ErrorResponse'];
};
/** Internal server error occurred while retrieving export status */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Cancels an ongoing export operation identified by its ID. */
'export.cancel': {
parameters: {
path: {
/** The backend storage system where the export is stored. */
backend: string;
/** The unique identifier of the export to cancel. */
id: string;
};
};
responses: {
/** Export cancelled successfully. */
204: never;
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden - insufficient permissions */
403: {
schema: definitions['ErrorResponse'];
};
/** Export not found */
404: {
schema: definitions['ErrorResponse'];
};
/** Export has already finished and cannot be cancelled */
409: {
schema: definitions['ErrorResponse'];
};
/** Invalid request (e.g., unsupported backend) */
422: {
schema: definitions['ErrorResponse'];
};
/** Internal server error occurred while cancelling export */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Provides statistics about the internal Raft consensus protocol state for the Weaviate cluster. */
'cluster.get.statistics': {
responses: {
/** Successfully retrieved Raft cluster statistics. */
200: {
schema: definitions['ClusterStatisticsResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Invalid request for cluster statistics. */
422: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred while retrieving cluster statistics. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves status information about all nodes in the cluster. Use the `output` query parameter to control the level of detail. */
'nodes.get': {
parameters: {
query: {
/** Controls the verbosity of the output, possible values are: `minimal`, `verbose`. Defaults to `minimal`. */
output?: parameters['CommonOutputVerbosityParameterQuery'];
};
};
responses: {
/** Successfully retrieved the status for all nodes. */
200: {
schema: definitions['NodesStatusResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Not Found. */
404: {
schema: definitions['ErrorResponse'];
};
/** Invalid request for node status. */
422: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred while retrieving node status. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves status information only for the nodes that host shards for the specified collection (`className`). Use the `output` query parameter to control the level of detail. */
'nodes.get.class': {
parameters: {
path: {
/** The name of the collection (class) for which to retrieve node status. */
className: string;
};
query: {
shardName?: string;
/** Controls the verbosity of the output, possible values are: `minimal`, `verbose`. Defaults to `minimal`. */
output?: parameters['CommonOutputVerbosityParameterQuery'];
};
};
responses: {
/** Successfully retrieved the status for nodes relevant to the specified collection. */
200: {
schema: definitions['NodesStatusResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Not Found. */
404: {
schema: definitions['ErrorResponse'];
};
/** Invalid request for node status. */
422: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred while retrieving node status for the collection. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
'distributedTasks.get': {
responses: {
/** Distributed tasks successfully returned. */
200: {
schema: definitions['DistributedTasks'];
};
/** Unauthorized or invalid credentials. */
403: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred while retrieving distributed tasks. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Initiates a background classification task based on the provided parameters. Use the GET /classifications/{id} endpoint to monitor the status and retrieve results. */
'classifications.post': {
parameters: {
body: {
/** Configuration parameters for the classification task, including type, target properties, and training data references. */
params: definitions['Classification'];
};
};
responses: {
/** Classification task successfully initiated. The response body contains the classification details including its ID. */
201: {
schema: definitions['Classification'];
};
/** Invalid request body or parameters. */
400: {
schema: definitions['ErrorResponse'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** An internal server error occurred while starting the classification task. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Retrieves the status, metadata, and results (if completed) of a classification task identified by its unique ID. */
'classifications.get': {
parameters: {
path: {
/** The unique identifier (UUID) of the classification task. */
id: string;
};
};
responses: {
/** Successfully retrieved the classification details. */
200: {
schema: definitions['Classification'];
};
/** Unauthorized or invalid credentials. */
401: unknown;
/** Forbidden */
403: {
schema: definitions['ErrorResponse'];
};
/** Classification with the given ID not found. */
404: unknown;
/** An internal server error occurred while retrieving the classification status. Check the ErrorResponse for details. */
500: {
schema: definitions['ErrorResponse'];
};
};
};
/** Opens an SSE stream for receiving MCP server-sent events. */
'mcp.get': {
responses: {
/** SSE event stream */
200: unknown;
};
};
/** MCP Streamable HTTP endpoint. Handles JSON-RPC requests for tool discovery and invocation. */
'mcp.post': {
responses: {
/** JSON-RPC response or SSE stream */
200: unknown;
};
};
/** Terminates an MCP session. */
'mcp.delete': {
responses: {
/** Session terminated */
200: unknown;
};
};
}
export interface external {
}