weaviate-client

/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { '/': { /** Get links to other endpoints to help discover the REST API. */ get: operations['weaviate.root']; }; '/.well-known/live': { /** Indicates if the Weaviate instance is running and responsive to basic HTTP requests. Primarily used for health checks, such as Kubernetes liveness probes. */ get: operations['weaviate.wellknown.liveness']; }; '/.well-known/ready': { /** Indicates if the Weaviate instance has completed its startup routines and is prepared to accept user traffic (data import, queries, etc.). Used for readiness checks, such as Kubernetes readiness probes. */ get: operations['weaviate.wellknown.readiness']; }; '/.well-known/openid-configuration': { /** Provides OpenID Connect (OIDC) discovery information if OIDC authentication is configured for Weaviate. Returns details like the token issuer URL, client ID, and required scopes. */ get: { responses: { /** OIDC configuration details returned successfully. */ 200: { schema: { /** @description The OIDC issuer URL to redirect to for authentication. */ href?: string; /** @description The OAuth Client ID configured for Weaviate. */ clientId?: string; /** @description The required OAuth scopes for authentication. */ scopes?: string[]; }; }; /** OIDC provider is not configured for this Weaviate instance. */ 404: unknown; /** An internal server error occurred while retrieving OIDC configuration. Check the ErrorResponse for details. */ 500: { schema: definitions['ErrorResponse']; }; }; }; }; '/replication/replicate': { /** Begins an asynchronous operation to move or copy a specific shard replica from its current node to a designated target node. The operation involves copying data, synchronizing, and potentially decommissioning the source replica. */ post: operations['replicate']; /** Schedules all replication operations for deletion across all collections, shards, and nodes. */ delete: operations['deleteAllReplications']; }; '/replication/replicate/force-delete': { /** USE AT OWN RISK! Synchronously force delete operations from the FSM. This will not perform any checks on which state the operation is in so may lead to data corruption or loss. It is recommended to first scale the number of replication engine workers to 0 before calling this endpoint to ensure no operations are in-flight. */ post: operations['forceDeleteReplications']; }; '/replication/replicate/{id}': { /** Fetches the current status and detailed information for a specific replication operation, identified by its unique ID. Optionally includes historical data of the operation's progress if requested. */ get: operations['replicationDetails']; /** Removes a specific replication operation. If the operation is currently active, it will be cancelled and its resources cleaned up before the operation is deleted. */ delete: operations['deleteReplication']; }; '/replication/replicate/list': { /** Retrieves a list of currently registered replication operations, optionally filtered by collection, shard, or node ID. */ get: operations['listReplication']; }; '/replication/replicate/{id}/cancel': { /** Requests the cancellation of an active replication operation identified by its ID. The operation will be stopped, but its record will remain in the `CANCELLED` state (can't be resumed) and will not be automatically deleted. */ post: operations['cancelReplication']; }; '/replication/sharding-state': { /** Fetches the current sharding state, including replica locations and statuses, for all collections or a specified collection. If a shard name is provided along with a collection, the state for that specific shard is returned. */ get: operations['getCollectionShardingState']; }; '/replication/scale': { /** Computes and returns a replication scale plan for a given collection and desired replication factor. The plan includes, for each shard, a list of nodes to be added and a list of nodes to be removed. */ get: operations['getReplicationScalePlan']; /** Apply a replication scaling plan that specifies nodes to add or remove per shard for a given collection. */ post: operations['applyReplicationScalePlan']; }; '/users/own-info': { /** Get information about the currently authenticated user, including username and assigned roles. */ get: operations['getOwnInfo']; }; '/users/db': { /** Retrieves a list of all database (`db` user type) users with their roles and status information. */ get: operations['listAllUsers']; }; '/users/db/{user_id}': { /** Retrieve detailed information about a specific database user (`db` user type), including their roles, status, and type. */ get: operations['getUserInfo']; /** Create a new database (`db` user type) user with the specified name. Returns an API key for the newly created user. */ post: operations['createUser']; /** Delete a database user. You can't delete your current user. */ delete: operations['deleteUser']; }; '/users/db/{user_id}/rotate-key': { /** Revoke the current API key for the specified database user (`db` user type) and generate a new one. */ post: operations['rotateUserApiKey']; }; '/users/db/{user_id}/activate': { /** Activate a deactivated database user (`db` user type). */ post: operations['activateUser']; }; '/users/db/{user_id}/deactivate': { /** Deactivate a database user (`db` user type). */ post: operations['deactivateUser']; }; '/authz/roles': { /** Get all roles and their assigned permissions. */ get: operations['getRoles']; /** Create a new role with the specified permissions. */ post: operations['createRole']; }; '/authz/roles/{id}/add-permissions': { /** Add new permissions to an existing role without affecting current permissions. */ post: operations['addPermissions']; }; '/authz/roles/{id}/remove-permissions': { /** Permissions can be revoked from a specified role. Removing all permissions from a role will delete the role itself. */ post: operations['removePermissions']; }; '/authz/roles/{id}': { /** Fetch a role by its name. */ get: operations['getRole']; /** Deleting a role will remove it from the system, and revoke the associated permissions from all users who had this role. */ delete: operations['deleteRole']; }; '/authz/roles/{id}/has-permission': { /** Check whether a role has the specified permissions. */ post: operations['hasPermission']; }; '/authz/roles/{id}/users': { /** Get all the users (`db` + `oidc`) who have been assigned a specific role. Deprecated, will be removed when v1.29 is not supported anymore. */ get: operations['getUsersForRoleDeprecated']; }; '/authz/roles/{id}/user-assignments': { /** Fetch a list of users which have the specified role. */ get: operations['getUsersForRole']; }; '/authz/roles/{id}/group-assignments': { /** Retrieves a list of all groups that have been assigned a specific role, identified by its name. */ get: operations['getGroupsForRole']; }; '/authz/users/{id}/roles': { /** Retrieve the roles assigned to a specific user (`db` + `oidc`). Deprecated, will be removed when 1.29 is not supported anymore */ get: operations['getRolesForUserDeprecated']; }; '/authz/users/{id}/roles/{userType}': { /** Get all the roles for a specific user (`db` or `oidc`). */ get: operations['getRolesForUser']; }; '/authz/users/{id}/assign': { /** Assign one or more roles to a user. Users can have multiple roles. */ post: operations['assignRoleToUser']; }; '/authz/users/{id}/revoke': { /** Remove one or more roles from a user. */ post: operations['revokeRoleFromUser']; }; '/authz/groups/{id}/assign': { /** Assign roles to the specified group. */ post: operations['assignRoleToGroup']; }; '/authz/groups/{id}/revoke': { /** Revoke roles from the specified group. */ post: operations['revokeRoleFromGroup']; }; '/authz/groups/{id}/roles/{groupType}': { /** Retrieves a list of all roles assigned to a specific group. The group must be identified by both its name (`id`) and its type (`db` or `oidc`). */ get: operations['getRolesForGroup']; }; '/authz/groups/{groupType}': { /** Retrieves a list of all available group names for a specified group type (`oidc` or `db`). */ get: operations['getGroups']; }; '/objects': { /** Retrieves a list of data objects. By default, objects are returned in reverse order of creation. Requires a collection name (`class`) parameter to specify which collection's objects to list, otherwise, returns an empty list. */ get: operations['objects.list']; /** Creates a new data object. The object's metadata and schema values are validated before creation. **Note (batch import)**: If you plan on importing a large number of objects, using the `/batch/objects` endpoint is significantly more efficient than sending multiple single requests. **Note (idempotence)**: This operation (POST) fails if an object with the provided ID already exists. To update an existing object, use the PUT or PATCH methods. */ post: operations['objects.create']; }; '/objects/{id}': { /** Get a specific object based on its UUID. Also available as Websocket bus. **Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */ get: operations['objects.get']; /** Updates an object based on its UUID. Given meta-data and schema values are validated. `lastUpdateTimeUnix` is set to the time this function is called. **Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */ put: operations['objects.update']; /** Deletes an object from the database based on its UUID. **Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */ delete: operations['objects.delete']; /** Checks if an object exists in the system based on its UUID. **Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */ head: operations['objects.head']; /** Update an object based on its UUID (using patch semantics). This method supports json-merge style patch semantics (RFC 7396). Provided meta-data and schema values are validated. `lastUpdateTimeUnix` is set to the time this function is called. **Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead. */ patch: operations['objects.patch']; }; '/objects/{className}/{id}': { /** Get a data object based on its collection name (`className`) and UUID (`id`). */ get: operations['objects.class.get']; /** Replaces properties of an existing data object. The object is identified by its collection name (`className`) and UUID (`id`). The request body must contain the complete object definition with the new property values. */ put: operations['objects.class.put']; /** Removes a data object from a specific collection, identified by its collection name (`className`) and UUID (`id`). **Note on deleting references (legacy format):** For backward compatibility with older beacon formats (lacking a collection name), deleting a reference requires the beacon in the request to exactly match the stored format. Beacons always use `localhost` as the host, indicating the target is within the same Weaviate instance. */ delete: operations['objects.class.delete']; /** Verifies the existence of a specific data object within a collection (class), identified by its collection name (`className`) and UUID (`id`), without returning the object itself. This is faster than a GET request as it avoids retrieving and processing object data. Existence is confirmed by a 204 No Content status code, while non-existence results in a 404 Not Found. */ head: operations['objects.class.head']; /** Updates specific properties of an existing data object using JSON merge patch semantics (RFC 7396). The object is identified by its collection name (`className`) and UUID (`id`). Only the fields provided in the request body are modified. Metadata and schema values are validated, and the object's `lastUpdateTimeUnix` is updated. */ patch: operations['objects.class.patch']; }; '/objects/{id}/references/{propertyName}': { /** Replace all references in cross-reference property of an object. **Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}/references/{propertyName}` endpoint instead. */ put: operations['objects.references.update']; /** Add a reference to a specific property of a data object. **Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}/references/{propertyName}` endpoint instead. */ post: operations['objects.references.create']; /** Delete the single reference that is given in the body from the list of references that this property has. **Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}/references/{propertyName}` endpoint instead. */ delete: operations['objects.references.delete']; }; '/objects/{className}/{id}/references/{propertyName}': { /** Replaces all existing references for a specific reference property (`propertyName`) on a source data object. The source object is identified by its collection name (`className`) and UUID (`id`). The new set of references is provided in the request body. */ put: operations['objects.class.references.put']; /** Adds a new reference to a reference property (`propertyName`) on a source data object. The source object is identified by its collection name (`className`) and UUID (`id`). The reference to add is specified in the request body. */ post: operations['objects.class.references.create']; /** Removes a specific reference from a reference property (`propertyName`) of a source data object. The source object is identified by its collection name (`className`) and UUID (`id`). The reference to remove is specified in the request body. */ delete: operations['objects.class.references.delete']; }; '/objects/validate': { /** Checks if a data object's structure conforms to the specified collection schema and metadata rules without actually storing the object. A successful validation returns a 200 OK status code with no body. If validation fails, an error response with details is returned. */ post: operations['objects.validate']; }; '/batch/objects': { /** Registers multiple data objects in a single request for efficiency. Metadata and schema values for each object are validated. **Note (idempotence)**: This operation is idempotent based on the object UUIDs provided. If an object with a given UUID already exists, it will be overwritten (similar to a PUT operation for that specific object within the batch). */ post: operations['batch.objects.create']; /** Removes multiple data objects based on a filter specified in the request body. Deletion occurs based on the filter criteria provided in the `where` clause. There is a configurable limit (default 10,000, set via `QUERY_MAXIMUM_RESULTS`) on how many objects can be deleted in a single batch request to prevent excessive resource usage. Objects are deleted in the order they match the filter. To delete more objects than the limit allows, repeat the request until no more matching objects are found. */ delete: operations['batch.objects.delete']; }; '/batch/references': { /** Batch create cross-references between collection items in bulk. */ post: operations['batch.references.create']; }; '/graphql': { /** Executes a single GraphQL query provided in the request body. Use this endpoint for all Weaviate data queries and exploration. */ post: operations['graphql.post']; }; '/graphql/batch': { /** Executes multiple GraphQL queries provided in the request body as an array. Allows performing several queries in a single network request for efficiency. */ post: operations['graphql.batch']; }; '/meta': { /** Provides meta-information about the running Weaviate instance, including its version, loaded modules, and network hostname. This information can be useful for monitoring, compatibility checks, or inter-instance communication. */ get: operations['meta.get']; }; '/schema': { /** Retrieves the definitions of all collections (classes) currently in the database schema. */ get: operations['schema.dump']; /** Defines and creates a new collection (class). If [`AutoSchema`](https://docs.weaviate.io/weaviate/config-refs/collections#auto-schema) is enabled (not recommended for production), Weaviate might attempt to infer schema from data during import. Manual definition via this endpoint provides explicit control. */ post: operations['schema.objects.create']; }; '/schema/{className}': { /** Retrieve the definition of a specific collection (`className`), including its properties, configuration, and vectorizer settings. */ get: operations['schema.objects.get']; /** Updates the configuration settings of an existing collection (`className`) based on the provided definition. Note: This operation modifies mutable settings specified in the request body. It does not add properties (use `POST /schema/{className}/properties` for that) or change the collection name. */ put: operations['schema.objects.update']; /** Removes a collection definition from the schema. WARNING: This action permanently deletes all data objects stored within the collection. */ delete: operations['schema.objects.delete']; }; '/schema/{className}/properties': { /** Adds a new property definition to an existing collection (`className`) definition. */ post: operations['schema.objects.properties.add']; }; '/schema/{className}/shards': { /** Retrieves the status of all shards associated with the specified collection (`className`). For multi-tenant collections, use the `tenant` query parameter to retrieve status for a specific tenant's shards. */ get: operations['schema.objects.shards.get']; }; '/schema/{className}/shards/{shardName}': { /** Updates the status of a specific shard within a collection (e.g., sets it to `READY` or `READONLY`). This is typically used after resolving an underlying issue (like disk space) that caused a shard to become non-operational. There is also a convenience function in each client to set the status of all shards of a collection. */ put: operations['schema.objects.shards.update']; }; '/schema/{className}/tenants': { /** Retrieves a list of all tenants currently associated with the specified collection. */ get: operations['tenants.get']; /** Updates the activity status (e.g., `ACTIVE`, `INACTIVE`, etc.) of one or more specified tenants within a collection (`className`). */ put: operations['tenants.update']; /** Creates one or more new tenants for a specified collection (`className`). Multi-tenancy must be enabled for the collection via its definition. */ post: operations['tenants.create']; /** Deletes one or more specified tenants from a collection (`className`). WARNING: This action permanently deletes all data associated with the specified tenants. */ delete: operations['tenants.delete']; }; '/schema/{className}/tenants/{tenantName}': { /** Retrieves details about a specific tenant within the given collection (`className`), such as its current activity status. */ get: operations['tenants.get.one']; /** Checks for the existence of a specific tenant within the given collection (`className`). */ head: operations['tenant.exists']; }; '/aliases': { /** Retrieve a list of all aliases in the system. Results can be filtered by specifying a collection (class) name to get aliases for a specific collection only. */ get: operations['aliases.get']; /** Create a new alias mapping between an alias name and a collection (class). The alias acts as an alternative name for accessing the collection. */ post: operations['aliases.create']; }; '/aliases/{aliasName}': { /** Retrieve details about a specific alias by its name, including which collection (class) it points to. */ get: operations['aliases.get.alias']; /** Update an existing alias to point to a different collection (class). This allows you to redirect an alias from one collection to another without changing the alias name. */ put: operations['aliases.update']; /** Remove an existing alias from the system. This will delete the alias mapping but will not affect the underlying collection (class). */ delete: operations['aliases.delete']; }; '/backups/{backend}': { /** List all created backups IDs, Status */ get: operations['backups.list']; /** Initiates the creation of a backup for specified collections on a designated backend storage. Notes: - Backups are compressed using gzip by default. - Weaviate remains operational during the backup process. */ post: operations['backups.create']; }; '/backups/{backend}/{id}': { /** Checks the status of a specific backup creation process identified by its ID on the specified backend. Client libraries often provide a 'wait for completion' feature that polls this endpoint automatically. Use this endpoint for manual status checks or if 'wait for completion' is disabled. */ get: operations['backups.create.status']; /** Deletes a backup identified by its ID from the specified backend storage. */ delete: operations['backups.cancel']; }; '/backups/{backend}/{id}/restore': { /** Checks the status of a specific backup restoration process identified by the backup ID on the specified backend. Client libraries often provide a 'wait for completion' feature that polls this endpoint automatically. Use this endpoint for manual status checks or if 'wait for completion' is disabled. */ get: operations['backups.restore.status']; /** Initiates the restoration of collections from a specified backup located on a designated backend. Requirements: - Target cluster must have the same number of nodes as the source cluster where the backup was created. - Collections included in the restore must not already exist on the target cluster. - Node names must match between the backup and the target cluster. */ post: operations['backups.restore']; }; '/cluster/statistics': { /** Provides statistics about the internal Raft consensus protocol state for the Weaviate cluster. */ get: operations['cluster.get.statistics']; }; '/nodes': { /** Retrieves status information about all nodes in the cluster. Use the `output` query parameter to control the level of detail. */ get: operations['nodes.get']; }; '/nodes/{className}': { /** Retrieves status information only for the nodes that host shards for the specified collection (`className`). Use the `output` query parameter to control the level of detail. */ get: operations['nodes.get.class']; }; '/tasks': { get: operations['distributedTasks.get']; }; '/classifications/': { /** Initiates a background classification task based on the provided parameters. Use the GET /classifications/{id} endpoint to monitor the status and retrieve results. */ post: operations['classifications.post']; }; '/classifications/{id}': { /** Retrieves the status, metadata, and results (if completed) of a classification task identified by its unique ID. */ get: operations['classifications.get']; }; } export interface definitions { /** * @description The type of the user. `db` users are managed by Weaviate, `oidc` users are managed by an external OIDC provider. * @enum {string} */ UserTypeInput: 'db' | 'oidc'; /** * @description If the group contains OIDC or database users. * @enum {string} */ GroupType: 'oidc'; /** * @description The type of the user. `db_user` users are created through the `users` API, `db_env_user` users are created through environment variables, and `oidc` users are managed by an external OIDC provider. * @enum {string} */ UserTypeOutput: 'db_user' | 'db_env_user' | 'oidc'; UserOwnInfo: { /** @description The groups associated with the user. */ groups?: string[]; roles?: definitions['Role'][]; /** @description The name (ID) of the user. */ username: string; }; DBUserInfo: { /** @description The roles associated with the user. */ roles: string[]; /** @description The name (ID) of the user. */ userId: string; /** * @description Type of the returned user. * @enum {string} */ dbUserType: 'db_user' | 'db_env_user'; /** @description Activity status of the returned user. */ active: boolean; /** * Format: date-time * @description Date and time in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. */ createdAt?: unknown; /** @description First 3 letters of the associated API key. */ apiKeyFirstLetters?: unknown; /** * Format: date-time * @description Date and time in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. */ lastUsedAt?: unknown; }; UserApiKey: { /** @description The API key associated with the user. */ apikey: string; }; Role: { /** @description The name (ID) of the role. */ name: string; permissions: definitions['Permission'][]; }; /** @description Permissions attached to a role. */ Permission: { /** @description Resources applicable for backup actions. */ backups?: { /** * @description A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections. * @default * */ collection?: string; }; /** @description Resources applicable for data actions. */ data?: { /** * @description A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections. * @default * */ collection?: string; /** * @description A string that specifies which tenants this permission applies to. Can be an exact tenant name or a regex pattern. The default value `*` applies the permission to all tenants. * @default * */ tenant?: string; /** * @description A string that specifies which objects this permission applies to. Can be an exact object ID or a regex pattern. The default value `*` applies the permission to all objects. * @default * */ object?: string; }; /** @description Resources applicable for cluster actions. */ nodes?: { /** * @description Whether to allow (verbose) returning shards and stats data in the response. * @default minimal * @enum {string} */ verbosity?: 'verbose' | 'minimal'; /** * @description A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections. * @default * */ collection?: string; }; /** @description Resources applicable for user actions. */ users?: { /** * @description A string that specifies which users this permission applies to. Can be an exact user name or a regex pattern. The default value `*` applies the permission to all users. * @default * */ users?: string; }; /** @description Resources applicable for group actions. */ groups?: { /** * @description A string that specifies which groups this permission applies to. Can be an exact group name or a regex pattern. The default value `*` applies the permission to all groups. * @default * */ group?: string; groupType?: definitions['GroupType']; }; /** @description Resources applicable for tenant actions. */ tenants?: { /** * @description A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections. * @default * */ collection?: string; /** * @description A string that specifies which tenants this permission applies to. Can be an exact tenant name or a regex pattern. The default value `*` applies the permission to all tenants. * @default * */ tenant?: string; }; /** @description Resources applicable for role actions. */ roles?: { /** * @description A string that specifies which roles this permission applies to. Can be an exact role name or a regex pattern. The default value `*` applies the permission to all roles. * @default * */ role?: string; /** * @description Set the scope for the manage role permission. * @default match * @enum {string} */ scope?: 'all' | 'match'; }; /** @description Resources applicable for collection and/or tenant actions. */ collections?: { /** * @description A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections. * @default * */ collection?: string; }; /** @description resources applicable for replicate actions */ replicate?: { /** * @description string or regex. if a specific collection name, if left empty it will be ALL or * * @default * */ collection?: string; /** * @description string or regex. if a specific shard name, if left empty it will be ALL or * * @default * */ shard?: string; }; /** @description Resource definition for alias-related actions and permissions. Used to specify which aliases and collections can be accessed or modified. */ aliases?: { /** * @description A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections. * @default * */ collection?: string; /** * @description A string that specifies which aliases this permission applies to. Can be an exact alias name or a regex pattern. The default value `*` applies the permission to all aliases. * @default * */ alias?: string; }; /** * @description Allowed actions in weaviate. * @enum {string} */ action: 'manage_backups' | 'read_cluster' | 'create_data' | 'read_data' | 'update_data' | 'delete_data' | 'read_nodes' | 'create_roles' | 'read_roles' | 'update_roles' | 'delete_roles' | 'create_collections' | 'read_collections' | 'update_collections' | 'delete_collections' | 'assign_and_revoke_users' | 'create_users' | 'read_users' | 'update_users' | 'delete_users' | 'create_tenants' | 'read_tenants' | 'update_tenants' | 'delete_tenants' | 'create_replicate' | 'read_replicate' | 'update_replicate' | 'delete_replicate' | 'create_aliases' | 'read_aliases' | 'update_aliases' | 'delete_aliases' | 'assign_and_revoke_groups' | 'read_groups'; }; /** @description List of roles. */ RolesListResponse: definitions['Role'][]; Link: { /** @description Target of the link. */ href?: string; /** @description Relationship if both resources are related, e.g. 'next', 'previous', 'parent', etc. */ rel?: string; /** @description Human readable name of the resource group. */ name?: string; /** @description Weaviate documentation about this resource group. */ documentationHref?: string; }; Principal: { /** @description The username that was extracted either from the authentication information */ username?: string; groups?: string[]; userType?: definitions['UserTypeInput']; }; /** @description An array of available words and contexts. */ C11yWordsResponse: { /** @description Weighted results for all words */ concatenatedWord?: { concatenatedWord?: string; singleWords?: unknown[]; concatenatedVector?: definitions['C11yVector']; concatenatedNearestNeighbors?: definitions['C11yNearestNeighbors']; }; /** @description Weighted results for per individual word */ individualWords?: { word?: string; present?: boolean; info?: { vector?: definitions['C11yVector']; nearestNeighbors?: definitions['C11yNearestNeighbors']; }; }[]; }; /** @description A resource describing an extension to the contextinoary, containing both the identifier and the definition of the extension */ C11yExtension: { /** * @description The new concept you want to extend. Must be an all-lowercase single word, or a space delimited compound word. Examples: 'foobarium', 'my custom concept' * @example foobarium */ concept?: string; /** @description A list of space-delimited words or a sentence describing what the custom concept is about. Avoid using the custom concept itself. An Example definition for the custom concept 'foobarium': would be 'a naturally occurring element which can only be seen by programmers' */ definition?: string; /** * Format: float * @description Weight of the definition of the new concept where 1='override existing definition entirely' and 0='ignore custom definition'. Note that if the custom concept is not present in the contextionary yet, the weight cannot be less than 1. */ weight?: number; }; /** @description C11y function to show the nearest neighbors to a word. */ C11yNearestNeighbors: { word?: string; /** Format: float */ distance?: number; }[]; /** @description A vector representation of the object in the Contextionary. If provided at object creation, this wil take precedence over any vectorizer setting. */ C11yVector: number[]; /** @description A vector representation of the object. If provided at object creation, this wil take precedence over any vectorizer setting. */ Vector: { [key: string]: unknown; }; /** @description A map of named vectors for multi-vector representations. */ Vectors: { [key: string]: definitions['Vector']; }; /** @description Receive question based on array of collection names (classes), properties and values. */ C11yVectorBasedQuestion: { /** @description Vectorized collection (class) name. */ classVectors?: number[]; /** @description Vectorized properties. */ classProps?: { propsVectors?: number[]; /** @description String with valuename. */ value?: string; }[]; }[]; Deprecation: { /** @description The id that uniquely identifies this particular deprecation (mostly used internally). */ id?: string; /** @description Whether the problematic API functionality is deprecated (planned to be removed) or already removed. */ status?: string; /** @description Describes which API is affected, usually one of: REST, GraphQL and gRPC. */ apiType?: string; /** @description What this deprecation is about. */ msg?: string; /** @description User-required object to not be affected by the (planned) removal. */ mitigation?: string; /** @description The deprecation was introduced in this version. */ sinceVersion?: string; /** @description A best-effort guess of which upcoming version will remove the feature entirely. */ plannedRemovalVersion?: string; /** @description If the feature has already been removed, it was removed in this version. */ removedIn?: string; /** * Format: date-time * @description If the feature has already been removed, it was removed at this timestamp. */ removedTime?: string; /** * Format: date-time * @description The deprecation was introduced at this timestamp. */ sinceTime?: string; /** @description The locations within the specified API affected by this deprecation. */ locations?: string[]; }; /** @description An error response returned by Weaviate endpoints. */ ErrorResponse: { error?: { message?: string; }[]; }; /** @description An error response caused by a GraphQL query. */ GraphQLError: { locations?: { /** Format: int64 */ column?: number; /** Format: int64 */ line?: number; }[]; message?: string; path?: string[]; }; /** @description GraphQL query based on: http://facebook.github.io/graphql/. */ GraphQLQuery: { /** @description The name of the operation if multiple exist in the query. */ operationName?: string; /** @description Query based on GraphQL syntax. */ query?: string; /** @description Additional variables for the query. */ variables?: { [key: string]: unknown; }; }; /** @description A list of GraphQL queries. */ GraphQLQueries: definitions['GraphQLQuery'][]; /** @description GraphQL based response: http://facebook.github.io/graphql/. */ GraphQLResponse: { /** @description GraphQL data object. */ data?: { [key: string]: definitions['JsonObject']; }; /** @description Array with errors. */ errors?: definitions['GraphQLError'][]; }; /** @description A list of GraphQL responses. */ GraphQLResponses: definitions['GraphQLResponse'][]; /** @description Configure the inverted index built into Weaviate. See [Reference: Inverted index](https://docs.weaviate.io/weaviate/config-refs/indexing/inverted-index#inverted-index-parameters) for details. */ InvertedIndexConfig: { /** * Format: int * @description Asynchronous index clean up happens every n seconds (default: 60). */ cleanupIntervalSeconds?: number; bm25?: definitions['BM25Config']; stopwords?: definitions['StopwordConfig']; /** @description Index each object by its internal timestamps (default: `false`). */ indexTimestamps?: boolean; /** @description Index each object with the null state (default: `false`). */ indexNullState?: boolean; /** @description Index length of properties (default: `false`). */ indexPropertyLength?: boolean; /** @description Using BlockMax WAND for query execution (default: `false`, will be `true` for new collections created after 1.30). */ usingBlockMaxWAND?: boolean; /** @description User-defined dictionary for tokenization. */ tokenizerUserDict?: definitions['TokenizerUserDictConfig'][]; }; /** @description Configure how replication is executed in a cluster */ ReplicationConfig: { /** @description Number of times a collection (class) is replicated (default: 1). */ factor?: number; /** @description Enable asynchronous replication (default: `false`). */ asyncEnabled?: boolean; /** * @description Conflict resolution strategy for deleted objects. * @enum {string} */ deletionStrategy?: 'NoAutomatedResolution' | 'DeleteOnConflict' | 'TimeBasedResolution'; }; /** @description Tuning parameters for the BM25 algorithm. */ BM25Config: { /** * Format: float * @description Calibrates term-weight scaling based on the term frequency within a document (default: 1.2). */ k1?: number; /** * Format: float * @description Calibrates term-weight scaling based on the document length (default: 0.75). */ b?: number; }; /** @description Fine-grained control over stopword list usage. */ StopwordConfig: { /** @description Pre-existing list of common words by language (default: `en`). Options: [`en`, `none`]. */ preset?: string; /** @description Stopwords to be considered additionally (default: []). Can be any array of custom strings. */ additions?: string[]; /** @description Stopwords to be removed from consideration (default: []). Can be any array of custom strings. */ removals?: string[]; }; /** @description A list of pairs of strings that should be replaced with another string during tokenization. */ TokenizerUserDictConfig: { /** @description The tokenizer to which the user dictionary should be applied. Currently, only the `kagame` ja and kr tokenizers supports user dictionaries. */ tokenizer?: string; replacements?: { /** @description The string to be replaced. */ source: string; /** @description The string to replace with. */ target: string; }[]; }; /** @description Configuration related to multi-tenancy within a collection (class) */ MultiTenancyConfig: { /** @description Whether or not multi-tenancy is enabled for this collection (class) (default: `false`). */ enabled?: boolean; /** @description Nonexistent tenants should (not) be created implicitly (default: `false`). */ autoTenantCreation?: boolean; /** @description Existing tenants should (not) be turned HOT implicitly when they are accessed and in another activity status (default: `false`). */ autoTenantActivation?: boolean; }; /** @description JSON object value. */ JsonObject: { [key: string]: unknown; }; /** @description Contains meta information of the current Weaviate instance. */ Meta: { /** * Format: url * @description The url of the host. */ hostname?: string; /** @description The Weaviate server version. */ version?: string; /** @description Module-specific meta information. */ modules?: { [key: string]: unknown; }; /** @description Max message size for GRPC connection in bytes. */ grpcMaxMessageSize?: number; }; /** @description Multiple instances of references to other objects. */ MultipleRef: definitions['SingleRef'][]; /** @description Either a JSONPatch document as defined by RFC 6902 (from, op, path, value), or a merge document (RFC 7396). */ PatchDocumentObject: { /** @description A string containing a JSON Pointer value. */ from?: string; /** * @description The operation to be performed. * @enum {string} */ op: 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test'; /** @description A JSON-Pointer. */ path: string; /** @description The value to be used within the operations. */ value?: { [key: string]: unknown; }; merge?: definitions['Object']; }; /** @description Either a JSONPatch document as defined by RFC 6902 (from, op, path, value), or a merge document (RFC 7396). */ PatchDocumentAction: { /** @description A string containing a JSON Pointer value. */ from?: string; /** * @description The operation to be performed. * @enum {string} */ op: 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test'; /** @description A JSON-Pointer. */ path: string; /** @description The value to be used within the operations. */ value?: { [key: string]: unknown; }; merge?: definitions['Object']; }; /** @description Specifies the parameters required to initiate a shard replica movement operation between two nodes for a given collection and shard. This request defines the source and target node, the collection and type of transfer. */ ReplicationReplicateReplicaRequest: { /** @description The name of the Weaviate node currently hosting the shard replica that needs to be moved or copied. */ sourceNode: string; /** @description The name of the Weaviate node where the new shard replica will be created as part of the movement or copy operation. */ targetNode: string; /** @description The name of the collection to which the target shard belongs. */ collection: string; /** @description The name of the shard whose replica is to be moved or copied. */ shard: string; /** * @description Specifies the type of replication operation to perform. `COPY` creates a new replica on the target node while keeping the source replica. `MOVE` creates a new replica on the target node and then removes the source replica upon successful completion. Defaults to `COPY` if omitted. * @default COPY * @enum {string} */ type?: 'COPY' | 'MOVE'; }; /** @description Contains the unique identifier for a successfully initiated asynchronous replica movement operation. This ID can be used to track the progress of the operation. */ ReplicationReplicateReplicaResponse: { /** * Format: uuid * @description The unique identifier (ID) assigned to the registered replication operation. */ id: string; }; /** @description Provides the detailed sharding state for one or more collections, including the distribution of shards and their replicas across the cluster nodes. */ ReplicationShardingStateResponse: { shardingState?: definitions['ReplicationShardingState']; }; /** @description Defines a complete plan for scaling replication within a collection. Each shard entry specifies nodes to remove and nodes to add. Added nodes may either be initialized empty (null) or created by replicating data from a source node specified as a string. If a source node is also marked for removal in the same shard, it represents a move operation and can only be used once as a source for that shard. If a source node is not marked for removal, it represents a copy operation and can be used as the source for multiple additions in that shard. Nodes listed in 'removeNodes' cannot also appear as targets in 'addNodes' for the same shard, and the same node cannot be specified for both addition and removal in a single shard. */ ReplicationScalePlan: { /** * Format: uuid * @description A unique identifier for this replication scaling plan, useful for tracking and auditi