mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-10-06 06:16:21 +00:00
2.6 KiB
2.6 KiB
| title | description | slug |
|---|---|---|
| Bot Schema | OpenMetadata Bot Schema and API Documentation | Bot schema defining automation agents, workflows, and scheduled tasks executed by non-human actors. | /main-concepts/metadata-standard/schemas/entity/bot |
Bot
This schema defines a Bot entity. A bot automates tasks, such as adding description, identifying the importance of data. It performs this task as a special user in the system.
Properties
id: Unique identifier of a bot instance. Refer to ../type/basic.json#/definitions/uuid.name: Name of the bot. Refer to ../type/basic.json#/definitions/entityName.fullyQualifiedName: FullyQualifiedName same asname. Refer to ../type/basic.json#/definitions/fullyQualifiedEntityName.displayName(string): Name used for display purposes. Example 'FirstName LastName'.description: Description of the bot. Refer to ../type/basic.json#/definitions/markdown.botUser: Bot user created for this bot on behalf of which the bot performs all the operations, such as updating description, responding on the conversation threads, etc. Refer to ../type/entityReference.json.provider: Refer to ../type/basic.json#/definitions/providerType.version: Metadata version of the entity. Refer to ../type/entityHistory.json#/definitions/entityVersion.updatedAt: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to ../type/basic.json#/definitions/timestamp.updatedBy(string): User who made the update.href: Link to the resource corresponding to this bot. Refer to ../type/basic.json#/definitions/href.changeDescription: Change that lead to this version of the entity. Refer to ../type/entityHistory.json#/definitions/changeDescription.deleted(boolean): Whentrueindicates the entity has been soft deleted. Default:false.domain: Domain the asset belongs to. When not set, the asset inherits the domain from the parent it belongs to. Refer to ../type/entityReference.json.
Documentation file automatically generated at 2025-01-15 09:05:41.923720+00:00.