weaviate
Module weaviate
API
Definitions
ballerinax/weaviate Ballerina library
Overview
Weaviate is an open-source, AI-native vector database that stores objects together with their vector embeddings, so applications can run semantic, keyword and hybrid searches over their data.
The Weaviate connector lets Ballerina applications manage collections and their properties, import, read, update and delete objects, run vector, keyword and hybrid searches, and administer tenants, aliases, backups, replication, users and roles. It supports version 1 of the Weaviate REST API.
Key features
- Create, inspect, update and delete collections and their properties
- Import objects in batches and read, patch, replace and delete them individually
- Search collections with near-text, near-object, BM25 and hybrid queries, and run GraphQL queries
- Manage multi-tenancy, aliases, backups, exports and replication
- Administer database users, roles, permissions and namespaces
Setup guide
To use the Weaviate connector, you need a running Weaviate instance and an API key that is allowed to access it.
Step 1: Get a Weaviate instance
-
Create a free sandbox cluster in Weaviate Cloud, or run Weaviate yourself by following the installation guide.
-
Note the REST endpoint of the instance. For a cloud cluster it looks like
https://<cluster-id>.weaviate.cloud/v1, and for a local Docker deployment it ishttp://localhost:8080/v1.
Step 2: Get an API key
-
For a Weaviate Cloud cluster, open the cluster details page and copy an API key from the API keys section.
-
For a self-hosted instance, enable API key authentication as described in the authentication guide and use one of the configured keys.
Quickstart
To use the Weaviate connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
Import the weaviate module.
import ballerinax/weaviate;
Step 2: Instantiate a new connector
- Create a
Config.tomlfile and configure the endpoint and API key obtained in the steps above:
weaviateUrl = "<Weaviate REST endpoint, e.g. https://<cluster-id>.weaviate.cloud/v1>" apiKey = "<Weaviate API key>"
- Create a
weaviate:ConnectionConfigwith the API key and initialize the connector with the endpoint.
configurable string weaviateUrl = ?; configurable string apiKey = ?; final weaviate:Client weaviateClient = check new ({auth: {token: apiKey}}, weaviateUrl);
Step 3: Invoke the connector operation
Now, utilize the available connector operations.
Get the instance metadata
public function main() returns error? { weaviate:Meta _ = check weaviateClient->getInstanceMeta(); }
Step 4: Run the Ballerina application
bal run
Examples
The Weaviate connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
-
Collection data management - Create a collection, add a property, import a batch of objects, list them and delete the objects that match a filter.
-
Access role setup - Create a read-only role, create a database user, assign the role to the user and read back the user's roles.
Clients
weaviate: Client
Weaviate is an open source, AI-native vector database. This client connects to the Weaviate REST API v1 to manage collections, objects, searches, tenants, backups, replication, users and roles.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://localhost:8080/v1" - URL of the target service
listEndpoints
function listEndpoints(map<string|string[]> headers) returns EndpointListResponse|errorList available endpoints
Return Type
- EndpointListResponse|error - Weaviate is alive and ready
checkLiveness
Check application liveness
Return Type
- error? - The application is alive and responding to HTTP requests
checkReadiness
Check application readiness
Return Type
- error? - The application is ready to serve traffic
getOidcConfiguration
function getOidcConfiguration(map<string|string[]> headers) returns OidcConfiguration|errorGet OIDC configuration
Return Type
- OidcConfiguration|error - OIDC configuration details returned successfully
startReplication
function startReplication(ReplicationReplicateReplicaRequest payload, map<string|string[]> headers) returns ReplicationReplicateReplicaResponse|errorInitiate a replica movement
Parameters
- payload ReplicationReplicateReplicaRequest - Replica movement details: collection, shard, source and target nodes
Return Type
- ReplicationReplicateReplicaResponse|error - Replication operation registered successfully. ID of the operation is returned
deleteAllReplications
Delete all replication operations
Return Type
- error? - Replication operation registered successfully
forceDeleteReplications
function forceDeleteReplications(ReplicationReplicateForceDeleteRequest payload, map<string|string[]> headers) returns ReplicationReplicateForceDeleteResponse|errorForce delete replication operations
Parameters
- payload ReplicationReplicateForceDeleteRequest - Filter selecting the replication operations to force delete
Return Type
- ReplicationReplicateForceDeleteResponse|error - Replication operations force deleted successfully
getReplication
function getReplication(string id, map<string|string[]> headers, *GetReplicationQueries queries) returns ReplicationReplicateDetailsReplicaResponse|errorRetrieve a replication operation
Parameters
- id string - The ID of the replication operation to get details for
- queries *GetReplicationQueries - Queries to be sent with the request
Return Type
- ReplicationReplicateDetailsReplicaResponse|error - The details of the replication operation
deleteReplication
Delete a replication operation
Parameters
- id string - The ID of the replication operation to delete
Return Type
- error? - Successfully deleted
listReplications
function listReplications(map<string|string[]> headers, *ListReplicationsQueries queries) returns ReplicationReplicateDetailsReplicaResponse[]|errorList replication operations
Parameters
- queries *ListReplicationsQueries - Queries to be sent with the request
Return Type
- ReplicationReplicateDetailsReplicaResponse[]|error - The details of the replication operations
cancelReplication
Cancel a replication operation
Parameters
- id string - The ID of the replication operation to cancel
Return Type
- error? - Successfully cancelled
getCollectionShardingState
function getCollectionShardingState(map<string|string[]> headers, *GetCollectionShardingStateQueries queries) returns ReplicationShardingStateResponse|errorGet sharding state
Parameters
- queries *GetCollectionShardingStateQueries - Queries to be sent with the request
Return Type
- ReplicationShardingStateResponse|error - Successfully retrieved sharding state
getReplicationScalePlan
function getReplicationScalePlan(map<string|string[]> headers, *GetReplicationScalePlanQueries queries) returns ReplicationScalePlan|errorGet replication scale plan
Parameters
- queries *GetReplicationScalePlanQueries - Queries to be sent with the request
Return Type
- ReplicationScalePlan|error - Replication scale plan showing node additions and removals per shard
applyReplicationScalePlan
function applyReplicationScalePlan(ReplicationScalePlan payload, map<string|string[]> headers) returns ReplicationScaleApplyResponse|errorApply replication scaling plan
Parameters
- payload ReplicationScalePlan - The replication scaling plan specifying the collection and its shard-level replica adjustments
Return Type
- ReplicationScaleApplyResponse|error - List of replication shard copy operation IDs initiated for the scale operation
getOwnUserInfo
function getOwnUserInfo(map<string|string[]> headers) returns UserOwnInfo|errorGet current user info
Return Type
- UserOwnInfo|error - Info about the user
listUsers
function listUsers(map<string|string[]> headers, *ListUsersQueries queries) returns DBUserInfo[]|errorList all users
Parameters
- queries *ListUsersQueries - Queries to be sent with the request
Return Type
- DBUserInfo[]|error - Info about the users
exportDbUsers
function exportDbUsers(map<string|string[]> headers) returns UserExportResponse|errorExport all database-user credentials
Return Type
- UserExportResponse|error - The exported user credentials
importDbUsers
function importDbUsers(UserImportRequest payload, map<string|string[]> headers) returns UserImportResponse|errorImport database-user credentials
Parameters
- payload UserImportRequest - Database user credentials to import, with their hashes and status
Return Type
- UserImportResponse|error - The per-user import results
getUser
function getUser(string userId, map<string|string[]> headers, *GetUserQueries queries) returns DBUserInfo|errorGet user info
Parameters
- userId string - The name of the user
- queries *GetUserQueries - Queries to be sent with the request
Return Type
- DBUserInfo|error - Info about the user
createUser
function createUser(string userId, CreateUserRequest payload, map<string|string[]> headers) returns UserApiKey|errorCreate a new user
Parameters
- userId string - The name of the user
- payload CreateUserRequest - Optional settings for creating the database user
Return Type
- UserApiKey|error - User created successfully and API key returned
deleteUser
Delete a user
Parameters
- userId string - The name of the user
Return Type
- error? - Successfully deleted
rotateUserApiKey
Rotate API key of a user
Parameters
- userId string - The name of the user
Return Type
- UserApiKey|error - API key successfully updated
activateUser
Activate a user
Parameters
- userId string - The name of the user
Return Type
- error? - User successfully activated
deactivateUser
function deactivateUser(string userId, DeactivateUserRequest payload, map<string|string[]> headers) returns error?Deactivate a user
Parameters
- userId string - The name of the user
- payload DeactivateUserRequest - Options for deactivating the user, including key revocation
Return Type
- error? - User successfully deactivated
listRoles
function listRoles(map<string|string[]> headers) returns RolesListResponse|errorGet all roles
Return Type
- RolesListResponse|error - Successful response
createRole
Create new role
Parameters
- payload Role - Role name and the permissions granted to the new role
Return Type
- error? - Role created successfully
addRolePermissions
function addRolePermissions(string id, AddRolePermissionsRequest payload, map<string|string[]> headers) returns error?Add permissions to a role
Parameters
- id string - The name (ID) of the role being modified
- payload AddRolePermissionsRequest - Permissions to add to the role
Return Type
- error? - Permissions added successfully
removeRolePermissions
function removeRolePermissions(string id, RemoveRolePermissionsRequest payload, map<string|string[]> headers) returns error?Remove permissions from a role
Parameters
- id string - The name of the role being modified
- payload RemoveRolePermissionsRequest - Permissions to remove from the role
Return Type
- error? - Permissions removed successfully
getRole
Get a role
Parameters
- id string - The name of the role
deleteRole
Delete a role
Parameters
- id string - The name of the role
Return Type
- error? - Successfully deleted
checkRolePermission
function checkRolePermission(string id, Permission payload, map<string|string[]> headers) returns boolean|errorCheck whether a role possesses a permission
getRoleUsers
Get users assigned to a role (deprecated)
Parameters
- id string - The name of the role
Deprecated
getRoleUserAssignments
function getRoleUserAssignments(string id, map<string|string[]> headers) returns RoleUserAssignment[]|errorGet users assigned to a role
Parameters
- id string - The name (ID) of the role
Return Type
- RoleUserAssignment[]|error - Users assigned to this role
getRoleGroupAssignments
function getRoleGroupAssignments(string id, map<string|string[]> headers) returns RoleGroupAssignment[]|errorGet groups that have a specific role assigned
Parameters
- id string - The unique name of the role
Return Type
- RoleGroupAssignment[]|error - Successfully retrieved the list of groups that have the role assigned
getUserRoles
Get roles assigned to a user (deprecated)
Parameters
- id string - The name of the user
Return Type
- RolesListResponse|error - Roles assigned to the user
Deprecated
getUserRolesByType
function getUserRolesByType(string id, "oidc"|"db" userType, map<string|string[]> headers, *GetUserRolesByTypeQueries queries) returns RolesListResponse|errorGet roles assigned to a user
Parameters
- id string - The name of the user
- userType "oidc"|"db" - The type of the user
- queries *GetUserRolesByTypeQueries - Queries to be sent with the request
Return Type
- RolesListResponse|error - Roles assigned to the user
assignRoleToUser
function assignRoleToUser(string id, AssignRoleToUserRequest payload, map<string|string[]> headers) returns error?Assign a role to a user
Parameters
- id string - The name of the user
- payload AssignRoleToUserRequest - Roles to assign to the user and the user type
Return Type
- error? - Role assigned successfully
revokeRoleFromUser
function revokeRoleFromUser(string id, RevokeRoleFromUserRequest payload, map<string|string[]> headers) returns error?Revoke a role from a user
Parameters
- id string - The name of the user
- payload RevokeRoleFromUserRequest - Roles to revoke from the user and the user type
Return Type
- error? - Roles revoked successfully
assignRoleToGroup
function assignRoleToGroup(string id, AssignRoleToGroupRequest payload, map<string|string[]> headers) returns error?Assign a role to a group
Parameters
- id string - The name of the group
- payload AssignRoleToGroupRequest - Roles to assign to the group and the group type
Return Type
- error? - Roles assigned successfully
revokeRoleFromGroup
function revokeRoleFromGroup(string id, RevokeRoleFromGroupRequest payload, map<string|string[]> headers) returns error?Revoke a role from a group
Parameters
- id string - The name of the group
- payload RevokeRoleFromGroupRequest - Roles to revoke from the group and the group type
Return Type
- error? - Roles revoked successfully
getGroupRoles
function getGroupRoles(string id, "oidc" groupType, map<string|string[]> headers, *GetGroupRolesQueries queries) returns RolesListResponse|errorGet roles assigned to a specific group
Parameters
- id string - The unique name of the group
- groupType "oidc" - The type of the group
- queries *GetGroupRolesQueries - Queries to be sent with the request
Return Type
- RolesListResponse|error - A list of roles assigned to the specified group
listGroups
List all groups of a specific type
Parameters
- groupType "oidc" - The type of group to retrieve
listObjects
function listObjects(map<string|string[]> headers, *ListObjectsQueries queries) returns ObjectsListResponse|errorList objects
Parameters
- queries *ListObjectsQueries - Queries to be sent with the request
Return Type
- ObjectsListResponse|error - Successful response containing the list of objects. If the collection name (
class) is not provided, the response will not include any objects
createObject
function createObject(WeaviateObject payload, map<string|string[]> headers, *CreateObjectQueries queries) returns WeaviateObject|errorCreate an object
Parameters
- payload WeaviateObject - The object to be created
- queries *CreateObjectQueries - Queries to be sent with the request
Return Type
- WeaviateObject|error - Object created successfully
getObject
function getObject(string id, map<string|string[]> headers, *GetObjectQueries queries) returns WeaviateObject|errorGet an object by ID
Parameters
- id string - Unique UUID of the object to be retrieved
- queries *GetObjectQueries - Queries to be sent with the request
Return Type
- WeaviateObject|error - Successful response containing the object
Deprecated
replaceObject
function replaceObject(string id, WeaviateObject payload, map<string|string[]> headers, *ReplaceObjectQueries queries) returns WeaviateObject|errorUpdate an object
Parameters
- id string - Unique UUID of the object to be replaced
- payload WeaviateObject - The object definition to replace the existing object with
- queries *ReplaceObjectQueries - Queries to be sent with the request
Return Type
- WeaviateObject|error - Object replaced successfully
Deprecated
deleteObject
function deleteObject(string id, map<string|string[]> headers, *DeleteObjectQueries queries) returns error?Delete an object by ID
Parameters
- id string - Unique UUID of the object to be deleted
- queries *DeleteObjectQueries - Queries to be sent with the request
Return Type
- error? - Object deleted successfully
Deprecated
updateObject
function updateObject(string id, WeaviateObject payload, map<string|string[]> headers, *UpdateObjectQueries queries) returns error?Patch an object by ID
Parameters
- id string - Unique UUID of the object to be patched
- payload WeaviateObject - RFC 7396-style JSON merge patch object containing the fields to update
- queries *UpdateObjectQueries - Queries to be sent with the request
Return Type
- error? - Object patched successfully
Deprecated
checkObjectExists
Check if an object exists by ID
Parameters
- id string - Unique UUID of the object to check
Deprecated
getCollectionObject
function getCollectionObject(string className, string id, map<string|string[]> headers, *GetCollectionObjectQueries queries) returns WeaviateObject|errorGet an object
Parameters
- className string - Name of the collection (class) the object belongs to
- id string - Unique UUID of the object to be retrieved
- queries *GetCollectionObjectQueries - Queries to be sent with the request
Return Type
- WeaviateObject|error - Successful response containing the object
replaceCollectionObject
function replaceCollectionObject(string className, string id, WeaviateObject payload, map<string|string[]> headers, *ReplaceCollectionObjectQueries queries) returns WeaviateObject|errorReplace an object
Parameters
- className string - Name of the collection (class) the object belongs to
- id string - Unique UUID of the object to be replaced
- payload WeaviateObject - The object definition to replace the existing object with
- queries *ReplaceCollectionObjectQueries - Queries to be sent with the request
Return Type
- WeaviateObject|error - Object replaced successfully
deleteCollectionObject
function deleteCollectionObject(string className, string id, map<string|string[]> headers, *DeleteCollectionObjectQueries queries) returns error?Delete an object
Parameters
- className string - Name of the collection (class) the object belongs to
- id string - Unique UUID of the object to be deleted
- queries *DeleteCollectionObjectQueries - Queries to be sent with the request
Return Type
- error? - Object deleted successfully
updateCollectionObject
function updateCollectionObject(string className, string id, WeaviateObject payload, map<string|string[]> headers, *UpdateCollectionObjectQueries queries) returns error?Patch an object
Parameters
- className string - Name of the collection (class) the object belongs to
- id string - Unique UUID of the object to be patched
- payload WeaviateObject - RFC 7396-style JSON merge patch object containing the fields to update
- queries *UpdateCollectionObjectQueries - Queries to be sent with the request
Return Type
- error? - Object patched successfully
checkCollectionObjectExists
function checkCollectionObjectExists(string className, string id, map<string|string[]> headers, *CheckCollectionObjectExistsQueries queries) returns Response|errorCheck if an object exists
Parameters
- className string - Name of the collection (class) the object belongs to
- id string - Unique UUID of the object to check
- queries *CheckCollectionObjectExistsQueries - Queries to be sent with the request
replaceObjectReferences
function replaceObjectReferences(string id, string propertyName, MultipleRef payload, map<string|string[]> headers, *ReplaceObjectReferencesQueries queries) returns error?Replace object references by object ID
Parameters
- id string - Unique UUID of the source object
- propertyName string - Unique name of the reference property of the source object
- payload MultipleRef - The new list of references
- queries *ReplaceObjectReferencesQueries - Queries to be sent with the request
Return Type
- error? - References replaced successfully
Deprecated
addObjectReference
function addObjectReference(string id, string propertyName, SingleRef payload, map<string|string[]> headers, *AddObjectReferenceQueries queries) returns error?Add an object reference by object ID
Parameters
- id string - Unique UUID of the source object
- propertyName string - Unique name of the reference property of the source object
- payload SingleRef - The reference to add
- queries *AddObjectReferenceQueries - Queries to be sent with the request
Return Type
- error? - Reference added successfully
Deprecated
deleteObjectReference
function deleteObjectReference(string id, string propertyName, SingleRef payload, map<string|string[]> headers, *DeleteObjectReferenceQueries queries) returns error?Delete an object reference by object ID
Parameters
- id string - Unique UUID of the source object
- propertyName string - Unique name of the reference property of the source object
- payload SingleRef - The reference to remove
- queries *DeleteObjectReferenceQueries - Queries to be sent with the request
Return Type
- error? - Reference deleted successfully
Deprecated
replaceCollectionObjectReferences
function replaceCollectionObjectReferences(string className, string id, string propertyName, MultipleRef payload, map<string|string[]> headers, *ReplaceCollectionObjectReferencesQueries queries) returns error?Replace object references
Parameters
- className string - Name of the collection (class) the source object belongs to
- id string - Unique UUID of the source object
- propertyName string - Unique name of the reference property of the source object
- payload MultipleRef - The new list of references
- queries *ReplaceCollectionObjectReferencesQueries - Queries to be sent with the request
Return Type
- error? - References replaced successfully
addCollectionObjectReference
function addCollectionObjectReference(string className, string id, string propertyName, SingleRef payload, map<string|string[]> headers, *AddCollectionObjectReferenceQueries queries) returns error?Add an object reference
Parameters
- className string - Name of the collection (class) the source object belongs to
- id string - Unique UUID of the source object
- propertyName string - Unique name of the reference property of the source object
- payload SingleRef - The reference to add
- queries *AddCollectionObjectReferenceQueries - Queries to be sent with the request
Return Type
- error? - Reference added successfully
deleteCollectionObjectReference
function deleteCollectionObjectReference(string className, string id, string propertyName, SingleRef payload, map<string|string[]> headers, *DeleteCollectionObjectReferenceQueries queries) returns error?Delete an object reference
Parameters
- className string - Name of the collection (class) the source object belongs to
- id string - Unique UUID of the source object
- propertyName string - Unique name of the reference property of the source object
- payload SingleRef - The reference to remove
- queries *DeleteCollectionObjectReferenceQueries - Queries to be sent with the request
Return Type
- error? - Reference deleted successfully
validateObject
function validateObject(WeaviateObject payload, map<string|string[]> headers) returns error?Validate an object
Parameters
- payload WeaviateObject - The object definition to validate
Return Type
- error? - Object is valid according to the schema
createObjectsBatch
function createObjectsBatch(BatchObjectsBody payload, map<string|string[]> headers, *CreateObjectsBatchQueries queries) returns ObjectsGetResponse[]|errorCreate objects in batch
Parameters
- payload BatchObjectsBody - The request body containing the objects to be created
- queries *CreateObjectsBatchQueries - Queries to be sent with the request
Return Type
- ObjectsGetResponse[]|error - Request processed successfully. Individual object statuses are provided in the response body
deleteObjectsBatch
function deleteObjectsBatch(BatchDelete payload, map<string|string[]> headers, *DeleteObjectsBatchQueries queries) returns BatchDeleteResponse|errorDelete objects in batch
Parameters
- payload BatchDelete - The request body containing the match filter and output configuration
- queries *DeleteObjectsBatchQueries - Queries to be sent with the request
Return Type
- BatchDeleteResponse|error - Request processed successfully. See response body for matching objects and deletion results
createReferencesBatch
function createReferencesBatch(BatchReference[] payload, map<string|string[]> headers, *CreateReferencesBatchQueries queries) returns BatchReferenceResponse[]|errorCreate cross-references in bulk
Parameters
- payload BatchReference[] - 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
- queries *CreateReferencesBatchQueries - Queries to be sent with the request
Return Type
- BatchReferenceResponse[]|error - 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
executeGraphql
function executeGraphql(GraphQLQuery payload, map<string|string[]> headers) returns GraphQLResponse|errorPerform a GraphQL query
Parameters
- payload GraphQLQuery - The GraphQL query to execute, including the query string and optional variables
Return Type
- GraphQLResponse|error - Query executed successfully. The response body contains the query result
executeGraphqlBatch
function executeGraphqlBatch(GraphQLQueries payload, map<string|string[]> headers) returns GraphQLResponses|errorPerform batched GraphQL queries
Parameters
- payload GraphQLQueries - An array containing multiple GraphQL query objects to execute in batch
Return Type
- GraphQLResponses|error - Batch request processed successfully. The response body contains an array of results corresponding to the input queries
getInstanceMeta
Get instance metadata
tokenizeText
function tokenizeText(TokenizeRequest payload, map<string|string[]> headers) returns TokenizeResponse|errorTokenize text
Parameters
- payload TokenizeRequest - Text to tokenize and the tokenization method to apply
Return Type
- TokenizeResponse|error - Successfully tokenized the text
listCollections
function listCollections(ListCollectionsHeaders headers) returns Schema|errorGet all collection definitions
Parameters
- headers ListCollectionsHeaders (default {}) - Headers to be sent with the request
createCollection
function createCollection(Collection payload, map<string|string[]> headers) returns Collection|errorCreate a new collection
Parameters
- payload Collection - The definition of the collection (class) to create
Return Type
- Collection|error - Collection created successfully and its definition returned
getCollection
function getCollection(string className, GetCollectionHeaders headers) returns Collection|errorGet a single collection
Parameters
- className string - The name of the collection (class) to retrieve
- headers GetCollectionHeaders (default {}) - Headers to be sent with the request
Return Type
- Collection|error - Successfully retrieved the collection definition
updateCollection
function updateCollection(string className, Collection payload, map<string|string[]> headers) returns Collection|errorUpdate collection definition
Parameters
- className string - The name of the collection (class) to update
- payload Collection - The updated collection definition containing the settings to modify
Return Type
- Collection|error - Collection settings updated successfully
deleteCollection
Delete a collection (and all associated data)
Parameters
- className string - The name of the collection (class) to delete
Return Type
- error? - Collection deleted successfully
addCollectionProperty
function addCollectionProperty(string className, Property payload, map<string|string[]> headers) returns Property|errorAdd a property to a collection
Parameters
- className string - The name of the collection (class) to add the property to
- payload Property - The definition of the property to add
getCollectionIndexes
function getCollectionIndexes(string className, map<string|string[]> headers) returns IndexStatusResponse|errorGet index status for all properties of a collection
Parameters
- className string -
Return Type
- IndexStatusResponse|error - Index status for all properties
upsertPropertyIndex
function upsertPropertyIndex(string className, string propertyName, "filterable"|"searchable"|"rangeFilters"|"rangeable" indexName, IndexUpsertRequest payload, map<string|string[]> headers, *UpsertPropertyIndexQueries queries) returns IndexUpdateResponse|errorDeclaratively create or migrate a property's inverted index
Parameters
- className string - The name of the collection (class) containing the property
- propertyName string - The name of the property whose inverted index should be upserted
- indexName "filterable"|"searchable"|"rangeFilters"|"rangeable" - The inverted index type to upsert.
rangeableis accepted as a write-path alias forrangeFilters
- payload IndexUpsertRequest - Index configuration to create or migrate on the property
- queries *UpsertPropertyIndexQueries - Queries to be sent with the request
Return Type
- IndexUpdateResponse|error - Desired configuration already in place AND no reindex task in flight; no task submitted. Body carries
{"status":"NO_OP"}
deletePropertyIndex
function deletePropertyIndex(string className, string propertyName, "filterable"|"searchable"|"rangeFilters"|"rangeable" indexName, map<string|string[]> headers) returns error?Delete a property's inverted index
Parameters
- className string - The name of the collection (class) containing the property
- propertyName string - The name of the property whose inverted index should be deleted
- indexName "filterable"|"searchable"|"rangeFilters"|"rangeable" - The name of the inverted index to delete from the property.
rangeableis accepted as a write-path alias forrangeFilters
Return Type
- error? - Index deleted successfully
rebuildPropertyIndex
function rebuildPropertyIndex(string className, string propertyName, "filterable"|"searchable"|"rangeFilters"|"rangeable" indexName, map<string|string[]> headers, *RebuildPropertyIndexQueries queries) returns IndexUpdateResponse|errorRebuild a property's inverted index with unchanged configuration
Parameters
- className string - The name of the collection (class) containing the property
- propertyName string - The name of the property whose inverted index should be rebuilt
- indexName "filterable"|"searchable"|"rangeFilters"|"rangeable" - The inverted index type to rebuild.
rangeableis accepted as a write-path alias forrangeFilters
- queries *RebuildPropertyIndexQueries - Queries to be sent with the request
Return Type
- IndexUpdateResponse|error - Reindex task submitted
cancelPropertyReindex
function cancelPropertyReindex(string className, string propertyName, "filterable"|"searchable"|"rangeFilters"|"rangeable" indexName, map<string|string[]> headers) returns IndexUpdateResponse|errorCancel the in-flight reindex task on a property's inverted index
Parameters
- className string - The name of the collection (class) containing the property
- propertyName string - The name of the property whose reindex task should be cancelled
- indexName "filterable"|"searchable"|"rangeFilters"|"rangeable" - The inverted index type whose in-flight task should be cancelled.
rangeableis accepted as a write-path alias forrangeFilters
Return Type
- IndexUpdateResponse|error - Cancellation processed. Body carries
{"status":"CANCELLED","taskId":...}when a STARTED task was cancelled, or{"status":"NO_OP"}when there was nothing to cancel
tokenizePropertyText
function tokenizePropertyText(string className, string propertyName, PropertyTokenizeRequest payload, map<string|string[]> headers) returns TokenizeResponse|errorTokenize text using a property's configuration
Parameters
- className string - The name of the collection (class) containing the property
- propertyName string - The name of the property whose tokenization configuration should be used
- payload PropertyTokenizeRequest - Text to tokenize using the property's tokenization settings
Return Type
- TokenizeResponse|error - Successfully tokenized the text using the property's configuration
deleteVectorIndex
function deleteVectorIndex(string className, string vectorIndexName, map<string|string[]> headers) returns error?Delete a collection's vector index.
Parameters
- className string - The name of the collection (class) containing the property
- vectorIndexName string - The name of the vector index
Return Type
- error? - Vector index deleted successfully
listCollectionShards
function listCollectionShards(string className, map<string|string[]> headers, *ListCollectionShardsQueries queries) returns ShardStatusList|errorGet the shards status of a collection
Parameters
- className string - The name of the collection (class) whose shards to query
- queries *ListCollectionShardsQueries - Queries to be sent with the request
Return Type
- ShardStatusList|error - Shard statuses retrieved successfully
updateShardStatus
function updateShardStatus(string className, string shardName, ShardStatus payload, map<string|string[]> headers) returns ShardStatus|errorUpdate a shard status
Parameters
- className string - The name of the collection (class) containing the shard
- shardName string - The name of the shard to update
- payload ShardStatus - The shard status object containing the desired new status
Return Type
- ShardStatus|error - Shard status updated successfully
listTenants
function listTenants(string className, ListTenantsHeaders headers) returns Tenant[]|errorGet the list of tenants
Parameters
- className string - The name of the collection (class) whose tenants to list
- headers ListTenantsHeaders (default {}) - Headers to be sent with the request
updateTenants
function updateTenants(string className, Tenant[] payload, map<string|string[]> headers) returns Tenant[]|errorUpdate a tenant
Parameters
- className string - The name of the collection (class) containing the tenants
- payload Tenant[] - An array of tenant objects specifying the tenants to update and their desired new status
createTenants
function createTenants(string className, Tenant[] payload, map<string|string[]> headers) returns Tenant[]|errorCreate a new tenant
Parameters
- className string - The name of the multi-tenant enabled collection (class)
- payload Tenant[] - An array of tenant objects to create
deleteTenants
function deleteTenants(string className, string[] payload, map<string|string[]> headers) returns error?Delete tenants
Parameters
- className string - The name of the collection (class) from which to delete tenants
- payload string[] - An array of tenant names to delete
Return Type
- error? - Tenants deleted successfully
getTenant
function getTenant(string className, string tenantName, GetTenantHeaders headers) returns Tenant|errorGet a specific tenant
Parameters
- className string - The name of the collection (class) containing the tenant
- tenantName string - The name of the tenant to retrieve
- headers GetTenantHeaders (default {}) - Headers to be sent with the request
checkTenantExists
function checkTenantExists(string className, string tenantName, CheckTenantExistsHeaders headers) returns Response|errorCheck if a tenant exists
Parameters
- className string - The name of the collection (class) to check within
- tenantName string - The name of the tenant to check for
- headers CheckTenantExistsHeaders (default {}) - Headers to be sent with the request
listAliases
function listAliases(map<string|string[]> headers, *ListAliasesQueries queries) returns AliasResponse|errorList aliases
Parameters
- queries *ListAliasesQueries - Queries to be sent with the request
Return Type
- AliasResponse|error - Successfully retrieved the list of aliases
createAlias
Create a new alias
Parameters
- payload Alias - Alias name and the collection it should point to
getAlias
Get an alias
Parameters
- aliasName string -
updateAlias
function updateAlias(string aliasName, UpdateAliasRequest payload, map<string|string[]> headers) returns Alias|errorUpdate an alias
Parameters
- aliasName string -
- payload UpdateAliasRequest - The collection that the alias should point to
deleteAlias
Delete an alias
Parameters
- aliasName string -
Return Type
- error? - Successfully deleted the alias
listNamespaces
function listNamespaces(map<string|string[]> headers) returns NamespaceListResponse|errorList namespaces
Return Type
- NamespaceListResponse|error - Successfully retrieved the list of namespaces (possibly empty)
getNamespace
Get a namespace
Parameters
- namespaceId string - The name of the namespace
updateNamespace
function updateNamespace(string namespaceId, NamespaceUpdateRequest payload, map<string|string[]> headers) returns Namespace|errorUpdate a namespace
Parameters
- namespaceId string - The name of the namespace
- payload NamespaceUpdateRequest - Required body.
home_nodeis the new placement target
createNamespace
function createNamespace(string namespaceId, NamespaceCreateRequest payload, map<string|string[]> headers) returns Namespace|errorCreate a new namespace
Parameters
- namespaceId string - The name of the namespace. Must start with a lowercase letter, contain only lowercase letters and digits, length 3-36, and not be a reserved name
- payload NamespaceCreateRequest - Optional body. When omitted,
home_nodeis picked automatically
deleteNamespace
Delete a namespace
Parameters
- namespaceId string - The name of the namespace
Return Type
- error? - The namespace has been marked for deletion. Cleanup of its classes, aliases, and users completes asynchronously
suspendNamespace
Suspend a namespace
Parameters
- namespaceId string - The name of the namespace
Return Type
- error? - The state change is committed and the namespace is suspended
resumeNamespace
Resume a namespace
Parameters
- namespaceId string - The name of the namespace
Return Type
- error? - The state change is committed and the namespace is active
listBackups
function listBackups(string backend, map<string|string[]> headers, *ListBackupsQueries queries) returns BackupListResponse|errorList all created backups
Parameters
- backend string - Specifies the backend storage system to list backups from (e.g.,
filesystem,gcs,s3,azure)
- queries *ListBackupsQueries - Queries to be sent with the request
Return Type
- BackupListResponse|error - Successfully retrieved the list of backups in progress
createBackup
function createBackup(string backend, BackupCreateRequest payload, map<string|string[]> headers) returns BackupCreateResponse|errorCreate a backup
Parameters
- backend string - Specifies the backend storage system where the backup will be stored (e.g.,
filesystem,gcs,s3,azure)
- payload BackupCreateRequest - Details of the backup request, including the backup ID and collections to include or exclude
Return Type
- BackupCreateResponse|error - Backup creation process initiated successfully. Check the status endpoint for progress
getBackupStatus
function getBackupStatus(string backend, string id, map<string|string[]> headers, *GetBackupStatusQueries queries) returns BackupCreateStatusResponse|errorGet backup creation status
Parameters
- backend string - Specifies the backend storage system where the backup resides (e.g.,
filesystem,gcs,s3,azure)
- id string - The unique identifier of the backup. Must be URL-safe and compatible with filesystem paths (only lowercase, numbers, underscore, minus characters allowed)
- queries *GetBackupStatusQueries - Queries to be sent with the request
Return Type
- BackupCreateStatusResponse|error - Successfully retrieved the status of the backup creation process
cancelBackup
function cancelBackup(string backend, string id, map<string|string[]> headers, *CancelBackupQueries queries) returns error?Cancel a backup
Parameters
- backend string - Specifies the backend storage system where the backup resides (e.g.,
filesystem,gcs,s3,azure)
- id 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)
- queries *CancelBackupQueries - Queries to be sent with the request
Return Type
- error? - Backup canceled successfully
getBackupRestoreStatus
function getBackupRestoreStatus(string backend, string id, map<string|string[]> headers, *GetBackupRestoreStatusQueries queries) returns BackupRestoreStatusResponse|errorGet backup restoration status
Parameters
- backend string - Specifies the backend storage system where the backup resides (e.g.,
filesystem,gcs,s3,azure)
- id 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)
- queries *GetBackupRestoreStatusQueries - Queries to be sent with the request
Return Type
- BackupRestoreStatusResponse|error - Successfully retrieved the status of the backup restoration process
restoreBackup
function restoreBackup(string backend, string id, BackupRestoreRequest payload, map<string|string[]> headers) returns BackupRestoreResponse|errorRestore from a backup
Parameters
- backend string - Specifies the backend storage system where the backup resides (e.g.,
filesystem,gcs,s3,azure)
- id 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)
- payload BackupRestoreRequest - Details of the restore request, including collections to include or exclude and node mapping if necessary
Return Type
- BackupRestoreResponse|error - Backup restoration process initiated successfully. Check the status endpoint for progress
cancelBackupRestore
function cancelBackupRestore(string backend, string id, map<string|string[]> headers, *CancelBackupRestoreQueries queries) returns error?Cancel a backup restoration
Parameters
- backend string - Specifies the backend storage system where the backup resides (e.g.,
filesystem,gcs,s3,azure)
- id 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)
- queries *CancelBackupRestoreQueries - Queries to be sent with the request
Return Type
- error? - Backup restoration cancelled successfully
createExport
function createExport(string backend, ExportCreateRequest payload, map<string|string[]> headers) returns ExportCreateResponse|errorStart a new export
Parameters
- backend string - The backend storage system to use for the export (e.g.,
filesystem,gcs,s3,azure)
- payload ExportCreateRequest - Export identifier and the collections and file format to export
Return Type
- ExportCreateResponse|error - Successfully started export operation
getExportStatus
function getExportStatus(string backend, string id, map<string|string[]> headers) returns ExportStatusResponse|errorGet export status
Parameters
- backend string - The backend storage system where the export is stored
- id string - The unique identifier of the export
Return Type
- ExportStatusResponse|error - Successfully retrieved export status
cancelExport
Cancel an export
Parameters
- backend string - The backend storage system where the export is stored
- id string - The unique identifier of the export to cancel
Return Type
- error? - Export cancelled successfully
getClusterStatistics
function getClusterStatistics(map<string|string[]> headers) returns ClusterStatisticsResponse|errorGet cluster statistics
Return Type
- ClusterStatisticsResponse|error - Successfully retrieved Raft cluster statistics
listNodes
function listNodes(map<string|string[]> headers, *ListNodesQueries queries) returns NodesStatusResponse|errorGet node status
Parameters
- queries *ListNodesQueries - Queries to be sent with the request
Return Type
- NodesStatusResponse|error - Successfully retrieved the status for all nodes
listCollectionNodes
function listCollectionNodes(string className, map<string|string[]> headers, *ListCollectionNodesQueries queries) returns NodesStatusResponse|errorGet node status by collection
Parameters
- className string - The name of the collection (class) for which to retrieve node status
- queries *ListCollectionNodesQueries - Queries to be sent with the request
Return Type
- NodesStatusResponse|error - Successfully retrieved the status for nodes relevant to the specified collection
listDistributedTasks
function listDistributedTasks(map<string|string[]> headers) returns DistributedTasks|errorLists all distributed tasks in the cluster
Return Type
- DistributedTasks|error - Distributed tasks successfully returned
startClassification
function startClassification(Classification payload, map<string|string[]> headers) returns Classification|errorStart a classification
Parameters
- payload Classification - Configuration parameters for the classification task, including type, target properties, and training data references
Return Type
- Classification|error - Classification task successfully initiated. The response body contains the classification details including its ID
getClassification
Get classification status
Parameters
- id string - The unique identifier (UUID) of the classification task
Return Type
- Classification|error - Successfully retrieved the classification details
sendMcpRequest
Send an MCP JSON-RPC request
Parameters
- payload record {} - JSON-RPC 2.0 request message
Return Type
- record {}|error - JSON-RPC response or SSE stream
endMcpSession
End an MCP session
Return Type
- error? - Accepted; there is no session state to terminate
aggregateCollection
function aggregateCollection(string collection, AggregateRequest payload, map<string|string[]> headers) returns AggregateResponse|errorAggregate over a collection
Parameters
- collection string - The name (or alias) of the collection to aggregate over. A lowercase first letter is normalized to the canonical uppercase form
- payload AggregateRequest - The aggregate request
Return Type
- AggregateResponse|error - Aggregation performed successfully
searchBm25
function searchBm25(string collection, SearchBm25Request payload, map<string|string[]> headers) returns SearchResponse|errorSearch a collection with bm25
Parameters
- collection string - The name (or alias) of the collection to search. A lowercase first letter is normalized to the canonical uppercase form
- payload SearchBm25Request - The bm25 search request
Return Type
- SearchResponse|error - Search performed successfully
searchHybrid
function searchHybrid(string collection, SearchHybridRequest payload, map<string|string[]> headers) returns SearchResponse|errorSearch a collection with hybrid
Parameters
- collection string - The name (or alias) of the collection to search. A lowercase first letter is normalized to the canonical uppercase form
- payload SearchHybridRequest - The hybrid search request
Return Type
- SearchResponse|error - Search performed successfully
searchNearObject
function searchNearObject(string collection, SearchNearObjectRequest payload, map<string|string[]> headers) returns SearchResponse|errorSearch a collection with near-object
Parameters
- collection string - The name (or alias) of the collection to search. A lowercase first letter is normalized to the canonical uppercase form
- payload SearchNearObjectRequest - The near-object search request
Return Type
- SearchResponse|error - Search performed successfully
searchNearText
function searchNearText(string collection, SearchNearTextRequest payload, map<string|string[]> headers) returns SearchResponse|errorSearch a collection with near-text
Parameters
- collection string - The name (or alias) of the collection to search. A lowercase first letter is normalized to the canonical uppercase form
- payload SearchNearTextRequest - The near-text search request
Return Type
- SearchResponse|error - Search performed successfully
Records
weaviate: AddCollectionObjectReferenceQueries
Represents the Queries record for the operation: addCollectionObjectReference
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
- tenant? string - Specifies the tenant in a request targeting a multi-tenant collection (class)
weaviate: AdditionalProperties
(Response only) Additional meta information about a single object
Fields
- record {}... - Rest field
weaviate: AddObjectReferenceQueries
Represents the Queries record for the operation: addObjectReference
Fields
- tenant? string - Specifies the tenant in a request targeting a multi-tenant collection (class)
weaviate: AddRolePermissionsRequest
Fields
- permissions Permission[] - Permissions to be added to the role
weaviate: AggregateGroup
One group of a grouped aggregation: the group's identity under groupedBy and its aggregated metrics (phase 1: count)
Fields
- groupedBy AggregateGroupedBy - The identity of one group: the
groupByproperty (as a one-element path) and the property value that formed the group
- count int - The number of objects in the group
weaviate: AggregateGroupedBy
The identity of one group: the groupBy property (as a one-element path) and the property value that formed the group
Fields
- path string[] - The grouped property, as a one-element path
- value record {} - The property value that formed the group. Typed as the property is: text values are strings, numeric values numbers, boolean values booleans; grouping by a reference property yields the reference's beacon URI as a string
weaviate: AggregateRequest
Request body for the aggregate endpoint. Phase 1 supports counts: the number of matching objects, in total or per group. Unknown fields are ignored (platform parity with the other endpoints). Reserved fields are accepted by the schema but rejected by the server with 422 until the corresponding feature ships. An empty body {} returns the collection's total object count
Fields
- over? record {}? - Reserved for aggregate-over-search (aggregating the results of a vector, keyword or hybrid search). Returns 422 (not yet supported)
- objectLimit? int? - Reserved for aggregate-over-search (the maximum number of search results to aggregate). Returns 422 (not yet supported)
- 'limit? int? - The maximum number of groups to return, largest first. Must be positive and requires
groupBy; omitted falls back to the server default (100 groups)
- 'where? WhereFilter - Filter search results using a where filter
- groupBy? string - The property to group by, as a bare property name. Each distinct value of the property forms one group (an object whose property holds several values counts toward each of them). Omitted or empty aggregates over all matching objects without grouping
- tenant? string - The tenant to aggregate in a multi-tenant collection
- returnMetrics? string[] - The aggregation metrics to return. Phase 1 supports only
count(the number of matching objects, per group whengroupByis set); omitted or empty is equivalent to["count"]. The property-scopedproperty:statisticgrammar (e.g.price:mean) is reserved and returns 422 (not yet supported)
weaviate: AggregateResponse
The result of an aggregation. An ungrouped aggregation returns the flat form (count plus tookMs); a grouped aggregation returns groups plus tookMs. Exactly one of count/groups is present, except that a grouped aggregation which produced no groups (nothing matched, or no matching object carries the property) omits groups entirely
Fields
- count? int? - The number of matching objects. Present only for ungrouped aggregations
- groups? AggregateGroup[] - The groups, ordered by descending count. Present only for grouped aggregations
- tookMs int - Server-side processing time in milliseconds
weaviate: Alias
Represents the mapping between an alias name and a collection. An alias provides an alternative name for accessing a collection
Fields
- alias? string - The unique name of the alias that serves as an alternative identifier for the collection
- 'class? string - The name of the collection (class) to which this alias is mapped
weaviate: AliasResponse
Response object containing a list of alias mappings
Fields
- aliases? Alias[] - Array of alias objects, each containing an alias-to-collection mapping
weaviate: AssignRoleToGroupRequest
Fields
- groupType? GroupType - If the group contains OIDC or database users
- roles? string[] - The roles to assign to the specified group
weaviate: AssignRoleToUserRequest
Fields
- roles? string[] - The roles that are assigned to the specified user
- userType? UserTypeInput - The type of the user.
dbusers are managed by Weaviate,oidcusers are managed by an external OIDC provider
weaviate: AsyncReplicationStatus
The status of the async replication
Fields
- startDiffTimeUnixMillis? decimal - The start time of the most recent iteration
- objectsPropagated? decimal - The number of objects propagated in the most recent iteration
- targetNode? string - The target node of the replication, if set, otherwise empty
weaviate: BackupConfig
Backup custom configuration
Fields
- path? string - Path or key within the bucket
- chunkSize? int - Deprecated, has no effect
- endpoint? string - Name of the endpoint, e.g. s3.amazonaws.com
- bucket? string - Name of the bucket, container, volume, etc
- compressionLevel "DefaultCompression"|"BestSpeed"|"BestCompression"|"ZstdDefaultCompression"|"ZstdBestSpeed"|"ZstdBestCompression"|"NoCompression" (default "DefaultCompression") - compression level used by compression algorithm
- cPUPercentage? int - Desired CPU core utilization ranging from 1%-80%
weaviate: BackupCreateRequest
Request body for creating a backup for a set of collections
Fields
- include? string[] - List of collections to include in the backup creation process. If not set, all collections are included. Cannot be used together with
exclude. Permits wildcards, e.g.*orprefix*. A list made only of wildcards that match no collection is rejected
- includeRoles? string[] - List of RBAC roles to include in the backup. Permits
*and?wildcards, e.g.*orprefix*. When omitted, the whole RBAC state is captured as part of the cluster snapshot; when set, the RBAC blob is filtered to the matching roles. An exact role name that does not exist is rejected; wildcards that match nothing back up no roles. Built-in roles are rejected and are never selected by wildcards (they are re-applied automatically on restore). No per-role permission check is applied
- exclude? string[] - List of collections to exclude from the backup creation process. If not set, all collections are included. Cannot be used together with
include. Permits wildcards, e.g.*orprefix*
- id? string - The ID of the backup (required). Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed
- includeUsers? string[] - List of dynamic DB users to include in the backup. Permits
*and?wildcards, e.g.*orprefix*. When omitted, the whole dynamic-user store is captured as part of the cluster snapshot and no per-user permission check is applied; when set, only matching users are captured. An exact user name that does not exist is rejected; wildcards that match nothing back up no users
- incrementalBaseBackupId string?(default "null") - 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
- config? BackupConfig - Backup custom configuration
weaviate: BackupCreateResponse
The definition of a backup create response body
Fields
- bucket? string - Name of the bucket, container, volume, etc
- path? string - Path within bucket of backup
- classes? string[] - The list of collections (classes) for which the backup creation process was started
- backend? string - Backup backend name e.g. filesystem, gcs, s3
- id? string - The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed
- 'error? string - error message if creation failed
- status "STARTED"|"TRANSFERRING"|"TRANSFERRED"|"FINALIZING"|"SUCCESS"|"FAILED"|"CANCELLING"|"CANCELED" (default "STARTED") - phase of backup creation process
weaviate: BackupCreateStatusResponse
The definition of a backup create metadata
Fields
- path? string - Destination path of backup files valid for the selected backend
- completedAt? string - Timestamp when the backup process completed (successfully or with failure)
- size? decimal - Size of the backup in Gibs
- startedAt? string - Timestamp when the backup process started
- backend? string - Backup backend name e.g. filesystem, gcs, s3
- id? string - The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed
- 'error? string - error message if creation failed
- incrementalBaseBackupId? string - The ID of the base backup this incremental backup was built on; empty if the backup is not incremental
- status "STARTED"|"TRANSFERRING"|"TRANSFERRED"|"FINALIZING"|"SUCCESS"|"FAILED"|"CANCELLING"|"CANCELED" (default "STARTED") - phase of backup creation process
weaviate: BackupListResponseInner
Fields
- completedAt? string - Timestamp when the backup process completed (successfully or with failure)
- size? decimal - Size of the backup in Gibs
- classes? string[] - The list of collections (classes) for which the backup process was started
- startedAt? string - Timestamp when the backup process started
- id? string - The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed
- incrementalBaseBackupId? string - The ID of the base backup this incremental backup was built on; empty if the backup is not incremental
- status? "STARTED"|"TRANSFERRING"|"TRANSFERRED"|"FINALIZING"|"SUCCESS"|"FAILED"|"CANCELLING"|"CANCELED" - Status of backup process
weaviate: BackupRestoreRequest
Request body for restoring a backup for a set of collections (classes)
Fields
- include? string[] - List of collections (classes) to include in the backup restoration process. Permits wildcards, e.g.
*orprefix*. A list made only of wildcards that match no collection in the backup is rejected
- exclude? string[] - List of collections (classes) to exclude from the backup restoration process
- nodeMapping? record { string... } - Allows overriding the node names stored in the backup with different ones. Useful when restoring backups to a different environment
- config? RestoreConfig - Backup custom configuration
- overwriteAlias? boolean - Allows ovewriting the collection alias if there is a conflict
weaviate: BackupRestoreResponse
The definition of a backup restore response body
Fields
- path? string - Destination path of backup files valid for the selected backend
- classes? string[] - The list of collections (classes) for which the backup restoration process was started
- backend? string - Backup backend name e.g. filesystem, gcs, s3
- id? string - The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed
- 'error? string - Error message if backup restoration failed
- status "STARTED"|"TRANSFERRING"|"TRANSFERRED"|"FINALIZING"|"SUCCESS"|"FAILED"|"CANCELLING"|"CANCELED" (default "STARTED") - Phase of backup restoration process
weaviate: BackupRestoreStatusResponse
The definition of a backup restore metadata
Fields
- path? string - Destination path of backup files valid for the selected backup backend, contains bucket and path
- backend? string - Backup backend name e.g. filesystem, gcs, s3
- id? string - The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed
- 'error? string - Error message if backup restoration failed
- status "STARTED"|"TRANSFERRING"|"TRANSFERRED"|"FINALIZING"|"SUCCESS"|"FAILED"|"CANCELLING"|"CANCELED" (default "STARTED") - Phase of backup restoration process
weaviate: BatchDelete
Fields
- output string(default "minimal") - Controls the verbosity of the output, possible values are:
minimal,verbose. Defaults tominimal
- dryRun boolean(default false) - If true, the call reports what the filter matches and deletes nothing.
Depending on the configured verbosity, you will either receive a count of matched objects, or a list of IDs. With a positive
QUERY_MAXIMUM_RESULTSthe count stops one above it, and the list holds at mostQUERY_MAXIMUM_RESULTSIDs. Repeating the dry run reports the same count; for an exact total use an aggregate count, which resolves no objects
- 'match? BatchDeleteMatch - Outlines how to find the objects to be deleted
- deletionTimeUnixMilli? int? - Timestamp of deletion in milliseconds since epoch UTC
weaviate: BatchDeleteMatch
Outlines how to find the objects to be deleted
Fields
- 'where? WhereFilter - Filter search results using a where filter
- 'class? string - The name of the collection (class) from which to delete objects
weaviate: BatchDeleteResponse
Delete Objects response
Fields
- output string(default "minimal") - Controls the verbosity of the output, possible values are:
minimal,verbose. Defaults tominimal
- dryRun boolean(default false) - If true, the call reported what the filter matched and deleted nothing. The list holds at most
QUERY_MAXIMUM_RESULTSIDs. Defaults to false
- 'match? BatchDeleteMatch - Outlines how to find the objects to be deleted
- deletionTimeUnixMilli? int? - Timestamp of deletion in milliseconds since epoch UTC
- results? BatchDeleteResponseResults -
weaviate: BatchDeleteResponseResults
Fields
- objects? BatchDeleteResponseResultsObjects[] - With output set to
minimalonly objects with error occurred will the be described. Successfully deleted objects would be omitted. Output set toverbosewill list all of the objects with their respective statuses
- 'limit? decimal - The most amount of objects that can be deleted in a single query, equals
QUERY_MAXIMUM_RESULTS
- failed? decimal - How many objects should have been deleted but could not be deleted
- matches? decimal - How many objects matched the filter. With a positive
limitthe count stops one abovelimit: at or belowlimitthis is the exact number of matching objects and every one of them was handled by this call, and abovelimitmore objects match than one call deletes, so call again. With alimitof 0 or below the count is exact and uncapped
- successful? decimal - How many objects were successfully deleted in this round
weaviate: BatchDeleteResponseResultsObjects
Results for this specific Object
Fields
- id? string - The UUID of the object
- errors? ErrorResponse - An error response returned by Weaviate endpoints
- status "SUCCESS"|"DRYRUN"|"FAILED" (default "SUCCESS") -
weaviate: BatchObjectsBody
Fields
- objects? WeaviateObject[] - Array of objects to be created
- fields? ("ALL"|"class"|"schema"|"id"|"creationTimeUnix")[] - Controls which fields are returned in the response for each object. Default is
ALL
weaviate: BatchReference
Fields
- 'from? string - 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/<uuid>/<className>/<propertyName>, where<className>and<propertyName>must represent the cross-reference property of the source class to be used
- to? string - Short-form URI to point to the cross-reference. Should be in the form of
weaviate://localhost/<uuid>for the example of a local cross-reference to an object
- tenant? string - Name of the reference tenant
weaviate: BatchReferenceResponse
Fields
- Fields Included from *BatchReference
- result? BatchReferenceResponse_result - Results for this specific reference
weaviate: BatchReferenceResponse_result
Results for this specific reference
Fields
- errors? ErrorResponse - An error response returned by Weaviate endpoints
- status "SUCCESS"|"FAILED" (default "SUCCESS") -
weaviate: BatchStats
The summary of a nodes batch queue congestion status
Fields
- queueLength? decimal? - How many objects are currently in the batch queue
- ratePerSecond? decimal - How many objects are approximately processed from the batch queue per second
weaviate: BM25Config
Tuning parameters for the BM25 algorithm
Fields
- b? float - Calibrates term-weight scaling based on the document length (default: 0.75)
- k1? float - Calibrates term-weight scaling based on the term frequency within a document (default: 1.2)
weaviate: CancelBackupQueries
Represents the Queries record for the operation: cancelBackup
Fields
- bucket? string - Optional: Specifies the bucket, container, or volume name if required by the backend
- path? string - Optional: Specifies the path within the bucket/container/volume if the backup is not at the root
weaviate: CancelBackupRestoreQueries
Represents the Queries record for the operation: cancelBackupRestore
Fields
- bucket? string - Optional: Specifies the bucket, container, or volume name if required by the backend
- path? string - Optional: Specifies the path within the bucket/container/volume if the backup is not at the root
weaviate: CheckCollectionObjectExistsQueries
Represents the Queries record for the operation: checkCollectionObjectExists
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
- tenant? string - Specifies the tenant in a request targeting a multi-tenant collection (class)
weaviate: CheckTenantExistsHeaders
Represents the Headers record for the operation: checkTenantExists
Fields
- consistency boolean(default true) - If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true
weaviate: Classification
Manage classifications, trigger them and view status of past classifications
Fields
- settings? record {} - Classification-type specific settings
- meta? ClassificationMeta - Additional information to a specific classification
- basedOnProperties? string[] - Base the text-based classification on these fields (of type text)
- id? string - ID to uniquely identify this classification run
- filters? ClassificationFilters -
- 'type? string - Which algorithm to use for classifications
- 'error string(default "") - Error message if status == failed
- 'class? string - The name of the collection (class) which is used in this classification
- classifyProperties? string[] - Which ref-property to set as part of the classification
- status? "running"|"completed"|"failed" - Status of this classification
weaviate: ClassificationFilters
Fields
- sourceWhere? WhereFilter - Filter search results using a where filter
- trainingSetWhere? WhereFilter - Filter search results using a where filter
- targetWhere? WhereFilter - Filter search results using a where filter
weaviate: ClassificationMeta
Additional information to a specific classification
Fields
- countSucceeded? int - Number of objects successfully classified
- countFailed? int - Number of objects which could not be classified - see error message for details
- count? int - Number of objects which were taken into consideration for classification
- started? string - Time when this classification was started
- completed? string - Time when this classification finished
weaviate: ClusterStatisticsResponse
The cluster statistics of all of the Weaviate nodes
Fields
- synchronized? boolean -
- statistics? Statistics[] -
weaviate: Collection
Fields
- vectorizer? string - 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 astext2vec-weaviate. If left empty, it will use the globally configured default (DEFAULT_VECTORIZER_MODULE) which can itself either benoneor a specific module
- invertedIndexConfig? InvertedIndexConfig - Configure the inverted index built into Weaviate. See Reference: Inverted index for details
- multiTenancyConfig? MultiTenancyConfig - Configuration related to multi-tenancy within a collection (class)
- replicationConfig? ReplicationConfig - Configure how replication is executed in a cluster
- description? string - Description of the collection for metadata purposes
- shardingConfig? record {} - Manage how the index should be sharded and distributed in the cluster
- moduleConfig? record {} - Configuration specific to modules in a collection context
- vectorIndexConfig? record {} - Vector-index config, that is specific to the type of index selected in vectorIndexType
- objectTtlConfig? ObjectTtlConfig - Configuration of objects' time-to-live
- vectorIndexType? string - Name of the vector index type to use for the collection (e.g.
hnsworflat)
- vectorConfig? record { VectorConfig... } - Configure named vectors. Either use this field or
vectorizer,vectorIndexType, andvectorIndexConfigfields. Available fromv1.24.0
- 'class? string - Name of the collection (formerly 'class') (required). Multiple words should be concatenated in CamelCase, e.g.
ArticleAuthor
- properties? Property[] - Define properties of the collection
weaviate: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
weaviate: CreateObjectQueries
Represents the Queries record for the operation: createObject
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
weaviate: CreateObjectsBatchQueries
Represents the Queries record for the operation: createObjectsBatch
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
weaviate: CreateReferencesBatchQueries
Represents the Queries record for the operation: createReferencesBatch
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
weaviate: CreateUserRequest
Fields
- 'import boolean(default false) - EXPERIMENTAL, DONT USE. THIS WILL BE REMOVED AGAIN. - import api key from static user
- createTime? string - EXPERIMENTAL, DONT USE. THIS WILL BE REMOVED AGAIN. - set the given time as creation time
weaviate: DBUserCredential
A single database user's exportable API-key credential. Carries the argon2id key hash for strong-key users; for users whose key cannot be migrated (imported/weak, revoked, or missing a hash) secureHash is null and status names the reason
Fields
- secureHash? string? - The argon2id PHC hash of the user's API key. Null when the key cannot be migrated (see status)
- createdAt? string - Date and time in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
- userIdentifier? string - The random identifier embedded in the user's API key, used to resolve the key hash. Exactly 16 characters for an importable record; empty when the export reports a user whose key is not carried
- namespace? string - The namespace the user was bound to on the source. Informational on export; import binds the user to the request's target namespace
- active? boolean - Whether the user is active. A deactivated (not revoked) user is carried with active=false and reproduced on import
- apiKeyFirstLetters? string - First 3 letters of the associated API key
- userId string - The name (ID) of the user, without any namespace prefix
- status? "exported"|"imported_key"|"revoked" - Export classification. Only 'exported' carries a usable secureHash; the others report why the user was not carried
weaviate: DBUserInfo
Fields
- createdAt? string? - Date and time in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
- lastUsedAt? string? - Date and time in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
- roles string[] - The roles associated with the user
- dbUserType "db_user"|"db_env_user" - Type of the returned user
- namespace? string - The namespace this user is bound to. Only populated for callers with global-operator privileges; omitted otherwise
- active boolean - Activity status of the returned user
- apiKeyFirstLetters? string? - First 3 letters of the associated API key
- userId string - The name (ID) of the user
weaviate: DeactivateUserRequest
Fields
- revokeKey boolean(default false) - Whether the API key should be revoked when deactivating the user
weaviate: DeleteCollectionObjectQueries
Represents the Queries record for the operation: deleteCollectionObject
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
- tenant? string - Specifies the tenant in a request targeting a multi-tenant collection (class)
weaviate: DeleteCollectionObjectReferenceQueries
Represents the Queries record for the operation: deleteCollectionObjectReference
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
- tenant? string - Specifies the tenant in a request targeting a multi-tenant collection (class)
weaviate: DeleteObjectQueries
Represents the Queries record for the operation: deleteObject
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
- tenant? string - Specifies the tenant in a request targeting a multi-tenant collection (class)
weaviate: DeleteObjectReferenceQueries
Represents the Queries record for the operation: deleteObjectReference
Fields
- tenant? string - Specifies the tenant in a request targeting a multi-tenant collection (class)
weaviate: DeleteObjectsBatchQueries
Represents the Queries record for the operation: deleteObjectsBatch
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
- tenant? string - Specifies the tenant in a request targeting a multi-tenant collection (class)
weaviate: Deprecation
Fields
- msg? string - What this deprecation is about
- mitigation? string - User-required object to not be affected by the (planned) removal
- removedTime? string? - If the feature has already been removed, it was removed at this timestamp
- sinceVersion? string - The deprecation was introduced in this version
- removedIn? string? - If the feature has already been removed, it was removed in this version
- sinceTime? string - The deprecation was introduced at this timestamp
- locations? string[] - The locations within the specified API affected by this deprecation
- id? string - The id that uniquely identifies this particular deprecation (mostly used internally)
- plannedRemovalVersion? string - A best-effort guess of which upcoming version will remove the feature entirely
- apiType? string - Describes which API is affected, usually one of: REST, GraphQL and gRPC
- status? string - Whether the problematic API functionality is deprecated (planned to be removed) or already removed
weaviate: DistributedTask
Distributed task metadata
Fields
- payload? record {} - The payload of the task
- startedAt? string - The time when the task was created
- finishedNodes? string[] - The nodes that finished the task
- id? string - The ID of the task
- units? DistributedTaskUnit[] - Units of the task. Only present for tasks that use unit tracking
- 'error? string - The high level reason why the task failed
- version? int - The version of the task
- status? string - The status of the task
- finishedAt? string? - The time when the task reached a terminal status. Absent while the task is still running
weaviate: DistributedTasks
Active distributed tasks by namespace
Fields
- DistributedTask[]... - Rest field
weaviate: DistributedTaskUnit
A unit of a distributed task
Fields
- progress? float - The progress of the unit (0.0 to 1.0)
- id? string - The ID of the unit
- 'error? string - The error message if the unit failed
- nodeId? string - The node that owns this unit
- status? string - The status of the unit
- updatedAt? string? - The time when the unit was last updated, including its transition to a terminal status. Absent for a unit that has not started yet
- finishedAt? string? - The time when the unit reached a terminal status. Absent while the unit is still running
weaviate: EndpointListResponse
Fields
- links? Link[] -
weaviate: ErrorResponse
An error response returned by Weaviate endpoints
Fields
- 'error? ErrorResponseError[] -
weaviate: ErrorResponseError
Fields
- message? string -
weaviate: ExportCreateRequest
Request to create a new export operation
Fields
- include? string[] - List of collection names to include in the export. Cannot be used with 'exclude'
- exclude? string[] - List of collection names to exclude from the export. Cannot be used with 'include'
- id string - Unique identifier for this export. Must be URL-safe
- fileFormat "parquet" - Output file format for the export
weaviate: ExportCreateResponse
Response from creating an export operation
Fields
- path? string - Full path where the export is being written
- classes? string[] - List of collections being exported
- startedAt? string - When the export started
- backend? string - The backend storage system used
- id? string - Unique identifier for this export
- status? "STARTED" - Current status of the export
weaviate: ExportStatusResponse
Current status of an export operation
Fields
- path? string - Full path where the export is stored
- completedAt? string - When the export completed (successfully, with failure, or was canceled)
- classes? string[] - List of collections in this export
- shardStatus? record { record { ShardProgress... }... } - Per-shard progress: className -> shardName -> status
- startedAt? string - When the export started
- backend? string - The backend storage system used
- id? string - Unique identifier for this export
- 'error? string - Error message if export failed
- tookInMs? int - Duration of the export in milliseconds
- status? "STARTED"|"TRANSFERRING"|"SUCCESS"|"FAILED"|"CANCELED" - Current status of the export
weaviate: GeoCoordinates
Fields
- latitude? float? - The latitude of the point on earth in decimal form
- longitude? float? - The longitude of the point on earth in decimal form
weaviate: GetBackupRestoreStatusQueries
Represents the Queries record for the operation: getBackupRestoreStatus
Fields
- bucket? string - Optional: Specifies the bucket, container, or volume name if required by the backend
- path? string - Optional: Specifies the path within the bucket
weaviate: GetBackupStatusQueries
Represents the Queries record for the operation: getBackupStatus
Fields
- bucket? string - Optional: Specifies the bucket, container, or volume name if required by the backend
- path? string - Optional: Specifies the path within the bucket/container/volume if the backup is not at the root
weaviate: GetCollectionHeaders
Represents the Headers record for the operation: getCollection
Fields
- consistency boolean(default true) - If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true
weaviate: GetCollectionObjectQueries
Represents the Queries record for the operation: getCollectionObject
Fields
- include? string - Include additional information, such as classification information. Allowed values include:
classification,vectorandinterpretation
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
- nodeName? string - The target node which should fulfill the request
- tenant? string - Specifies the tenant in a request targeting a multi-tenant collection (class)
weaviate: GetCollectionShardingStateQueries
Represents the Queries record for the operation: getCollectionShardingState
Fields
- collection? string - The collection name to get the sharding state for
- shard? string - The shard to get the sharding state for
weaviate: GetGroupRolesQueries
Represents the Queries record for the operation: getGroupRoles
Fields
- includeFullRoles boolean(default false) - If true, the response will include the full role definitions with all associated permissions. If false, only role names are returned
weaviate: GetObjectQueries
Represents the Queries record for the operation: getObject
Fields
- include? string - Include additional information, such as classification information. Allowed values include:
classification,vectorandinterpretation
weaviate: GetReplicationQueries
Represents the Queries record for the operation: getReplication
Fields
- includeHistory? boolean - Whether to include the history of the replication operation
weaviate: GetReplicationScalePlanQueries
Represents the Queries record for the operation: getReplicationScalePlan
Fields
- replicationFactor int - The desired replication factor to scale to. Must be a positive integer greater than zero
- collection string - The collection name to get the scaling plan for
weaviate: GetTenantHeaders
Represents the Headers record for the operation: getTenant
Fields
- consistency boolean(default true) - If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true
weaviate: GetUserQueries
Represents the Queries record for the operation: getUser
Fields
- includeLastUsedTime boolean(default false) - Whether to include the last used time of the given user
weaviate: GetUserRolesByTypeQueries
Represents the Queries record for the operation: getUserRolesByType
Fields
- includeFullRoles boolean(default false) - Whether to include detailed role information like its assigned permissions
weaviate: GraphQLError
An error response caused by a GraphQL query
Fields
- path? string[] -
- locations? GraphQLErrorLocations[] -
- message? string -
weaviate: GraphQLErrorLocations
Fields
- line? int -
- column? int -
weaviate: GraphQLQuery
GraphQL query based on: http://facebook.github.io/graphql/
Fields
- variables? record {} - Additional variables for the query
- query? string - Query based on GraphQL syntax
- operationName? string - The name of the operation if multiple exist in the query
weaviate: GraphQLResponse
GraphQL based response: http://facebook.github.io/graphql/
Fields
- data? record { JsonObject... } - GraphQL data object
- errors? GraphQLError[] - Array with errors
weaviate: IndexStatus
Fields
- targetAlgorithm? "wand"|"blockmax" - BM25 algorithm this searchable index is being rebuilt onto. Populated only while an in-flight rebuild is changing the algorithm; mirrors
targetTokenizationfor the change-tokenization verb. Today the only supported transition is wand -> blockmax
- progress? float -
- targetTokenization? string -
- 'type? "filterable"|"searchable"|"rangeFilters" - Canonical inverted-index type. Always one of
filterable,searchable,rangeFilters— never therangeablewrite-path alias
- tokenization? string -
- taskId? string - ID of the reindex task driving this index entry. Present on every task-driven entry (
pending,indexing,failed,cancelled); absent on a plainreadyentry. A coupled searchable+filterable tokenization migration reports the sametaskIdon both affected entries
- status? "ready"|"indexing"|"pending"|"failed"|"cancelled" -
- algorithm? "wand"|"blockmax" - BM25 algorithm currently backing this searchable index. 'wand' is the legacy map-based bucket strategy; 'blockmax' is the Block Max WAND inverted strategy. Only populated for
type=searchableentries. Not populated for filterable or rangeable indexes
weaviate: IndexStatusResponse
Fields
- collection? string -
- properties? PropertyIndexStatus[] -
weaviate: IndexUpdateResponse
Fields
- taskId? string -
- status? string - What the server did.
STARTED: a reindex task was submitted andtaskIdnames it.CANCELLED: a cancel stopped the in-flight task named bytaskId.NO_OP: a cancel found nothing in flight, andtaskIdis absent. Not a closed set: a newer server may answer with a value this client does not know, so report an unrecognized status rather than rejecting the response
weaviate: IndexUpsertRequest
Desired index configuration for PUT /v1/schema/{className}/properties/{propertyName}/index/{indexType}. The server diffs the body against the current state and either creates the index, migrates its configuration, or returns a NO_OP. Only fields relevant to the target index type are honored: tokenization applies to searchable/filterable, algorithm applies to searchable. rangeFilters takes no config fields. An empty body {} is valid and means "ensure the index exists with its current/default config". At most one configuration change may be requested per call (a body implying both a tokenization and an algorithm change is rejected)
Fields
- tokenization? string - Target tokenization for a
searchableorfilterableindex. Required when creating asearchableindex; optional otherwise (omitted = keep the current value). Onfilterablecreation it must be omitted or equal the property's current tokenization
- algorithm? string - Target BM25 algorithm for a
searchableindex. Onlyblockmaxis a valid target (input aliasesblock-max,block_max,blockmaxwand,bmware accepted case-insensitively). From WAND this triggers the Map → BlockMax migration; on an already-blockmaxindex it is a NO_OP.wandis rejected (deprecated); downgrade is intentionally not supported
weaviate: InvertedIndexConfig
Configure the inverted index built into Weaviate. See Reference: Inverted index for details
Fields
- bm25? BM25Config - Tuning parameters for the BM25 algorithm
- indexNullState? boolean - Index each object with the null state (default:
false)
- tokenizerUserDict? TokenizerUserDictConfig[] - User-defined dictionary for tokenization
- usingBlockMaxWAND? boolean - Using BlockMax WAND for query execution (default:
false, will betruefor new collections created after 1.30)
- indexPropertyLength? boolean - Index length of properties (default:
false)
- stopwordPresets? record { string[]... } - 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. Preset names must not be empty or whitespace-only; each list must contain at least one word; individual words must not be empty or whitespace-only
- cleanupIntervalSeconds? decimal - Asynchronous index clean up happens every n seconds (default: 60)
- stopwords? StopwordConfig - Fine-grained control over stopword list usage
- indexTimestamps? boolean - Index each object by its internal timestamps (default:
false)
weaviate: JsonObject
JSON object value
weaviate: Link
Fields
- rel? string - Relationship if both resources are related, e.g. 'next', 'previous', 'parent', etc
- name? string - Human readable name of the resource group
- documentationHref? string - Weaviate documentation about this resource group
- href? string - Target of the link
weaviate: ListAliasesQueries
Represents the Queries record for the operation: listAliases
Fields
- 'class? string - Optional filter to retrieve aliases for a specific collection (class) only. If not provided, returns all aliases
weaviate: ListBackupsQueries
Represents the Queries record for the operation: listBackups
Fields
- 'order "asc"|"desc" (default "desc") - Order of returned list of backups based on creation time. (asc or desc)
weaviate: ListCollectionNodesQueries
Represents the Queries record for the operation: listCollectionNodes
Fields
- output string(default "minimal") - Controls the verbosity of the output, possible values are:
minimal,verbose. Defaults tominimal
- shardName? string -
weaviate: ListCollectionShardsQueries
Represents the Queries record for the operation: listCollectionShards
Fields
- tenant? string - The name of the tenant for which to retrieve shard statuses (only applicable for multi-tenant collections)
weaviate: ListCollectionsHeaders
Represents the Headers record for the operation: listCollections
Fields
- consistency boolean(default true) - If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true
weaviate: ListNodesQueries
Represents the Queries record for the operation: listNodes
Fields
- output string(default "minimal") - Controls the verbosity of the output, possible values are:
minimal,verbose. Defaults tominimal
weaviate: ListObjectsQueries
Represents the Queries record for the operation: listObjects
Fields
- include? string - Include additional information, such as classification information. Allowed values include:
classification,vectorandinterpretation
- offset int(default 0) - The starting index of the result window. Note
offsetwill retrieveoffset+limitresults and returnlimitresults from the object with indexoffsetonwards. Limited by the value ofQUERY_MAXIMUM_RESULTS. Should be used in conjunction withlimit. Cannot be used withafter
- 'limit? int - The maximum number of items to be returned per page. The default is 25 unless set otherwise as an environment variable
- after? string - 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 withlimit. Noteaftercannot be used withoffsetorsort. For a null value similar to offset=0, set an empty string in the request, i.e.after=orafter
- sort? string - Name(s) of the property to sort by - e.g.
city, orcountry,city
- 'class? string - The collection from which to query objects.
Note that if the collection name (
class) is not provided, the response will not include any objects
- tenant? string - Specifies the tenant in a request targeting a multi-tenant collection (class)
- 'order? string - Order parameter to tell how to order (asc or desc) data within given field. Should be used in conjunction with
sortparameter. If providing multiplesortvalues, provide multipleordervalues in corresponding order, e.g.:sort=author_name,title&order=desc,asc
weaviate: ListReplicationsQueries
Represents the Queries record for the operation: listReplications
Fields
- includeHistory? boolean - Whether to include the history of the replication operation
- collection? string - The name of the collection to get details for
- shard? string - The shard to get details for
- targetNode? string - The name of the target node to get details for
weaviate: ListTenantsHeaders
Represents the Headers record for the operation: listTenants
Fields
- consistency boolean(default true) - If true, the request is proxied to the cluster leader to ensure strong schema consistency. Default is true
weaviate: ListUsersQueries
Represents the Queries record for the operation: listUsers
Fields
- includeLastUsedTime boolean(default false) - Whether to include the last time the users were utilized
weaviate: Meta
Contains meta information of the current Weaviate instance
Fields
- hostname? string - The url of the host
- grpcMaxMessageSize? int - Max message size for GRPC connection in bytes
- version? string - The Weaviate server version
- modules? record {} - Module-specific meta information
weaviate: MultiTenancyConfig
Configuration related to multi-tenancy within a collection (class)
Fields
- autoTenantActivation? boolean - Existing tenants should (not) be turned HOT implicitly when they are accessed and in another activity status (default:
false)
- autoTenantCreation? boolean - Nonexistent tenants should (not) be created implicitly (default:
false)
- enabled? boolean - Whether or not multi-tenancy is enabled for this collection (class) (default:
false)
weaviate: Namespace
A cluster-level namespace used to group resources under a common administrative unit. Namespace names must contain only lowercase letters, digits, and hyphens, must start and end with a letter or digit, must be 3-36 characters long, and must not be a reserved name
Fields
- name? string - The unique name of the namespace
- state? "active"|"suspended"|"resuming"|"deleting" - Lifecycle state. "active" namespaces accept all operations. "suspended" namespaces reject new classes, aliases, users, roles, and role assignments, and their users can no longer authenticate; everything the namespace already owns is retained. "resuming" namespaces are on their way back to "active" and are still restricted the same way. "deleting" namespaces are being removed: new classes, aliases, and users can no longer be created in the namespace, and the namespace itself disappears once removal completes
- homeNode? string - The cluster node where this namespace's shards are placed. Set at create time and updatable later. Updating it only affects future placement decisions; existing live shards are not moved
weaviate: NamespaceCreateRequest
Optional body for namespace creation. When home_node is omitted, the cluster picks one automatically
Fields
- homeNode? string - Optional. Cluster node to place this namespace's shards on. Must be a current storage candidate. When omitted, the cluster picks one
weaviate: NamespaceUpdateRequest
Update payload for an existing namespace
Fields
- homeNode string - Cluster node to use for future placements in this namespace. Must be a current storage candidate. Existing live shards are not moved
weaviate: NestedProperty
Fields
- indexRangeFilters? boolean? -
- nestedProperties? NestedProperty[] - The properties of the nested object(s). Applies to object and object[] data types
- textAnalyzer? TextAnalyzerConfig - Text analysis options for a property. These settings are immutable after the property is created. Applies only to text and text[] data types that use an inverted index (searchable or filterable)
- indexSearchable? boolean? -
- dataType? string[] -
- name? string -
- description? string -
- indexFilterable? boolean? -
- tokenization? "word"|"lowercase"|"whitespace"|"field"|"trigram"|"gse"|"kagome_kr"|"kagome_ja"|"gse_ch" -
weaviate: NodeShardStatus
The definition of a node shard status response body
Fields
- loaded? boolean - The load status of the shard
- replicationFactor? int? - Minimum number of replicas for the shard
- objectCount? decimal - The number of objects in shard
- vectorIndexingStatus? string - The status of the vector indexing process
- numberOfReplicas? int? - Number of replicas for the shard
- name? string - The name of the shard
- vectorQueueLength? decimal - The length of the vector indexing queue
- compressed? boolean - The status of vector compression/quantization
- asyncReplicationStatus? AsyncReplicationStatus[] - The status of the async replication
- 'class? string - The name of shard's collection (class)
weaviate: NodesStatusResponse
The status of all of the Weaviate nodes
Fields
- nodes? NodeStatus[] -
weaviate: NodeStats
The summary of Weaviate's statistics
Fields
- objectCount? decimal - The total number of objects in DB
- shardCount? decimal - The count of Weaviate's shards. To see this value, set
outputtoverbose
weaviate: NodeStatus
The definition of a backup node status response body
Fields
- operationalMode? "ReadWrite"|"WriteOnly"|"ReadOnly"|"ScaleOut" - Which mode of operation the node is running in
- shards? NodeShardStatus[] - The list of the shards with it's statistics
- gitHash? string - The gitHash of Weaviate
- stats? NodeStats - The summary of Weaviate's statistics
- name? string - The name of the node
- batchStats? BatchStats - The summary of a nodes batch queue congestion status
- version? string - The version of Weaviate
- status "HEALTHY"|"UNHEALTHY"|"UNAVAILABLE"|"TIMEOUT" (default "HEALTHY") - Node's status
weaviate: ObjectsGetResponse
Fields
- Fields Included from *WeaviateObject
- vectors Vectors
- additional AdditionalProperties
- lastUpdateTimeUnix int
- vector C11yVector
- id string
- creationTimeUnix int
- class string
- vectorWeights VectorWeights
- properties PropertySchema
- tenant string
- anydata...
- Fields Included from *ObjectsGetResponseDeprecations
- deprecations Deprecation[]
- anydata...
- Fields Included from *ObjectsGetResponseResultWrapper
- result ObjectsGetResponseResult
- anydata...
weaviate: ObjectsGetResponseDeprecations
Fields
- deprecations? Deprecation[] -
weaviate: ObjectsGetResponseResult
Results for this specific object
Fields
- errors? ErrorResponse - An error response returned by Weaviate endpoints
- status "SUCCESS"|"FAILED" (default "SUCCESS") -
weaviate: ObjectsGetResponseResultWrapper
Fields
- result? ObjectsGetResponseResult - Results for this specific object
weaviate: ObjectsListResponse
List of objects
Fields
- totalResults? int - The total number of objects for the query. The number of items in a response may be smaller due to paging
- objects? WeaviateObject[] - The actual list of objects
- deprecations? Deprecation[] -
weaviate: ObjectTtlConfig
Configuration of objects' time-to-live
Fields
- deleteOn? string - Name of the property holding base time to compute object's expiration time (ttl = value of deleteOn property + defaultTtl). Can be set to
_creationTimeUnix,_lastUpdateTimeUnixor custom property ofdatedatatype
- filterExpiredObjects? boolean - Whether remove from resultset expired, but not yet deleted by background process objects (default:
false)
- defaultTtl? int - Interval (in seconds) to be added to
deleteOnvalue, denoting object's expiration time. Has to be positive fordeleteOnset to_creationTimeUnixor_lastUpdateTimeUnix, any for custom property (default:0)
- enabled? boolean - Whether or not object ttl is enabled for this collection (default:
false)
weaviate: OidcConfiguration
Fields
- clientId? string - The OAuth Client ID configured for Weaviate
- href? string - The OIDC issuer URL to redirect to for authentication
- scopes? string[] - The required OAuth scopes for authentication
weaviate: Permission
Permissions attached to a role
Fields
- tenants? PermissionTenants - Resources applicable for tenant actions
- replicate? PermissionReplicate - resources applicable for replicate actions
- nodes? PermissionNodes - Resources applicable for cluster actions
- aliases? PermissionAliases - Resource definition for alias-related actions and permissions. Used to specify which aliases and collections can be accessed or modified
- data? PermissionData - Resources applicable for data actions
- collections? PermissionCollections - Resources applicable for collection and/or tenant actions
- roles? PermissionRoles - Resources applicable for role actions
- groups? PermissionGroups - Resources applicable for group actions
- 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"|"manage_namespaces" - Allowed actions in weaviate
- users? PermissionUsers - Resources applicable for user actions
- backups? PermissionBackups - Resources applicable for backup actions
- namespaces? PermissionNamespaces - Resources applicable for namespace actions
weaviate: PermissionAliases
Resource definition for alias-related actions and permissions. Used to specify which aliases and collections can be accessed or modified
Fields
- alias string(default "*") - 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
- collection string(default "*") - 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
weaviate: PermissionBackups
Resources applicable for backup actions
Fields
- collection string(default "*") - 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
weaviate: PermissionCollections
Resources applicable for collection and/or tenant actions
Fields
- collection string(default "*") - 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
weaviate: PermissionData
Resources applicable for data actions
Fields
- collection string(default "*") - 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
- tenant string(default "*") - 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
- 'object string(default "*") - Deprecated: Object-level permissions are not supported. This field is ignored; the permission always applies to all objects. Kept for backward compatibility
weaviate: PermissionGroups
Resources applicable for group actions
Fields
- groupType? GroupType - If the group contains OIDC or database users
- group string(default "*") - 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
weaviate: PermissionNamespaces
Resources applicable for namespace actions
Fields
- namespace string(default "*") - A string that specifies which namespaces this permission applies to. Can be an exact namespace name or a regex pattern. The default value
*applies the permission to all namespaces
weaviate: PermissionNodes
Resources applicable for cluster actions
Fields
- collection string(default "*") - 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
- verbosity "verbose"|"minimal" (default "minimal") - Whether to allow (verbose) returning shards and stats data in the response
weaviate: PermissionReplicate
resources applicable for replicate actions
Fields
- collection string(default "*") - string or regex. if a specific collection name, if left empty it will be ALL or *
- shard string(default "*") - string or regex. if a specific shard name, if left empty it will be ALL or *
weaviate: PermissionRoles
Resources applicable for role actions
Fields
- role string(default "*") - 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
- scope "all"|"match" (default "match") - Set the scope for the manage role permission
weaviate: PermissionTenants
Resources applicable for tenant actions
Fields
- collection string(default "*") - 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
- tenant string(default "*") - 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
weaviate: PermissionUsers
Resources applicable for user actions
Fields
- users string(default "*") - 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
weaviate: Property
Fields
- nestedProperties? NestedProperty[] - The properties of the nested object(s). Applies to object and object[] data types
- textAnalyzer? TextAnalyzerConfig - Text analysis options for a property. These settings are immutable after the property is created. Applies only to text and text[] data types that use an inverted index (searchable or filterable)
- searchableBlockmax? boolean? - Internal RAFT-replicated per-property flag: true iff this property's searchable (BM25) bucket is on the blockmax (StrategyInverted) index. Stamped at migration cutover. Absent/null means "not stamped" and is resolved against the class-wide UsingBlockMaxWAND flag. Internal use; clients must not set this
- dataType? string[] - Data type of the property (required). If it starts with a capital (for example Person), may be a reference to another type
- description? string - Description of the property
- bucketGeneration? int - Internal RAFT-replicated counter bumped by semantic runtime-reindex migrations (e.g. change-tokenization, enable-filterable, enable-searchable). Used by the data path to resolve the property's inverted-index bucket name; a single RAFT commit flipping the schema flag AND bumping this counter atomically cuts the cluster from the old bucket to the new one. Defaults to 0. Internal use; clients should not set this
- indexFilterable? boolean? - Whether to include this property in the filterable, Roaring Bitmap index. If
false, this property cannot be used inwherefilters. Note: Unrelated to vectorization behavior
- tokenization? "word"|"lowercase"|"whitespace"|"field"|"trigram"|"gse"|"kagome_kr"|"kagome_ja"|"gse_ch" - Determines how a property is indexed. This setting applies to
textandtext[]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 thegsetokenizer, suitable for Chinese language text. Seegsedocs.kagome_ja: Uses theKagometokenizer with a Japanese (IPA) dictionary. Seekagomedocs.kagome_kr: Uses theKagometokenizer with a Korean dictionary. Seekagomedocs.
- indexRangeFilters? boolean? - 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
- moduleConfig? record {} - Configuration specific to modules in a collection context
- indexSearchable? boolean? - 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
- name? string - The name of the property (required). Multiple words should be concatenated in camelCase, e.g.
nameOfAuthor
- disableDuplicatedReferences boolean?(default true) - 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
- indexInverted? boolean? - (Deprecated). Whether to include this property in the inverted index. If
false, this property cannot be used inwherefilters,bm25orhybridsearch. Unrelated to vectorization behavior (deprecated as of v1.19; use indexFilterable or/and indexSearchable instead)
weaviate: PropertyIndexStatus
Fields
- indexes? IndexStatus[] -
- dataType? string -
- name? string -
- description? string -
weaviate: PropertySchema
Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection
weaviate: PropertyTokenizeRequest
Request body for the property-specific tokenize endpoint
Fields
- text string - The text to tokenize using the property's configured tokenization
weaviate: RaftStatistics
The definition of Raft statistics
Fields
- latestConfiguration? record {} - Weaviate Raft nodes
- lastLogIndex? string -
- latestConfigurationIndex? string -
- protocolVersionMin? string -
- lastContact? string -
- protocolVersionMax? string -
- lastSnapshotTerm? string -
- lastLogTerm? string -
- lastSnapshotIndex? string -
- snapshotVersionMin? string -
- snapshotVersionMax? string -
- numPeers? string -
- protocolVersion? string -
- term? string -
- state? string -
- fsmPending? string -
- appliedIndex? string -
- commitIndex? string -
weaviate: RebuildPropertyIndexQueries
Represents the Queries record for the operation: rebuildPropertyIndex
Fields
- tenants? string[] - Tenant names to target. Allowed for all index types on multi-tenant collections (rebuilds are format-only). Omit to target all tenants
weaviate: ReferenceMetaClassification
This meta field contains additional info about the classified reference property
Fields
- closestLosingDistance? decimal? - 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
- overallCount? decimal - overall neighbors checked as part of the classification. In most cases this will equal k, but could be lower than k - for example if not enough data was present
- winningCount? decimal - size of the winning group, a number between 1..k
- meanLosingDistance? decimal? - Mean distance of all neighbors from the losing group. Optional. If k equals the size of the winning group, there is no losing group
- closestWinningDistance? decimal - Closest distance of a neighbor from the winning group
- losingDistance? decimal? - deprecated - do not use, to be removed in 0.23.0
- losingCount? decimal - size of the losing group, can be 0 if the winning group size equals k
- winningDistance? decimal - deprecated - do not use, to be removed in 0.23.0
- closestOverallDistance? decimal - The lowest distance of any neighbor, regardless of whether they were in the winning or losing group
- meanWinningDistance? decimal - Mean distance of all neighbors from the winning group
weaviate: RemoveRolePermissionsRequest
Fields
- permissions Permission[] - Permissions to remove from the role
weaviate: ReplaceCollectionObjectQueries
Represents the Queries record for the operation: replaceCollectionObject
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
weaviate: ReplaceCollectionObjectReferencesQueries
Represents the Queries record for the operation: replaceCollectionObjectReferences
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
- tenant? string - Specifies the tenant in a request targeting a multi-tenant collection (class)
weaviate: ReplaceObjectQueries
Represents the Queries record for the operation: replaceObject
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
weaviate: ReplaceObjectReferencesQueries
Represents the Queries record for the operation: replaceObjectReferences
Fields
- tenant? string - Specifies the tenant in a request targeting a multi-tenant collection (class)
weaviate: ReplicationAsyncConfig
Configuration for asynchronous replication
Fields
- diffBatchSize? int? - Maximum number of object keys included in a single diff batch
- diffPerNodeTimeout? int? - Timeout in seconds for computing a diff against a single node
- propagationDelay? int? - Delay in milliseconds before newly added or updated objects are propagated
- frequencyWhilePropagating? int? - Frequency in milliseconds at which async replication runs while propagation is active
- loggingFrequency? int? - Interval in seconds at which async replication logs its status
- hashtreeHeight? int? - Height of the hashtree used for diffing
- propagationBatchSize? int? - Number of objects to include in a single propagation batch
- prePropagationTimeout? int? - Overall timeout in seconds for the pre-propagation phase
- propagationTimeout? int? - Timeout in seconds for propagating batch of changes to a node
- propagationLimit? int? - Maximum number of objects to propagate in a single async replication run
- frequency? int? - Base frequency in milliseconds at which async replication runs diff calculations
- propagationConcurrency? int? - Maximum number of concurrent propagation workers
weaviate: ReplicationConfig
Configure how replication is executed in a cluster
Fields
- asyncConfig? ReplicationAsyncConfig - Configuration for asynchronous replication
- deletionStrategy? "NoAutomatedResolution"|"DeleteOnConflict"|"TimeBasedResolution" - Conflict resolution strategy for deleted objects
- factor? int - Number of times a collection (class) is replicated (default: 1)
weaviate: ReplicationReplicateDetailsReplicaResponse
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
Fields
- uncancelable? boolean - Whether the replica operation can't be cancelled
- statusHistory? ReplicationReplicateDetailsReplicaStatus[] - An array detailing the historical sequence of statuses the replication operation has transitioned through, if requested and available
- sourceNode string - The identifier of the node from which the replica is being moved or copied (the source node)
- whenStartedUnixMs? int - 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
- id string - The unique identifier (ID) of this specific replication operation
- shard string - The name of the shard involved in this replication operation
- collection string - The name of the collection to which the shard being replicated belongs
- 'type "COPY"|"MOVE" - Indicates whether the operation is a
COPY(source replica remains) or aMOVE(source replica is removed after successful transfer)
- targetNode string - The identifier of the node to which the replica is being moved or copied (the target node)
- scheduledForCancel? boolean - Whether the replica operation is scheduled for cancellation
- scheduledForDelete? boolean - Whether the replica operation is scheduled for deletion
- status ReplicationReplicateDetailsReplicaStatus - Represents the current or historical status of a shard replica involved in a replication operation, including its operational state and any associated errors
weaviate: ReplicationReplicateDetailsReplicaStatus
Represents the current or historical status of a shard replica involved in a replication operation, including its operational state and any associated errors
Fields
- whenStartedUnixMs? int - 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
- state? "REGISTERED"|"HYDRATING"|"FINALIZING"|"INTEGRATING"|"DEHYDRATING"|"READY"|"CANCELLED" - The current operational state of the replica during the replication process
- errors? ReplicationReplicateDetailsReplicaStatusError[] - A list of error messages encountered by this replica during the replication operation, if any
weaviate: ReplicationReplicateDetailsReplicaStatusError
Represents an error encountered during a replication operation, including its timestamp and a human-readable message
Fields
- whenErroredUnixMs? int - The unix timestamp in ms when the error occurred. This is an approximate time and so should not be used for precise timing
- message? string - A human-readable message describing the error
weaviate: ReplicationReplicateForceDeleteRequest
Specifies the parameters available when force deleting replication operations
Fields
- node? string - The name of the target node where the replication operations are registered
- dryRun boolean(default false) - If true, the operation will not actually delete anything but will return the expected outcome of the deletion
- id? string - The unique identifier (ID) of the replication operation to be forcefully deleted
- collection? string - The name of the collection to which the shard being replicated belongs
- shard? string - The identifier of the shard involved in the replication operations
weaviate: ReplicationReplicateForceDeleteResponse
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
Fields
- deleted? string[] - The unique identifiers (IDs) of the replication operations that were forcefully deleted
- dryRun? boolean - Indicates whether the operation was a dry run (true) or an actual deletion (false)
weaviate: ReplicationReplicateReplicaRequest
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
Fields
- sourceNode string - The name of the Weaviate node currently hosting the shard replica that needs to be moved or copied
- collection string - The name of the collection to which the target shard belongs
- shard string - The name of the shard whose replica is to be moved or copied
- 'type "COPY"|"MOVE" (default "COPY") - Specifies the type of replication operation to perform.
COPYcreates a new replica on the target node while keeping the source replica.MOVEcreates a new replica on the target node and then removes the source replica upon successful completion. Defaults toCOPYif omitted
- targetNode string - The name of the Weaviate node where the new shard replica will be created as part of the movement or copy operation
weaviate: ReplicationReplicateReplicaResponse
Contains the unique identifier for a successfully initiated asynchronous replica movement operation. This ID can be used to track the progress of the operation
Fields
- id string - The unique identifier (ID) assigned to the registered replication operation
weaviate: ReplicationScaleApplyResponse
Response for the POST /replication/scale endpoint containing the list of initiated shard copy operation IDs
Fields
- operationIds string[] - List of shard copy operation IDs created during scaling
- planId string - The unique identifier of the replication scaling plan that generated these operations
- collection string - The name of the collection associated with this replication scaling plan
weaviate: ReplicationScalePlan
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
Fields
- shardScaleActions record { ReplicationScalePlanShardScaleActions... } - 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
- planId string - A unique identifier for this replication scaling plan, useful for tracking and auditing purposes
- collection string - The name of the collection to which this replication scaling plan applies
weaviate: ReplicationScalePlanShardScaleActions
Scaling actions for a single shard, including which nodes to remove and which to add. Nodes listed in 'removeNodes' cannot appear as targets in 'addNodes' for the same shard. If a source node is also marked for removal, it is treated as a move operation and can only appear once as a source node in that shard. A source node that is not being removed can appear multiple times as a source node for additions in that shard (copy operations)
Fields
- removeNodes? string[] - 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
- addNodes? record { string?... } - 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)
weaviate: ReplicationShardingState
Details the sharding layout for a specific collection, mapping each shard to its set of replicas across the cluster
Fields
- shards? ReplicationShardReplicas[] - An array detailing each shard within the collection and the nodes hosting its replicas
- collection? string - The name of the collection
weaviate: ReplicationShardingStateResponse
Provides the detailed sharding state for one or more collections, including the distribution of shards and their replicas across the cluster nodes
Fields
- shardingState? ReplicationShardingState - Details the sharding layout for a specific collection, mapping each shard to its set of replicas across the cluster
weaviate: ReplicationShardReplicas
Represents a shard and lists the nodes that currently host its replicas
Fields
- replicas? string[] -
- shard? string -
weaviate: RestoreConfig
Backup custom configuration
Fields
- path? string - Path within the bucket
- usersOptions "noRestore"|"all" (default "noRestore") - How users should be restored
- endpoint? string - name of the endpoint, e.g. s3.amazonaws.com
- bucket? string - Name of the bucket, container, volume, etc
- rolesOptions "noRestore"|"all" (default "noRestore") - How roles should be restored
- cPUPercentage? int - Desired CPU core utilization ranging from 1%-80%
weaviate: RevokeRoleFromGroupRequest
Fields
- groupType? GroupType - If the group contains OIDC or database users
- roles? string[] - The roles to revoke from the specified group
weaviate: RevokeRoleFromUserRequest
Fields
- roles? string[] - The roles to revoke from the specified user
- userType? UserTypeInput - The type of the user.
dbusers are managed by Weaviate,oidcusers are managed by an external OIDC provider
weaviate: Role
Fields
- permissions Permission[] -
- name string - The name (ID) of the role
weaviate: RoleGroupAssignment
Fields
- groupType GroupType - If the group contains OIDC or database users
- groupId? string -
weaviate: RoleUserAssignment
Fields
- userType UserTypeOutput - The type of the user.
db_userusers are created through theusersAPI,db_env_userusers are created through environment variables, andoidcusers are managed by an external OIDC provider
- userId? string -
weaviate: Schema
Definitions of semantic schemas (also see: https://github.com/weaviate/weaviate-semantic-schemas)
Fields
- classes? Collection[] - Semantic classes that are available
- name? string - Name of the schema
- maintainer? string - Email of the maintainer
weaviate: SearchBm25Request
Request body for the bm25 search endpoint. Performs a keyword (BM25F) search over the collection's searchable text properties and returns the best-scoring objects. Extends the shared search fields (SearchCommon) with the bm25-specific query and queryProperties
Fields
- Fields Included from *SearchCommon
- returnMetadata "distance"|"certainty"|"score"|"explainScore"|"creationTime"|"lastUpdateTime"[]
- offset int|()
- returnProperties string[]
- objectsPerGroup int|()
- singlePrompt string|()
- groupedTask string|()
- groupBy string|()
- rerank SearchRerank
- limit int|()
- autoLimit int|()
- numberOfGroups int|()
- where WhereFilter
- consistencyLevel "ONE"|"QUORUM"|"ALL"
- returnReferences SearchReferenceSelector[]
- tenant string
- anydata...
- query string - The keyword query to score objects against, as a plain string. Must not be empty
- queryProperties? string[] - The properties to keyword-search, each optionally weighted with a
^boostsuffix (e.g.title^2). Omitted or empty searches every searchable text property. A property without a searchable index is rejected with 422
weaviate: SearchCommon
Fields shared by every REST search request (near-text, bm25, hybrid, near-object). Unknown fields are ignored (platform parity with the other endpoints). Reserved fields are accepted by the schema but rejected by the server with 422 until the corresponding feature ships
Fields
- returnMetadata? ("distance"|"certainty"|"score"|"explainScore"|"creationTime"|"lastUpdateTime")[] - The retrieval metadata to return under each result's
metadatakey. The objectidis always returned as each result'sidfield. Omitted or empty returns nometadatablock
- offset? int? - The number of objects to skip before returning results. Used with
limitfor pagination
- returnProperties? string[] - The non-reference properties to return. Omitted returns all non-reference, non-blob properties; an empty array returns no properties. References are selected with
returnReferences
- objectsPerGroup? int? - Reserved for grouped search. Returns 422 (not yet supported)
- singlePrompt? string? - Reserved for per-object retrieval-augmented generation. Returns 422 (not yet supported)
- groupedTask? string? - Reserved for grouped retrieval-augmented generation. Returns 422 (not yet supported)
- groupBy? string? - Reserved for grouped search. Returns 422 (not yet supported)
- rerank? SearchRerank - Reserved for reranking. Returns 422 (not yet supported)
- 'limit? int? - The maximum number of objects to return. Omitted or
0falls back to the server default (QUERY_DEFAULTS_LIMIT); a value aboveQUERY_MAXIMUM_RESULTSis rejected
- autoLimit? int? - Cut results off at the first steep drop in score (autocut). The value is the number of score jumps to allow before cutting
- numberOfGroups? int? - Reserved for grouped search. Returns 422 (not yet supported)
- 'where? WhereFilter - Filter search results using a where filter
- consistencyLevel? "ONE"|"QUORUM"|"ALL" - The consistency level for the read
- returnReferences? SearchReferenceSelector[] - The cross-references to return under each result's
referenceskey. Each entry selects one reference property and what to return from the referenced objects. Omitted or empty returns no references
- tenant? string - The tenant to search in a multi-tenant collection
weaviate: SearchHybridRequest
Request body for the hybrid search endpoint. Combines a keyword (BM25F) search and a vector search over the same query string, fusing both rankings into one result list. Extends the shared search fields (SearchCommon) with the hybrid-specific query, alpha, fusionType, maxVectorDistance, queryProperties and targetVector
Fields
- Fields Included from *SearchCommon
- returnMetadata "distance"|"certainty"|"score"|"explainScore"|"creationTime"|"lastUpdateTime"[]
- offset int|()
- returnProperties string[]
- objectsPerGroup int|()
- singlePrompt string|()
- groupedTask string|()
- groupBy string|()
- rerank SearchRerank
- limit int|()
- autoLimit int|()
- numberOfGroups int|()
- where WhereFilter
- consistencyLevel "ONE"|"QUORUM"|"ALL"
- returnReferences SearchReferenceSelector[]
- tenant string
- anydata...
- fusionType? "ranked"|"relativeScore" - The algorithm that fuses the keyword and vector rankings:
ranked(reciprocal-rank fusion) orrelativeScore(normalized-score fusion). Omitted defaults torelativeScore
- query string - The query, as a plain string. It is scored with BM25F for the keyword part of the search and vectorized server-side for the vector part. Must not be empty
- alpha? decimal? - The weight of the vector part of the search, between 0 and 1.
0is a pure keyword search,1a pure vector search. Omitted defaults to0.75. With0the query is never vectorized, so a collection without a vectorizer module is searchable
- queryProperties? string[] - The properties the keyword part of the search scores against, each optionally weighted with a
^boostsuffix (e.g.title^2). Omitted or empty searches every searchable text property. A property without a searchable index is rejected with 422
- targetVector? string - The named vector to search. Required when the collection has more than one named vector
- maxVectorDistance? decimal? - The maximum vector distance of a match: objects farther than this from the query vector are excluded, from the keyword ranking too
weaviate: SearchNearObjectRequest
Request body for the near-object search endpoint. The stored vector of an existing object (the source object, referenced by id) anchors the search and the closest objects are returned. No query is vectorized — collections without a vectorizer module are fully searchable. Extends the shared search fields (SearchCommon) with the near-object-specific id, certainty, distance and targetVector
Fields
- Fields Included from *SearchCommon
- returnMetadata "distance"|"certainty"|"score"|"explainScore"|"creationTime"|"lastUpdateTime"[]
- offset int|()
- returnProperties string[]
- objectsPerGroup int|()
- singlePrompt string|()
- groupedTask string|()
- groupBy string|()
- rerank SearchRerank
- limit int|()
- autoLimit int|()
- numberOfGroups int|()
- where WhereFilter
- consistencyLevel "ONE"|"QUORUM"|"ALL"
- returnReferences SearchReferenceSelector[]
- tenant string
- anydata...
- distance? decimal? - Maximum vector distance of a match. Mutually exclusive with
certainty
- targetVector? string - The named vector to search (the source object's vector for this name anchors the search). Required when the collection has more than one named vector
- certainty? decimal? - Minimum normalized certainty of a match. Only for cosine-distance vector indexes. Mutually exclusive with
distance
- id string - The UUID of the source object whose stored vector anchors the search. A structurally invalid UUID is rejected at request validation; a well-formed UUID that matches no object in the collection is rejected with 400
weaviate: SearchNearTextRequest
Request body for the near-text search endpoint. The query is vectorized server-side by the collection's vectorizer module and the closest objects are returned. Extends the shared search fields (SearchCommon) with the near-text-specific query, certainty, distance and targetVector
Fields
- Fields Included from *SearchCommon
- returnMetadata "distance"|"certainty"|"score"|"explainScore"|"creationTime"|"lastUpdateTime"[]
- offset int|()
- returnProperties string[]
- objectsPerGroup int|()
- singlePrompt string|()
- groupedTask string|()
- groupBy string|()
- rerank SearchRerank
- limit int|()
- autoLimit int|()
- numberOfGroups int|()
- where WhereFilter
- consistencyLevel "ONE"|"QUORUM"|"ALL"
- returnReferences SearchReferenceSelector[]
- tenant string
- anydata...
- distance? decimal? - Maximum vector distance of a match. Mutually exclusive with
certainty
- query string[] - The concept(s) to search for, as an array of strings. Multiple entries perform a multi-concept search. A single concept is a one-element array, e.g.
["space opera"]
- targetVector? string - The named vector to search. Required when the collection has more than one named vector
- certainty? decimal? - Minimum normalized certainty of a match. Only for cosine-distance vector indexes. Mutually exclusive with
distance
weaviate: SearchReferenceSelector
Selects one cross-reference to return, and what to return from each referenced object
Fields
- returnMetadata? ("id"|"creationTime"|"lastUpdateTime")[] - The metadata to return under each referenced object's
metadatakey. Omitted or empty returns nometadatablock
- returnProperties? string[] - The non-reference properties to return from each referenced object. Omitted returns all non-reference, non-blob properties of the referenced collection; an empty array returns no properties
- targetCollection? string - The referenced collection to select. Required when
linkOnis a multi-target reference
- returnReferences? SearchReferenceSelector[] - The cross-references to return from each referenced object. Nesting deeper than
QUERY_CROSS_REFERENCE_DEPTH_LIMITis rejected
- linkOn string - The reference property to follow
weaviate: SearchRerank
Reserved for reranking. Returns 422 (not yet supported)
Fields
- query? string - The query to rerank with. Defaults to the search query
- property string - The property to rerank on
weaviate: SearchResponse
The result of a REST search: the matched objects as {id, properties, references, metadata} envelopes, plus the server-side processing time. Shared by all REST search endpoints
Fields
- results SearchResultObject[] - The matched objects, ordered by relevance
- tookMs int - Server-side processing time in milliseconds
weaviate: SearchResultMetadata
The retrieval metadata of a single search hit, populated according to returnMetadata. Every field is optional and only present when it was requested and is computable for the search
Fields
- score? float? - The relevance score of the hit
- distance? float? - The vector distance between the hit and the query
- creationTime? int? - The object's creation time, as epoch milliseconds
- certainty? decimal? - The normalized certainty of the hit. Only computable on cosine-distance vector indexes
- explainScore? string? - An explanation of how the score was computed
- lastUpdateTime? int? - The object's last-update time, as epoch milliseconds
weaviate: SearchResultObject
A single search hit: the object's id (always returned), the selected non-reference properties under properties, the selected cross-references under references, and the requested retrieval metadata under metadata
Fields
- metadata? SearchResultMetadata - The retrieval metadata of a single search hit, populated according to
returnMetadata. Every field is optional and only present when it was requested and is computable for the search
- references? record { SearchResultReference[]... } - The selected cross-references: reference property name to the array of referenced objects. Omitted when the request selects no references, or when the hit has no entry for any of the selected references
- id string - The object's UUID. Always returned
- properties record { JsonObject... } - The selected non-reference properties of the object; nested (object / object[]) properties are pruned to the selected nested fields. Always present —
{}when the request selects no properties
weaviate: SearchResultReference
One referenced object: the selected non-reference properties under properties, deeper cross-references under references, and the requested metadata under metadata
Fields
- metadata? SearchResultReferenceMetadata - The metadata of a referenced object, populated according to the selector's
returnMetadata. Every field is optional and only present when it was requested
- references? record { SearchResultReference[]... } - The cross-references selected one hop deeper. Omitted when the selector selects none, or when the referenced object has no entry for any of them
- collection? string - The collection the referenced object belongs to. Returned for multi-target references
- properties record { JsonObject... } - The selected non-reference properties of the referenced object; nested (object / object[]) properties are pruned to the selected nested fields. Always present —
{}when the selector selects no properties
weaviate: SearchResultReferenceMetadata
The metadata of a referenced object, populated according to the selector's returnMetadata. Every field is optional and only present when it was requested
Fields
- creationTime? int? - The referenced object's creation time, as epoch milliseconds
- id? string? - The referenced object's UUID
- lastUpdateTime? int? - The referenced object's last-update time, as epoch milliseconds
weaviate: ShardProgress
Progress information for exporting a single shard
Fields
- objectsExported? int - Number of objects exported from this shard
- skipReason? string - Reason why this shard was skipped (e.g. tenant status)
- 'error? string - Error message if this shard's export failed
- status? "TRANSFERRING"|"SUCCESS"|"FAILED"|"SKIPPED" - Status of this shard's export
weaviate: ShardStatus
The status of a single shard
Fields
- status? string - Status of the shard
weaviate: ShardStatusGetResponse
Response body of shard status get request
Fields
- vectorQueueSize? int - Size of the vector queue of the shard
- name? string - Name of the shard
- status? string - Status of the shard
weaviate: SingleRef
Either set beacon (direct reference) or set collection (class) and schema (concept reference)
Fields
- schema? PropertySchema - Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection
- beacon? string - If using a direct reference, specify the URI to point to the cross-reference here. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-reference to an object
- href? string - If using a direct reference, this read-only fields provides a link to the referenced resource. If 'origin' is globally configured, an absolute URI is shown - a relative URI otherwise
- classification? ReferenceMetaClassification - This meta field contains additional info about the classified reference property
- 'class? string - If using a concept reference (rather than a direct reference), specify the desired collection (class) name here
weaviate: Statistics
The definition of node statistics
Fields
- leaderAddress? record {} -
- isVoter? boolean -
- raft? RaftStatistics - The definition of Raft statistics
- lastAppliedIndex? decimal -
- leaderId? record {} -
- dbLoaded? boolean -
- candidates? record {} -
- bootstrapped? boolean -
- initialLastAppliedIndex? decimal -
- ready? boolean -
- name? string - The name of the node
- open? boolean -
- status "HEALTHY"|"UNHEALTHY"|"UNAVAILABLE"|"TIMEOUT" (default "HEALTHY") - Node's status
weaviate: StopwordConfig
Fine-grained control over stopword list usage
Fields
- additions? string[] - Stopwords to be considered additionally (default: []). Can be any array of custom strings
- removals? string[] - Stopwords to be removed from consideration (default: []). Can be any array of custom strings
- preset? string - Pre-existing list of common words by language (default:
en). Options: [en,none]
weaviate: Tenant
Attributes representing a single tenant within Weaviate
Fields
- name? string - The name of the tenant (required)
- activityStatus? "ACTIVE"|"INACTIVE"|"OFFLOADED"|"OFFLOADING"|"ONLOADING"|"HOT"|"COLD"|"FROZEN"|"FREEZING"|"UNFREEZING" - The activity status of the tenant, which determines if it is queryable and where its data is stored.
<b>Available Statuses:</b>
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.
- <b>On Create:</b> This field is optional and defaults to
ACTIVE. Allowed values areACTIVEandINACTIVE. - <b>On Update:</b> This field is required. Allowed values are
ACTIVE,INACTIVE, andOFFLOADED.
OFFLOADINGONLOADING
HOT(nowACTIVE),COLD(nowINACTIVE),FROZEN(nowOFFLOADED),FREEZING(nowOFFLOADING),UNFREEZING(nowONLOADING)
weaviate: TextAnalyzerConfig
Text analysis options for a property. These settings are immutable after the property is created. Applies only to text and text[] data types that use an inverted index (searchable or filterable)
Fields
- asciiFold? boolean - If true, accent/diacritic marks are folded to their base characters during indexing and search. For example, 'école' matches 'ecole'. Defaults to false
- asciiFoldIgnore? string[] - 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 is immutable after the property is created
- stopwordPreset? string - 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
weaviate: TokenizeRequest
Request body for the generic tokenize endpoint
Fields
- stopwordPresets? record { string[]... } - Optional user-defined named stopword presets. Shape matches InvertedIndexConfig.stopwordPresets on a collection: each key is a preset name, each value is a plain list of stopwords. A preset name that matches a built-in ('en', 'none') fully replaces the built-in. Preset names must not be empty or whitespace-only; each word list must contain at least one word; individual words must not be empty or whitespace-only. Mutually exclusive with stopwords — pass one or the other, not both
- text string - The text to tokenize
- tokenization "word"|"lowercase"|"whitespace"|"field"|"trigram"|"gse"|"kagome_kr"|"kagome_ja"|"gse_ch" - The tokenization method to apply
- analyzerConfig? TextAnalyzerConfig - Text analysis options for a property. These settings are immutable after the property is created. Applies only to text and text[] data types that use an inverted index (searchable or filterable)
- stopwords? StopwordConfig - Fine-grained control over stopword list usage
weaviate: TokenizeResponse
Response from the tokenize endpoints. Returns indexed text and text used at query time
Fields
- indexed? string[] - The tokens as they would be stored in the inverted index
- query? string[] - The tokens as they would be used for query matching (e.g., after stopword removal)
weaviate: TokenizerUserDictConfig
A list of pairs of strings that should be replaced with another string during tokenization
Fields
- replacements? TokenizerUserDictConfigReplacements[] -
- tokenizer? string - The tokenizer to which the user dictionary should be applied. Currently, only the
kagameja and kr tokenizers supports user dictionaries
weaviate: TokenizerUserDictConfigReplacements
Fields
- 'source string - The string to be replaced
- target string - The string to replace with
weaviate: UpdateAliasRequest
Fields
- 'class? string - The new collection (class) that the alias should point to
weaviate: UpdateCollectionObjectQueries
Represents the Queries record for the operation: updateCollectionObject
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
weaviate: UpdateObjectQueries
Represents the Queries record for the operation: updateObject
Fields
- consistencyLevel? string - Determines how many replicas must acknowledge a request before it is considered successful
weaviate: UpsertPropertyIndexQueries
Represents the Queries record for the operation: upsertPropertyIndex
Fields
- tenants? string[] - Tenant names to target. Never valid on PUT: every migration this endpoint can submit is semantic, and semantic migrations are always cluster-wide, so passing tenants is rejected with a
400. Tenant scoping remains available on the/rebuildvariant
weaviate: UserApiKey
Fields
- apikey string - The API key associated with the user
weaviate: UserExportResponse
The full set of database-user credential records on the source, one per user
Fields
- users DBUserCredential[] -
weaviate: UserImportRequest
A batch of database-user credentials to recreate on the target, bound to a single target namespace
Fields
- namespace? string - The target namespace every user in this request is created under. Required on namespace-enabled clusters
- users DBUserCredential[] - The credential records to import. Only records with a strong (argon2id) secureHash are importable
weaviate: UserImportResponse
The per-user outcome of an import batch
Fields
- results UserImportResult[] -
weaviate: UserImportResult
The outcome of importing a single database-user credential
Fields
- 'error? string - The reason, present only when status is 'error'
- userId string - The name (ID) of the user, without any namespace prefix
- status "created"|"reconciled"|"skipped_exists"|"error" - The outcome for this user
weaviate: UserOwnInfo
Fields
- roles? Role[] -
- groups? string[] - The groups associated with the user
- username string - The name (ID) of the user
weaviate: Vector
A vector representation of the object. If provided at object creation, this wil take precedence over any vectorizer setting
weaviate: VectorConfig
Fields
- vectorizer? record {} - Configuration of a specific vectorizer used by this vector
- vectorIndexConfig? record {} - Vector-index config, that is specific to the type of index selected in vectorIndexType
- vectorIndexType? string - Name of the vector index to use, eg. (HNSW)
weaviate: Vectors
A map of named vectors for multi-vector representations
Fields
- Vector... - Rest field
weaviate: VectorWeights
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
weaviate: WeaviateObject
Fields
- vectors? Vectors - A map of named vectors for multi-vector representations
- additional? AdditionalProperties - (Response only) Additional meta information about a single object
- lastUpdateTimeUnix? int - (Response only) Timestamp of the last object update in milliseconds since epoch UTC
- vector? C11yVector - A vector representation of the object in the Contextionary. If provided at object creation, this wil take precedence over any vectorizer setting
- id? string - The UUID of the object
- creationTimeUnix? int - (Response only) Timestamp of creation of this object in milliseconds since epoch UTC
- 'class? string - Name of the collection (class) the object belongs to
- vectorWeights? VectorWeights - Allow custom overrides of vector weights as math expressions. E.g.
pancake:7will set the weight for the word pancake to 7 in the vectorization, whereasw * 3would 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
- properties? PropertySchema - Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection
- tenant? string - The name of the tenant the object belongs to
weaviate: WhereFilter
Filter search results using a where filter
Fields
- operands? WhereFilter[] - Combine multiple where filters, requires 'And' or 'Or' operator
- valueBoolean? boolean? - value as boolean
- valueText? string? - value as text
- valueNumber? decimal? - value as number/float
- valueIntArray? int[]? - value as integer
- valueDate? string? - value as date (as string)
- valueInt? int? - value as integer
- valueBooleanArray? boolean[]? - value as boolean
- operator? "And"|"Or"|"Equal"|"Like"|"NotEqual"|"GreaterThan"|"GreaterThanEqual"|"LessThan"|"LessThanEqual"|"WithinGeoRange"|"IsNull"|"ContainsAny"|"ContainsAll"|"ContainsNone"|"Not" - Operator to use
- path? string[] - Path to the property currently being filtered
- valueStringArray? string[]? - value as text (deprecated as of v1.19; alias for valueText)
- valueString? string? - value as text (deprecated as of v1.19; alias for valueText)
- valueGeoRange? WhereFilterGeoRange - Filter within a distance of a georange
- valueNumberArray? decimal[]? - value as number/float
- valueDateArray? string[]? - value as date (as string)
- valueTextArray? string[]? - value as text
weaviate: WhereFilterGeoRange
Filter within a distance of a georange
Fields
- distance? WhereFilterGeoRangeDistance -
- geoCoordinates? GeoCoordinates -
weaviate: WhereFilterGeoRangeDistance
Fields
- max? decimal -
Union types
weaviate: UserTypeOutput
UserTypeOutput
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
weaviate: UserTypeInput
UserTypeInput
The type of the user. db users are managed by Weaviate, oidc users are managed by an external OIDC provider
Array types
weaviate: GraphQLQueries
GraphQLQueries
A list of GraphQL queries
weaviate: RolesListResponse
RolesListResponse
List of roles
weaviate: MultipleRef
MultipleRef
Multiple instances of references to other objects
weaviate: GraphQLResponses
GraphQLResponses
A list of GraphQL responses
weaviate: NamespaceListResponse
NamespaceListResponse
Response object containing a list of namespaces
weaviate: C11yVector
C11yVector
A vector representation of the object in the Contextionary. If provided at object creation, this wil take precedence over any vectorizer setting
weaviate: BackupListResponse
BackupListResponse
The definition of a backup create response body
weaviate: ShardStatusList
ShardStatusList
The status of all the shards of a Class
Import
import ballerinax/weaviate;Metadata
Released date: about 19 hours ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 17543
Current verison: 1
Weekly downloads
Keywords
Vendor/Weaviate
Area/AI & Machine Learning
Type/Connector
Contributors